All Products
Search
Document Center

API Gateway:DescribeInstanceClusterInfo

Last Updated:Jul 31, 2025

Queries the information about a dedicated instance cluster.

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

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • 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:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • 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.
OperationAccess levelResource typeCondition keyAssociated operation
apigateway:DescribeInstanceClusterInfoget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceClusterNamestringNo

The name of the dedicated instance cluster.

testvpc

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

CEF72CEB-54B6-4AE8-B225-F876FF7BZ015
InstanceClusterNamestring

The cluster name.

test
InstanceClusterIdstring

The cluster ID.

apigateway-ht-04e41d95e9c1
InstanceClusterStatusstring

The cluster status.

RUNNING
InstanceClusterVersionstring

The cluster version.

3.5.3.856
Descriptionstring

The cluster description, which can be up to 200 characters in length.

v0.0.4
RegionIdstring

The region ID of the cluster.

cn-hangzhou
CreatedTimestring

The time when the cluster was created.

2022-10-10T18:29:27
ModifiedTimestring

The time when the cluster was last modified.

2023-06-19 10:40:29 +0800
InstanceClusterAttributeobject

The cluster details.

HttpsPoliciesstring

The HTTPS security policy.

HTTPS2_TLS1_0
InternetEgressAddressstring

The outbound public IP address.

39.106.XX.XX
IntranetEgressAddressstring

The outbound private IP address.

100.104.XX.XX/26
VpcIntranetEnableboolean

Indicates whether a virtual private cloud (VPC) domain name is enabled.

IntranetSegmentsstring

The custom CIDR block. The configured CIDR block is considered as a private block.

123.0.0.1
UserVpcIdstring

The ID of the client VPC.

vpc-2zew2v4vcg78mXXXX
UserVswitchIdstring

The vSwitch of the client VPC.

vsw-2zecr5r7ao44tslsXXXX
VpcOwnerIdlong

The ID of the account to which the VPC belongs.

165438596694XXXX
IPV4AclIdstring

The ID of the IPv4 access control list (ACL).

acl-t4n8i4rvvp70kcyuoXXXX
IPV4AclNamestring

The name of the IPv4 ACL.

test-black
IPV4AclStatusstring

Indicates whether IPv4 access control is enabled. Valid values:

  • on
  • off
on
IPV4AclTypestring

The type of the IPv4 ACL.

  • black: blacklist
  • white: whitelist
black
EgressIpv6Enableboolean

Indicates whether outbound IPv6 traffic is supported.

true
SupportIpv6boolean

Indicates whether IPv6 traffic is supported.

true
IPV6AclNamestring

The name of the IPv6 ACL.

test
IPV6AclIdstring

The ID of the IPv6 ACL.

acl-t4nevzhwbpe7cup18XXXX
IPV6AclStatusstring

Indicates whether IPv6 access control is enabled. Valid values:

  • on
  • off
on
IPV6AclTypestring

The type of the IPv6 ACL. Valid values:

  • black: blacklist
  • white: whitelist
white
VipTypeListstring

The VIPs of the cluster.

VPC_INTERNET_IPV6
VpcSlbIntranetEnableboolean

Indicates whether self-calling is enabled.

false
ConnectVpcIdstring

The ID of the user VPC that is connected to the cluster if the cluster consists of VPC integration instances.

vpc-p0w3kxxxxxxxxxxxxxxxx
ConnectCidrBlocksstring

The internal CIDR block of the user VPC that can be accessed by the cluster if the cluster consists of VPC integration instances.

["192.168.1.0/24","192.168.0.0/24"]
InstanceListarray<object>

The dedicated instances contained in the cluster.

Instanceobject
InstanceNamestring

The instance name.

tf-testacceu-central-1apigatewayinstance8752
InstanceIdstring

The instance ID.

apigateway-ht-04e41d95e9c1
Statusstring

The instance status.

RUNNING
ErrorMessagestring

The error message returned if the call fails.

Instance not found.
InstanceClusterTypestring

The cluster type.

normal

Examples

Sample success responses

JSONformat

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ015",
  "InstanceClusterName": "test",
  "InstanceClusterId": "apigateway-ht-04e41d95e9c1\n",
  "InstanceClusterStatus": "RUNNING",
  "InstanceClusterVersion": "3.5.3.856",
  "Description": "v0.0.4",
  "RegionId": "cn-hangzhou",
  "CreatedTime": "2022-10-10T18:29:27",
  "ModifiedTime": "2023-06-19 10:40:29 +0800",
  "InstanceClusterAttribute": {
    "HttpsPolicies": "HTTPS2_TLS1_0",
    "InternetEgressAddress": "39.106.XX.XX",
    "IntranetEgressAddress": "100.104.XX.XX/26",
    "VpcIntranetEnable": true,
    "IntranetSegments": "123.0.0.1",
    "UserVpcId": "vpc-2zew2v4vcg78mXXXX",
    "UserVswitchId": "vsw-2zecr5r7ao44tslsXXXX",
    "VpcOwnerId": 0,
    "IPV4AclId": "acl-t4n8i4rvvp70kcyuoXXXX",
    "IPV4AclName": "test-black",
    "IPV4AclStatus": "on",
    "IPV4AclType": "black",
    "EgressIpv6Enable": true,
    "SupportIpv6": true,
    "IPV6AclName": "test",
    "IPV6AclId": "acl-t4nevzhwbpe7cup18XXXX",
    "IPV6AclStatus": "on",
    "IPV6AclType": "white",
    "VipTypeList": "VPC_INTERNET_IPV6",
    "VpcSlbIntranetEnable": false,
    "ConnectVpcId": "vpc-p0w3kxxxxxxxxxxxxxxxx",
    "ConnectCidrBlocks": [
      "192.168.1.0/24",
      "192.168.0.0/24"
    ]
  },
  "InstanceList": {
    "Instance": [
      {
        "InstanceName": "tf-testacceu-central-1apigatewayinstance8752",
        "InstanceId": "apigateway-ht-04e41d95e9c1",
        "Status": "RUNNING",
        "ErrorMessage": "Instance not found."
      }
    ]
  },
  "InstanceClusterType": "normal"
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history