ListVpcInfoByInstance - Tablestore - Alibaba Cloud Documentation Center

Retrieves a list of VPC information for an instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ots:ListVpcInfoByInstance

get

*All Resource

*

None

Request syntax

GET /v2/openapi/listvpcinfobyinstance HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
InstanceName	string	Yes	The name of the instance.	mkdd-test
PageNum	integer	No	The page number.	1
PageSize	integer	No	The number of VPCs to return on each page.	8

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	The ID of the request. You can use the ID to locate and troubleshoot issues.	44FDC379-4443-560E-B652-9F7476D8854F
PageNum	integer	The page number.	1
PageSize	integer	The number of entries returned per page.	8
TotalCount	integer	The total number of VPCs.	1
InstanceName	string	The name of the instance.	mkdd-test
VpcInfos	array<object>	The details of the VPCs.
	object	The details of the VPC.
VpcId	string	The ID of the VPC.	vpc-2z***********n7w3dl
Domain	string	The endpoint of the VPC.	http://xu6666-mkdd-test.cn-hangzhou.vpc.ots.aliyuncs.com
InstanceVpcName	string	The name of the VPC.	xu6666
RegionNo	string	The ID of the region.	cn-hangzhou
Endpoint	string	The endpoint of the instance.	http://172..*.34:80/

Examples

Success response

JSON format

{
  "RequestId": "44FDC379-4443-560E-B652-9F7476D8854F",
  "PageNum": 1,
  "PageSize": 8,
  "TotalCount": 1,
  "InstanceName": "mkdd-test",
  "VpcInfos": [
    {
      "VpcId": "vpc-2z***********n7w3dl",
      "Domain": "http://xu6666-mkdd-test.cn-hangzhou.vpc.ots.aliyuncs.com",
      "InstanceVpcName": "xu6666",
      "RegionNo": "cn-hangzhou",
      "Endpoint": "http://172.**.***.34:80/"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.