ListClusters-阿里云帮助中心

Query the list of instances.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
PageNum	integer	No	The page number.
PageSize	integer	No	The number of entries per page for paginated queries.
Tag	array<object>	No
	object	No
Key	string	No
Value	string	No
ClusterId	string	No	The cluster ID.
ClusterName	string	No	The cluster name.
ClusterType	integer	No	The cluster type.	1

Response elements

Element	Type	Description	Example
	object	Schema of Response
Code	integer	The response code.
RequestId	string	The ID of this request, which is a unique identifier generated by Alibaba Cloud for this request. It can be used for troubleshooting.
Message	string	The error message.
Success	boolean	Indicates whether the call was successful. true: The call was successful. false: The call failed.
Data	object
Records	array<object>
	array<object>
ClusterId	string	The cluster ID.
ClusterName	string	The cluster name.
ClusterSpec	string	The instance specification.
ProductType	integer	The product edition. 1: Development Edition. 2: Professional Edition. 3: Enterprise Edition.
EngineType	string	The engine type.
EngineVersion	string	The engine version.
Status	integer	The cluster status. 1: Creating. 2: Running. 3: Restarting. 4: Destroying. 5: Creation failed. 6: Stopped. 99: Deleted.
CreateTime	string	The creation time.
EndTime	string	The expiration time.
IntranetDomain	string	The internal domain name.
InternetDomain	string	The public domain name. Note Currently not supported.
ChargeType	string	The billing method. Valid values: PREPAY: subscription. POSTPAY: pay-as-you-go.
VpcId	string	The VPC ID.
VSwitches	array<object>	The vSwitch information of the zone.
	object	The result set.
ZoneId	string	The zone.
VSwitchId	string	The vSwitch ID.
SpInstanceId	string	The order asset instance ID.
VersionLifecycle	string	The version lifecycle.
Tags	object	The tags.
ClusterType	integer	The cluster type.	1
Source	string	The source.
Total	integer	The total number of entries.
PageNumber	integer	The page number.
PageSize	integer	The number of records per page.

Examples

Success response

JSON format

{
  "Code": 0,
  "RequestId": "",
  "Message": "",
  "Success": false,
  "Data": {
    "Records": [
      {
        "ClusterId": "",
        "ClusterName": "",
        "ClusterSpec": "",
        "ProductType": 0,
        "EngineType": "",
        "EngineVersion": "",
        "Status": 0,
        "CreateTime": "",
        "EndTime": "",
        "IntranetDomain": "",
        "InternetDomain": "",
        "ChargeType": "",
        "VpcId": "",
        "VSwitches": [
          {
            "ZoneId": "",
            "VSwitchId": ""
          }
        ],
        "SpInstanceId": "",
        "VersionLifecycle": "",
        "Tags": {
          "test": "test",
          "test2": 1
        },
        "ClusterType": 1,
        "Source": ""
      }
    ],
    "Total": 0,
    "PageNumber": 0,
    "PageSize": 0
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	Parameter error: %s.	Parameter error: %s
401	IllegalRequest	IllegalRequest: %s.	Illegal request:%s
500	InternalError	InternalError: %s.	System Internal Error: %s
403	NoPermission	No permission to perform this operation: %s.	No permission to perform this operation: %s
404	NotFound	Not found: %s.	The resource does not exist: %s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.