Query List of Service Network Interface Cards
Last Updated：2021-12-16
Description
Query the service NIC list.
Request Structure
GET /v{version}/endpoint?vpcId={vpcId}&name={name}&ipAddress={ipAddress}&status={status}&subnetId={subnetId}&service={service}&marker={marker}&maxKeys={maxKeys} HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization string
Request Header Field
No other special header fields are available except for the public header field.
Request Parameters
| Parameter Name | Type | Required? | Parameter Position | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number |
| vpcId | String | Yes | Query parameter | Identifier of the VPC to which the service NIC belongs |
| name | String | No | Query parameters | Service NIC name |
| ipAddress | String | No | Query parameter | Service NIC ip address |
| status | String | No | Query parameters | Service NIC status, whose value is available/dead, indicating that the NIC is attachable and unattachable. |
| subnetId | String | No | Query parameter | Identifier of the subnet for the service NIC |
| service | String | No | Query parameter | Domain name of the service bound to the service NIC. |
| marker | String | No | Query parameters | The start position of querying the list in batches, which is a string generated by the system. |
| maxKeys | Integer | No | Query parameter | The maximum number of keys contained on each page, which is usually not more than 1,000 and whose default value is 1,000. |
Return Header Field
No other special header fields are available except for the public header field.
Return Parameter
| Parameter Name | Type | Description |
|---|---|---|
| marker | String | Marks the starting position of the query |
| isTruncated | boolean | “True” means there is still data behind, and “false” means the current page is already the last page. |
| nextMarker | String | Gets the “marker” value to be passed on the next page. This field does not appear when “isTruncated” is false. |
| maxKeys | int | Maximum number of keys contained on each page. |
| endpoints | List<Endpoint> | Service NIC list |
Request Example
GET /v{version}/endpoint?marker=endpoint-11b09ce6&maxKeys=1&vpcId=vpc-IyWRtII7 HTTP/1.1
Host: bcc.bj.baidubce.com
ContentType: application/json
Authorization: bce auth v1/f81d3b34e48048fbb2634dc7882d7e21/2017 03 11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
Return Example
HTTP/1.1 200 OK
x-bce-request-id: 1214cca7 4ad5 451d 9215 71cb844c0a50
Date: Thu, 16 Mar 2017 06:29:48 GMT
Content Type: application/json;charset=UTF 8
Server: BWS
{
"nextMarker": "endpoint-11a09ce9",
"marker": "endpoint-11a09ce9",
"maxKeys": 1,
"isTruncated": true,
"result": [
{
"endpointId': "endpoint-11a09ce9",
"name": "name",
"ipAddress": "192.168.0.5",
"status": "available",
"service": "www.test.com",
"subnetId": "sbn-crqu2vxzj049",
"createTime": "2019-03-07T02:35:31Z",
"description": "",
"productType": "postpay",
"vpcId": "vpc-q1hcnhf7nmve"
}
]
}