DescribeInstanceClusterInfo - Query dedicated instance cluster info - API Gateway

Queries dedicated instance cluster information.

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

apigateway:DescribeInstanceClusterInfo

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceClusterName	string	No	The name of the dedicated instance cluster.	testvpc

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	CEF72CEB-54B6-4AE8-B225-F876FF7BZ015
InstanceClusterName	string	The cluster name.	test
InstanceClusterId	string	The cluster ID.	apigateway-ht-04e41d95e9c1
InstanceClusterStatus	string	The cluster status.	RUNNING
InstanceClusterVersion	string	The cluster version.	3.5.3.856
Description	string	The cluster description. Maximum: 200 characters.	v0.0.4
RegionId	string	The region ID of the cluster.	cn-hangzhou
CreatedTime	string	The cluster creation time.	2022-10-10T18:29:27
ModifiedTime	string	The last modification time of the cluster.	2023-06-19 10:40:29 +0800
InstanceClusterAttribute	object	The cluster details.
HttpsPolicies	string	The HTTPS security policy.	HTTPS2_TLS1_0
InternetEgressAddress	string	The outbound public IP address.	39.106.XX.XX
IntranetEgressAddress	string	The outbound private IP address.	100.104.XX.XX/26
VpcIntranetEnable	boolean	Whether VPC domain name is enabled.
IntranetSegments	string	The custom CIDR block. Configured CIDR blocks are treated as private.	123.0.0.1
UserVpcId	string	The ID of the client VPC.	vpc-2zew2v4vcg78mXXXX
UserVswitchId	string	The vSwitch of the client VPC.	vsw-2zecr5r7ao44tslsXXXX
VpcOwnerId	integer	The VPC owner account ID.	165438596694XXXX
IPV4AclId	string	The IPv4 ACL ID.	acl-t4n8i4rvvp70kcyuoXXXX
IPV4AclName	string	The name of the IPv4 ACL.	test-black
IPV4AclStatus	string	Whether IPv4 access control is enabled. Valid values: on off	on
IPV4AclType	string	The type of the IPv4 ACL. black: blacklist white: whitelist	black
EgressIpv6Enable	boolean	Whether outbound IPv6 traffic is supported.	true
SupportIpv6	boolean	Whether IPv6 traffic is supported.	true
IPV6AclName	string	The name of the IPv6 ACL.	test
IPV6AclId	string	The ID of the IPv6 ACL.	acl-t4nevzhwbpe7cup18XXXX
IPV6AclStatus	string	Whether IPv6 access control is enabled. Valid values: on off	on
IPV6AclType	string	The type of the IPv6 ACL. Valid values: black: blacklist white: whitelist	white
VipTypeList	string	The VIPs of the cluster.	VPC_INTERNET_IPV6
VpcSlbIntranetEnable	boolean	Whether self-calling is enabled.	false
ConnectVpcId	string	The user VPC ID connected to the cluster. Applicable to VPC integration instances.	vpc-p0w3kxxxxxxxxxxxxxxxx
ConnectCidrBlocks	string	The internal CIDR block of the user VPC accessible by the cluster. Applicable to VPC integration instances.	["192.168.1.0/24","192.168.0.0/24"]
InstanceList	object
Instance	array<object>	The dedicated instances in the cluster.
	object
InstanceName	string	The instance name.	tf-testacceu-central-1apigatewayinstance8752
InstanceId	string	The instance ID.	apigateway-ht-04e41d95e9c1
Status	string	The instance status.	RUNNING
ErrorMessage	string	The error message returned on failure.	Instance not found.
InstanceClusterType	string	The cluster type.	normal

Examples

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.