Querying VPCs of an Endpoint

Function

This API is used to query VPCs of an endpoint.

Calling Method

For details, see Calling APIs.

URI

GET /v2.1/vpcs

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Definition The number of records returned on each page during pagination query. Constraints N/A Range 0 to 500 Default Value 500
offset	No	Integer	Definition The offset of pagination query. It specifies the number of rows or records to skip from the beginning of the result set before retrieving the desired data. Constraints If marker is not left blank, the query starts from the resource specified by marker and the offset does not take effect. Range 0 to 2147483647 Default Value 0
vpc_id	No	String	ID of the VPC to be queried.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition The user token. The token can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token. For details about how to obtain a user token, seeObtaining a User Token. Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
vpcs	Array of VpcsData objects	VPCs of an endpoint
metadata	metadata object	Definition Number of resources that meet the filter condition Range N/A

**Table 4** VpcsData
Parameter	Type	Description
id	String	VPC ID, which is a UUID used to identify the VPC
inbound_endpoint_count	Integer	Number of inbound endpoints in a VPC
outbound_endpoint_count	Integer	Number of inbound endpoints in a VPC

**Table 5** metadata
Parameter	Type	Description
total_count	Integer	Definition Number of resources that meet the filter criteria. The number is irrelevant to limit or offset. Range N/A

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
code	String	Definition Error code Range N/A
message	String	Definition Error description Range N/A

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
code	String	Definition Error code Range N/A
message	String	Definition Error description Range N/A

Example Requests

None

Example Responses

Status code: 200

Successful request

{
  "vpcs" : [ {
    "id" : "02443811-acf1-4c22-8f44-e3adf19f6097",
    "inbound_endpoint_count" : 32
  } ],
  "metadata" : {
    "total_count" : 1
  }
}