Queries the details of shared instances or dedicated instances in a region.
Authorization information
The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All resourcesis used in the Resource type column of the operation.
- Condition keyword: refers to the condition keyword defined by the cloud product itself.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operate | access level | Resource type | conditional keyword | Association operation |
|---|---|---|---|---|
| apigateway:DescribeInstances | Read |
|
| without |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| InstanceId | string | No | The ID of the instance. If you do not specify this parameter, all instances are queried. | api-shared-vpc-001 |
| Language | string | No | The language that is used to return the description of the system policy. Valid values:
| zh |
| EnableTagAuthorization | boolean | No | Specifies whether tag authorization is enabled. | false |
| Tag | array | No | The tags that are bound to the instance. | |
| object | No | The tags that are bound to the instance. | ||
| Key | string | No | The key of the tag. | key1 |
| Value | string | No | The values of the tag. | value |
Response parameters
Example
Normal return example
JSONFormat
{
"PageNumber": 1,
"RequestId": "CEB6EC62-B6C7-5082-A45A-45A204724AC2",
"PageSize": 10,
"TotalCount": 1,
"Instances": {
"InstanceAttribute": [
{
"Status": "RUNNING",
"VpcSlbIntranetEnable": true,
"ClassicEgressAddress": "10.0.0.1",
"ZoneLocalName": "Multi-zone 2\n",
"VipTypeList": "",
"UserVpcId": "vpc-t***hx****yu9****t0g4",
"VpcIntranetEnable": true,
"VpcOwnerId": 1408453217640291,
"InstanceId": "api-shared-vpc-020",
"InstanceRpsLimit": 500,
"InstanceType": "VPC_SHARED",
"RegionId": "cn-beijing",
"InstanceSpec": "api.s1.small",
"InstanceChargeType": "PrePaid",
"HttpsPolicies": "HTTPS2_TLS1_2",
"VpcEgressAddress": "100.104.254.0/26",
"EgressIpv6Enable": true,
"ExpiredTime": "1659801600000",
"InstanceName": "test",
"ZoneId": "cn-hangzhou-MAZ5(g,h)",
"SupportIpv6": true,
"InternetEgressAddress": "47.241.89.244",
"CreatedTime": "2021-10-22 15:36:53.0",
"InstanceSpecAttributes": {
"SpecAttribute": [
{
"Value": "2500",
"LocalName": "The maximum RPS.\n"
}
]
},
"UserVswitchId": "vsw-t4***eh****d7q****i2f",
"AclName": "test",
"AclType": "white",
"AclStatus": "on",
"AclId": "acl-uf6f9zfxfxtp5j9ng3yv4",
"IntranetSegments": "",
"IPV6AclName": "",
"IPV6AclId": "",
"IPV6AclType": "",
"IPV6AclStatus": ""
}
]
}
}Error codes
For a list of error codes, visit the API error center.
Change history
| Change time | Summary of changes | Operate |
|---|---|---|
| 2022-06-10 | Add Operation |