All Products
Search
Document Center

API Gateway:DescribeInstances

Last Updated:Oct 19, 2024

Queries the details of instances in a region. The instances include shared instances and dedicated instances.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringNo

The instance ID. If you do not specify this parameter, all instances are returned.

api-shared-vpc-001
LanguagestringNo

The language in which you want the description of the system policy to be returned. Valid values:

  • en: English
  • zh: Chinese
  • ja: Japanese
zh
EnableTagAuthorizationbooleanNo

Specifies whether tag authorization is enabled.

false
Tagarray<object>No

The tag that is bound to the instance.

objectNo
KeystringNo

The tag key.

key1
ValuestringNo

The tag value.

value

Response parameters

ParameterTypeDescriptionExample
object
PageNumberinteger

The page number of the returned page.

1
RequestIdstring

The request ID.

CEB6EC62-B6C7-5082-A45A-45A204724AC2
PageSizeinteger

The number of entries per page.

10
TotalCountinteger

The total number of entries.

1
Instancesarray<object>

The information about the instances.

InstanceAttributeobject
Statusstring

The instance status.

RUNNING
VpcSlbIntranetEnableboolean

Indicates whether virtual private cloud (VPC) Server Load Balancer (SLB) is enabled.

true
ClassicEgressAddressstring

The egress IP address.

10.0.0.1
ZoneLocalNamestring

The zone.

UserVpcIdstring

The user VPC ID.

vpc-t***hx****yu9****t0g4
VpcIntranetEnableboolean

Indicates whether VPC access is enabled.

true
VpcOwnerIdlong

The ID of the account to which the VPC-based instance belongs.

1408453217640291****
InstanceIdstring

The instance ID.

api-shared-vpc-020
InstanceRpsLimitinteger

The requests per second (RPS) limit on the instance.

500
InstanceTypestring

The instance type. Valid values:

  • VPC_SHARED: shared instance (VPC)
  • VPC_DEDICATED: dedicated instance (VPC)
VPC_SHARED
RegionIdstring

The region ID.

cn-beijing
InstanceSpecstring

The instance specification.

api.s1.small
InstanceChargeTypestring

The billing method of the instance. Valid values:

  • PrePaid: subscription
  • PayAsYouGo: pay-as-you-go
PrePaid
HttpsPoliciesstring

The HTTPS security policy.

HTTPS2_TLS1_2
VpcEgressAddressstring

The VPC egress CIDR block.

100.104.254.0/26
EgressIpv6Enableboolean

Indicates whether outbound IPv6 traffic is supported.

true
ExpiredTimestring

The time when the instance expires.

1659801600000
InstanceNamestring

The instance name.

test
ZoneIdstring

The zone ID.

cn-hangzhou-MAZ5(g,h)
SupportIpv6boolean

Indicates whether IPv6 traffic is supported.

true
InternetEgressAddressstring

The outbound public IP address.

47.241.89.244
CreatedTimestring

The time when the instance was created.

2021-10-22 15:36:53.0
InstanceSpecAttributesarray<object>

The instance specification details.

SpecAttributeobject
Valuestring

The variable value.

2500
LocalNamestring

The variable name.

UserVswitchIdstring

The user vSwitch ID.

vsw-t4***eh****d7q****i2f
AclNamestring

The name of the access control list (ACL).

test
AclTypestring

The ACL type. Valid values:

  • black: blacklist
  • white: whitelist
white
AclStatusstring

Indicates whether the ACL is enabled. Valid values:

  • on
  • off
on
AclIdstring

The ACL ID.

acl-uf6f9zfxfxtp5j9ng3yv4
IntranetSegmentsstring

The internal CIDR block that is allowed to access the API Gateway instance.

