文档首页/ 数据安全中心 DSC/ API参考/ API/ 资产发现与管理/ 获取dds实例列表 - ListDdsInstances
更新时间:2026-10-09 GMT+08:00
分享

获取dds实例列表 - ListDdsInstances

功能介绍

功能介绍:获取dds实例列表

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v1/{project_id}/sdg/asset/dds/instances

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID。可参考获取项目ID获取。

约束限制:

不涉及

取值范围:

以IAM服务接口返回值为准,字符长度32-32。

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

id

否

String

参数解释:

ID标识

约束限制:

最大长度256字符

取值范围:

1到256个字符

默认取值:

不涉及

name

否

String

参数解释:

DDS实例名称

约束限制:

最大长度256字符

取值范围:

1到256个字符

默认取值:

不涉及

mode

否

String

参数解释:

实例模式

约束限制:

最大长度256字符

取值范围:

1到256个字符

默认取值:

不涉及

datastore_type

否

String

参数解释:

数据存储类型

约束限制:

最大长度256字符

取值范围:

1到256个字符

默认取值:

不涉及

vpc_id

否

String

参数解释:

虚拟私有云ID

约束限制:

最大长度256字符

取值范围:

1到256个字符

默认取值:

不涉及

subnet_id

否

String

参数解释:

子网ID

约束限制:

最大长度256字符

取值范围:

1到256个字符

默认取值:

不涉及

tags

否

String

参数解释:

标签

约束限制:

最大长度256字符

取值范围:

1到256个字符

默认取值:

不涉及

offset

否

Integer

参数解释:

分页偏移

约束限制:

不涉及

取值范围:

0~2147483647

默认取值:

不涉及

limit

否

Integer

参数解释:

每页数量限制

约束限制:

不涉及

取值范围:

0~2147483647

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及

取值范围:

IAM服务查询用户Token接口为准

默认取值:

不涉及

响应参数

状态码:200

查询成功

无

请求示例

获取dds实例列表

/v1/2b31ed520xxxxxxebedb6e57xxxxxxxx/sdg/asset/dds/instances

响应示例

状态码:200

{
  "id" : "0cfd1d3e-2c4a-4d1f-8e2b-9a3c4d5e6f70",
  "name" : "dds-instance-01",
  "status" : "ACTIVE",
  "region" : "cn-north-4"
}

状态码

状态码

描述

200

查询成功

错误码

请参见错误码。

相关文档