ListPrinsInstances - 查询纳管实例列表

查询纳管实例列表。

调试

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

授权信息

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

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

请求参数

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

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

cn-hangzhou
InstanceNamestring

自建纳管实例名称。

pr-22a21ac289e0****
PageSizeinteger

每页展示数目。

30
PageNumberinteger

实例列表的页码,起始值为 1,默认值为 1。

1
EngineTypestring

引擎类型,取值:

  • MySQL
MySQL
Tagarray<object>

标签信息,筛选出包含对应标签键值的实例。

object

标签。

Keystring

标签的键。

demokey
Valuestring

标签的值。

demovalue
MaxResultsinteger
说明 该参数暂未上线,当前使用 PageNumber 与 PageSize 完成分页查询操作。
20
NextTokenstring
说明 该参数暂未上线,当前使用 PageNumber 与 PageSize 完成分页查询操作。
caeba0bbb2be03f84eb48b699f0a4883
EngineVersionstring

数据库版本。

8.0.36

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

D6E068C3-25BC-455A-85FE-45F0B22****
PageSizeinteger

每页展示数目。

30
PageNumberinteger

页码

1
TotalCountinteger

总记录条数

100
Instancesarray<object>

实例信息列表。

Instancesobject

实例信息。

RegionIdstring

主机所属的地域 ID。

cn-hangzhou
Statusstring

实例状态描述。

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

自建纳管实例名称。

pr-22a21ac289e0****
Aliasstring

实例别名。

test
EngineTypestring

引擎类型,取值:

  • MySQL
MySQL
EngineVersionstring

数据库版本。

8.0.36
GmtCreatedstring

实例创建时间的时间戳。

1729758903000
Descriptionstring

实例描述。

test
Tagarray<object>

标签列表。

Tagobject

标签信息。

Keystring

标签的键。

key
Valuestring

标签的值。

value
DmsIdstring

实例关联的 dms 实例 id。

2717906
DasIdstring

实例关联的 das 实例 id。

hdm_ef2263e117f23c4f3114417742b****
Vipboolean

实例的 ip。

127.0.0.1
MaxResultsinteger
说明 该参数暂未上线,当前使用 PageNumber 与 PageSize 完成分页查询操作。

使用 NextToken 方式查询时,每次最多返回的结果数。

100
NextTokenstring
说明 该参数暂未上线,当前使用 PageNumber 与 PageSize 完成分页查询操作。

本次调用返回的查询凭证值。

4b1e854bca4f2fb7e0b5e8707e68181f

示例

正常返回示例

JSON格式

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

错误码

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