DescribePrinsInstance - ApsaraDB for MyBase - Alibaba Cloud Documentation Center

Retrieves the details of a managed instance.

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:DescribePrinsInstance	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceName	string	No	The name of the self-managed instance.	pr-22a21ac289e0****
RegionId	string	No	Region ID	cn-hangzhou
Discover	boolean	No	Specifies whether to query associated primary and replica instances.	false

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	D6E068C3-25BC-455A-85FE-45F0B22E****
DbInstance	object	The details of the managed instance.
RegionId	string	The region ID. For more information, see Region IDs.	cn-hangzhou
InstanceName	string	The name of the self-managed instance.	pr-22a21ac289e0****
EngineType	string	The engine type. Valid values: MySQL	MySQL
EngineVersion	string	The database engine version.	8.0.36
Status	string	The current status of the instance. Valid values: inacitve: Abnormal deleted: Deleted creating: Creating active:Running	active
InstanceClass	string	The instance specification.	2C4G
InstanceStorageType	string	The storage type of the instance.	cloud_essd
InstanceStorageCapacity	string	The storage capacity.	40
GmtCreated	string	The timestamp when the instance was created.	1729758903000
NetworkType	string	The network type of the instance.	vpc
VpcId	string	The ID of the virtual private cloud (VPC) where the cluster is located.	vpc-uf6idhbqkbuw11kw3****
Description	string	The description of the instance.	test
HostInstances	array<object>	A list of hosts included in the instance.
HostInstances	object
GmtCreated	string	The timestamp when the host was created.	1729758903000
InstanceId	string	The ECS instance ID.	i-bp1gmm4pnacse343****
InstanceClass	string	The ECS specification information.	ecs.c7.large
IpAddress	array<object>	The IP address of the ECS instance.
IpAddress	object
Ip	string	The IP address.	127.0.0.1
Port	string	The port number that is used to connect to the instance.	3306
Type	string	The IP address type. Valid values: Private: Internal IP Public: Public IP	Private
InstanceName	string	The ECS instance name.	launch-advisor-20250603
Status	string	The ECS host status. Valid values: deleted: Deleted inactive: Abnormal active: Running	active
ZoneId	string	The zone ID.	cn-hangzhou-j
InstanceRole	string	The role of the host. master slave	master
DiskInfo	array<object>	The disk information of the ECS instance.
DiskInfo	object	The ECS disk information.
Id	string	The disk ID.	d-bp1ddpo8lqswottd****
Size	long	The size of the disk. Unit: GB.	50
Category	string	The disk category. Valid values: cloud_efficiency: ultra disk cloud_ssd: standard SSD cloud_essd: enterprise SSD (ESSD) cloud: basic disk	cloud_essd
Type	string	The type of the cloud disk or local disk. Valid values: system: system disk data: data disk	system
Usage	string	The disk usage percentage.	40
Device	string	The device name of the disk mounted on the instance.	/dev/xvda
Cpu	string	The number of the CPU cores on the host.	2
Mem	string	The memory size, in GB.	4
VpcId	string	The ID of the VPC where the host is located.	vpc-bp1d5gyhoue53eu6h****
Port	string	The host port.	3306
Description	string	The description of the host.	test
Ip	string	The host IP address selected when the instance was added for management.	127.0.0.1
SecurityGroupId	string	The security group ID specified when the instance was added for management.	sg-uf6bo3fxuuen4uxndp9j
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 associated DMS instance.	2717906
DasId	string	The ID of the associated DAS instance.	hdm_ef2263e117f23c4f3114417742b4****
Alias	string	The alias of the instance.	alias

Examples

Sample success responses

JSONformat

{
  "RequestId": "D6E068C3-25BC-455A-85FE-45F0B22E****",
  "DbInstance": {
    "RegionId": "cn-hangzhou",
    "InstanceName": "pr-22a21ac289e0****",
    "EngineType": "MySQL",
    "EngineVersion": "8.0.36",
    "Status": "active",
    "InstanceClass": "2C4G",
    "InstanceStorageType": "cloud_essd",
    "InstanceStorageCapacity": 40,
    "GmtCreated": 1729758903000,
    "NetworkType": "vpc",
    "VpcId": "vpc-uf6idhbqkbuw11kw3****",
    "Description": "test",
    "HostInstances": [
      {
        "GmtCreated": 1729758903000,
        "InstanceId": "i-bp1gmm4pnacse343****",
        "InstanceClass": "ecs.c7.large",
        "IpAddress": [
          {
            "Ip": "127.0.0.1",
            "Port": 3306,
            "Type": "Private"
          }
        ],
        "InstanceName": "launch-advisor-20250603",
        "Status": "active",
        "ZoneId": "cn-hangzhou-j",
        "InstanceRole": "master",
        "DiskInfo": [
          {
            "Id": "d-bp1ddpo8lqswottd****",
            "Size": 50,
            "Category": "cloud_essd",
            "Type": "system",
            "Usage": 40,
            "Device": "/dev/xvda"
          }
        ],
        "Cpu": 2,
        "Mem": 4,
        "VpcId": " vpc-bp1d5gyhoue53eu6h****",
        "Port": 3306,
        "Description": "test",
        "Ip": "127.0.0.1",
        "SecurityGroupId": "sg-uf6bo3fxuuen4uxndp9j"
      }
    ],
    "Tag": [
      {
        "Key": "key",
        "Value": "value"
      }
    ],
    "DmsId": 2717906,
    "DasId": "hdm_ef2263e117f23c4f3114417742b4****",
    "Alias": "alias"
  }
}

Error codes

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