[\"172.36.0.0/16\",\"172.31.16.0/20\"]
IPV6AclNamestring

The name of the IPv6 ACL.

testIPV6
IPV6AclIdstring

The ID of the IPv6 ACL.

acl-124resFfs235
IPV6AclTypestring

The type of the IPv6 ACL. Valid values:

  • black: blacklist
  • white: whitelist
black
IPV6AclStatusstring

Indicates whether the IPv6 ACL is enabled. Valid values:

  • on
  • off
on
DedicatedInstanceTypestring

The type of the dedicated instance. Valid values:

  • vpc_connect: VPC integration instance
  • normal: conventional dedicated instance
vpc_connect
InstanceCidrBlockstring

The CIDR block of the dedicated instance.

  • 172.16.0.0/12
  • 192.168.0.0/16
192.168.0.0/16
ConnectVpcIdstring

The ID of the user's VPC if the instance is a VPC integration instance.

vpc-m5eo7khlb4h4f8y9egsdg
NetworkInterfaceAttributesarray<object>

The network information of the user's VPC if the instance is a VPC integration instance.

NetworkInterfaceAttributeobject
VswitchIdstring

The vSwitch ID.

vsw-2zeqals6rbj51bhjn8b89
SecurityGroupIdstring

The security group ID. Services in the same security group can access each other.

sg-2zeehz13zcyj1kfk3o85
CidrBlockstring

The CIDR block of the vSwitch.

192.168.17.0/24
ZoneIdstring

The zone ID.

cn-shenzhen-d
InstanceClusterIdstring

The ID of the cluster to which the dedicated instance cluster belongs.

apigateway-cluster-sh-1523cafbgffd
MaintainStartTimestring

The start time of the maintenance window. The time is in the HH:mmZ format. The time is displayed in UTC.

22:00Z
MaintainEndTimestring

The end time of the maintenance window. The time is in the HH:mmZ format. The time is displayed in UTC.

01:00Z
ConnectCidrBlocksstring

The internal CIDR block of the user's VPC that can be accessed if the instance is a VPC integration instance.

[\"172.16.0.0/24\",\"172.16.1.0/24\"]

Examples

Sample success responses

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": "",
        "UserVpcId": "vpc-t***hx****yu9****t0g4",
        "VpcIntranetEnable": true,
        "VpcOwnerId": 0,
        "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": ""
            }
          ]
        },
        "UserVswitchId": "vsw-t4***eh****d7q****i2f",
        "AclName": "test",
        "AclType": "white",
        "AclStatus": "on",
        "AclId": "acl-uf6f9zfxfxtp5j9ng3yv4",
        "IntranetSegments": "[\\\"172.36.0.0/16\\\",\\\"172.31.16.0/20\\\"]",
        "IPV6AclName": "testIPV6",
        "IPV6AclId": "acl-124resFfs235",
        "IPV6AclType": "black",
        "IPV6AclStatus": "on",
        "DedicatedInstanceType": "vpc_connect",
        "InstanceCidrBlock": "192.168.0.0/16",
        "ConnectVpcId": "vpc-m5eo7khlb4h4f8y9egsdg",
        "NetworkInterfaceAttributes": {
          "NetworkInterfaceAttribute": [
            {
              "VswitchId": "vsw-2zeqals6rbj51bhjn8b89",
              "SecurityGroupId": "sg-2zeehz13zcyj1kfk3o85",
              "CidrBlock": "192.168.17.0/24",
              "ZoneId": "cn-shenzhen-d"
            }
          ]
        },
        "InstanceClusterId": "apigateway-cluster-sh-1523cafbgffd",
        "MaintainStartTime": "22:00Z",
        "MaintainEndTime": "01:00Z",
        "ConnectCidrBlocks": "[\\\"172.16.0.0/24\\\",\\\"172.16.1.0/24\\\"]",
        "PrivateDnsList": {
          "PrivateDns": [
            ""
          ]
        },
        "Tags": {
          "TagInfo": [
            {
              "Key": "",
              "Value": ""
            }
          ]
        }
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-04-18The response structure of the API has changedView Change Details
2024-03-21The response structure of the API has changedView Change Details
2023-07-12The response structure of the API has changedView Change Details
2023-07-11The response structure of the API has changedView Change Details
2023-06-12The response structure of the API has changedView Change Details
2023-06-03The response structure of the API has changedView Change Details
2023-05-09The response structure of the API has changedView Change Details
2023-03-07The response structure of the API has changedView Change Details
2022-06-10Add OperationView Change Details