Querying VPCs

Function

Queries VPCs.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
workspace:networks:listVpcs	List	-	-	-	vpc:vpcs:list

URI

GET /v2/{project_id}/vpcs

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
vpcs	Array of VpcInfo objects	VPC list.

**Table 3** VpcInfo
Parameter	Type	Description
status	String	VPC status.
id	String	VPC ID.
name	String	VPC name.
created_at	String	Time when the VPC was created.
cidr	String	Range of available subnets in the VPC.
tenant_id	String	Tenant ID.

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 401

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 404

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 405

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 500

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 503

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Example Requests

GET /v2/0e3f393ae380f5d12facc005678bcd4b/vpcs

Example Responses

Status code: 200

Response to the request for querying VPCs.

{
  "vpcs" : [ {
    "status" : "OK",
    "id" : "0822226d-cfc3-4794-957d-e22ccf9d83c6",
    "name" : "testVpc",
    "created_at" : "2020-06-15T03:18:19Z",
    "cidr" : "192.168.0.0/16",
    "tenant_id" : "0701429a2500d2972f1ec00c09d96798"
  }, {
    "status" : "OK",
    "id" : "210a7165-439f-46ea-96a8-3ba3981b6f49",
    "name" : "testVpc",
    "created_at" : "2020-06-15T03:18:19Z",
    "cidr" : "192.168.0.1/16",
    "tenant_id" : "165591746067422e93383dc0c1fe8c66"
  } ]
}

Status Codes

Status Code	Description
200	Response to the request for querying VPCs.
400	The request cannot be understood by the server due to malformed syntax.
401	Authentication failed.
403	No operation permissions.
404	No resources found.
405	The method specified in the request is not allowed.
500	An internal service error occurred. For details about the error code, see the error code description.
503	Service unavailable.