ListPrinsInstances - ApsaraDB for MyBase - Alibaba Cloud Documentation Center

Queries the list of managed 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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
cddc:ListPrinsInstances	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID. For more information, see Region IDs.	cn-hangzhou
InstanceName	string	No	The name of the self-managed instance.	pr-22a21ac289e0****
PageSize	integer	No	The number of entries per page.	30
PageNumber	integer	No	The page number of the instance list. Start value: 1. Default value: 1.	1
EngineType	string	No	The database engine of the instance. Valid values: MySQL	MySQL
Tag	array<object>	No	The tag information, which filters the instances that contain the corresponding tag key value.
	object	No	The tag information.
Key	string	No	The tag key.	demokey
Value	string	No	The tag value.	demovalue
MaxResults	integer	No	Note This parameter is not available. The PageNumber and PageSize parameters are used to perform paged queries.	20
NextToken	string	No	Note This parameter is not available. The PageNumber and PageSize parameters are used to perform paged queries.	caeba0bbb2be03f84eb48b699f0a4883
EngineVersion	string	No	The database version.	8.0.36

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	D6E068C3-25BC-455A-85FE-45F0B22****
PageSize	integer	The number of entries per page.	30
PageNumber	integer	The current page number.	1
TotalCount	integer	The total number of entries returned.	100
Instances	array<object>	Details of the instances.
Instances	object	The details of the instance.
RegionId	string	The region ID of the host.	cn-hangzhou
Status	string	The state of the instance. Valid values: inactive: Abnormal. Deleted: Deleted Creating:Creating Active: Running	active
InstanceName	string	The name of the self-managed instance.	pr-22a21ac289e0****
Alias	string	The alias of the instance.	test
EngineType	string	The engine type. Valid values: MySQL	MySQL
EngineVersion	string	The database engine version.	8.0.36
GmtCreated	string	The timestamp when the instance was created.	1729758903000
Description	string	The description of the instance.	test
Tag	array<object>	A list of tags.
Tag	object	The information about the tag.
Key	string	The tag key.	key
Value	string	The tag value.	value
DmsId	string	The ID of the DMS instance associated with this instance.	2717906
DasId	string	The ID of the DAS instance associated with this instance.	hdm_ef2263e117f23c4f3114417742b****
Vip	boolean	The IP address of the instance.	127.0.0.1
MaxResults	integer	Note This parameter is not available. The PageNumber and PageSize parameters are used to perform paged queries. The maximum number of results that can be returned each time when you use a NextToken query.	100
NextToken	string	Note This parameter is not available. The PageNumber and PageSize parameters are used to perform paged queries. The query credential value returned by this call.	4b1e854bca4f2fb7e0b5e8707e68181f

Examples

Sample success responses

JSONformat

{
  "RequestId": "D6E068C3-25BC-455A-85FE-45F0B22****",
  "PageSize": 30,
  "PageNumber": 1,
  "TotalCount": 100,
  "Instances": [
    {
      "RegionId": "cn-hangzhou",
      "Status": "active",
      "InstanceName": "pr-22a21ac289e0****",
      "Alias": "test",
      "EngineType": "MySQL",
      "EngineVersion": "8.0.36",
      "GmtCreated": 1729758903000,
      "Description": "test",
      "Tag": [
        {
          "Key": "key",
          "Value": "value"
        }
      ],
      "DmsId": 2717906,
      "DasId": "hdm_ef2263e117f23c4f3114417742b****",
      "Vip": true
    }
  ],
  "MaxResults": 100,
  "NextToken": "4b1e854bca4f2fb7e0b5e8707e68181f"
}

Error codes

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