DescribePrinsInstance - 获取纳管实例详情

获取纳管实例详情。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cddc:DescribePrinsInstanceget
*全部资源
*

请求参数

名称类型必填描述示例值
InstanceNamestring

自建纳管实例名称。

pr-22a21ac289e0****
RegionIdstringcn-hangzhou
Discoverboolean

是否查询关联的主从实例。

false

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

D6E068C3-25BC-455A-85FE-45F0B22E****
DbInstanceobject

纳管实例详情。

RegionIdstring

地域 ID。可查看地域信息获取。

cn-hangzhou
InstanceNamestring

自建纳管实例名称。

pr-22a21ac289e0****
EngineTypestring

引擎类型,取值:

  • MySQL
MySQL
EngineVersionstring

数据库版本。

8.0.36
Statusstring

实例状态。

枚举值:
  • inacitve异常
  • deleted已删除
  • creating创建中
  • active运行中
active
InstanceClassstring

实例规格。

2C4G
InstanceStorageTypestring

实例存储类型。

cloud_essd
InstanceStorageCapacitystring

存储容量。

40
GmtCreatedstring

实例创建时间的时间戳。

1729758903000
NetworkTypestring

实例网络类型。

vpc
VpcIdstring

实例所在的专有网络 ID 。

vpc-uf6idhbqkbuw11kw3****
Descriptionstring

实例描述。

test
HostInstancesarray<object>

实例包含的主机列表。

HostInstancesobject
GmtCreatedstring

主机创建时间的时间戳。

1729758903000
InstanceIdstring

ECS 实例 ID。

i-bp1gmm4pnacse343****
InstanceClassstring

ECS 规格信息。

ecs.c7.large
IpAddressarray<object>

ECS 的 IP 地址。

IpAddressobject
Ipstring

IP 信息。

127.0.0.1
Portstring

实例端口号。

3306
Typestring

IP 地址类型,取值:

  • Private:内网 IP

  • Public: 外网 IP

Private
InstanceNamestring

ECS 实例名称。

launch-advisor-20250603
Statusstring

ECS 主机状态。

枚举值:
  • deleted已删除
  • inactive异常
  • active运行中
active
ZoneIdstring

可用区 ID。

cn-hangzhou-j
InstanceRolestring

主机角色。

  • master

  • slave

master
DiskInfoarray<object>

ECS 磁盘信息。

DiskInfoobject

ECS 磁盘信息。

Idstring

磁盘 ID。

d-bp1ddpo8lqswottd****
Sizelong

磁盘大小,单位为 GB。

50
Categorystring

磁盘类型。取值范围:

  • cloud_efficiency:高效云盘。
  • cloud_ssd:SSD 云盘。
  • cloud_essd:ESSD 云盘。
  • cloud:普通云盘。
cloud_essd
Typestring

云盘或本地盘磁盘类型 ,取值:

  • system:系统盘

  • data: 数据盘

system
Usagestring

磁盘使用率。

40
Devicestring

云盘或本地盘挂载实例的设备名。

/dev/xvda
Cpustring

主机 CPU 核数。

2
Memstring

内存大小,单位 GB。

4
VpcIdstring

主机所在专有网络 ID 。

vpc-bp1d5gyhoue53eu6h****
Portstring

主机端口。

3306
Descriptionstring

主机描述。

test
Ipstring

纳管实例时选择的主机 IP。

127.0.0.1
SecurityGroupIdstring

纳管实例时指定的安全组 ID。

sg-uf6bo3fxuuen4uxndp9j
Tagarray<object>

标签列表。

Tagobject

标签信息。

Keystring

标签键。

key
Valuestring

标签值。

value
DmsIdstring

实例关联的 dms 实例 id

2717906
DasIdstring

实例关联的 das 实例 id。

hdm_ef2263e117f23c4f3114417742b4****
Aliasstring

实例别名。

alias

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

    OSZAR »