Query service network interface card list
Updated at:2025-10-16
Description
Fetch the list of service network interface cards.
Request structure
Plain Text
1GET /v{version}/endpoint?vpcId={vpcId}&name={name}&ipAddress={ipAddress}&status={status}&subnetId={subnetId}&service={service}&marker={marker}&maxKeys={maxKeys} HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: authorization string
Request headers
There are no special headers required beyond the common headers.
Request parameters
| Parameter name | Types | Whether required | Parameter location | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number |
| vpcId | String | Yes | Query | Identifier of the VPC to which the service network interface card belongs |
| name | String | No | Query | Name of service network interface card |
| ipAddress | String | No | Query | IP address of the service network interface card |
| status | String | No | Query | Service network interface card status, value range: available/dead, indicating mountable/unmountable, respectively |
| subnetId | String | No | Query | Identifier of the subnet to which the service network interface card belongs |
| service | String | No | Query | Domain name of the service bound to the service network interface card |
| marker | String | No | Query | The starting position of the batch list query is a system-generated string |
| maxKeys | Integer | No | Query | Maximum number of items included per page, maximum: 1,000, default: 1,000 |
Response headers
No special headers are required beyond the standard ones.
Response parameters
| Parameter name | Types | Description |
|---|---|---|
| marker | String | Mark the starting position of the query. |
| isTruncated | boolean | true indicates there is more data later, false indicates it is the last page |
| nextMarker | String | The marker value needed to fetch the next page. This field is absent when isTruncated is false. |
| maxKeys | int | Maximum number of items included per page |
| endpoints | List<[Endpoint](VPC/API Reference/Appendix.md#Endpoint)> | List of service network interfaces |
Request example
Plain Text
1GET /v{version}/endpoint?marker=endpoint-11b09ce6&maxKeys=1&vpcId=vpc-IyWRtII7 HTTP/1.1
2Host: bcc.bj.baidubce.com
3ContentType: application/json
4Authorization: bce auth v1/f81d3b34e48048fbb2634dc7882d7e21/2017 03 11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
Response example
Plain Text
1 HTTP/1.1 200 OK
2 x-bce-request-id: 1214cca7 4ad5 451d 9215 71cb844c0a50
3 Date: Thu, 16 Mar 2017 06:29:48 GMT
4 Content Type: application/json;charset=UTF 8
5 Server: BWS
6
7{
8 "nextMarker": "endpoint-11a09ce9",
9 "marker": "endpoint-11a09ce9",
10 "maxKeys": 1,
11 "isTruncated": true,
12 "result": [
13 {
14 "endpointId': "endpoint-11a09ce9",
15 "name": "name",
16 "ipAddress": "192.168.0.5",
17 "status": "available",
18 "service": "www.test.com",
19 "subnetId": "sbn-crqu2vxzj049",
20 "createTime": "2019-03-07T02:35:31Z",
21 "description": "",
22 "productType": "postpay",
23 "vpcId": "vpc-q1hcnhf7nmve"
24 }
25 ]
26}
