查询纳管实例列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
cddc:ListPrinsInstances | list | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 否 | 地域 ID。可查看地域信息获取。 | cn-hangzhou |
InstanceName | string | 否 | 自建纳管实例名称。 | pr-22a21ac289e0**** |
PageSize | integer | 否 | 每页展示数目。 | 30 |
PageNumber | integer | 否 | 实例列表的页码,起始值为 1,默认值为 1。 | 1 |
EngineType | string | 否 | 引擎类型,取值:
| MySQL |
Tag | array<object> | 否 | 标签信息,筛选出包含对应标签键值的实例。 | |
object | 否 | 标签。 | ||
Key | string | 否 | 标签的键。 | demokey |
Value | string | 否 | 标签的值。 | demovalue |
MaxResults | integer | 否 | 说明
该参数暂未上线,当前使用 PageNumber 与 PageSize 完成分页查询操作。
| 20 |
NextToken | string | 否 | 说明
该参数暂未上线,当前使用 PageNumber 与 PageSize 完成分页查询操作。
| caeba0bbb2be03f84eb48b699f0a4883 |
EngineVersion | string | 否 | 数据库版本。 | 8.0.36 |
返回参数
示例
正常返回示例
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"
}
错误码
访问错误中心查看更多错误码。