文档首页/ 数据安全中心 DSC/ API参考/ API/ 基础设施查询/ 获取dds实例列表 - ListDdsInstances
更新时间:2026-11-13 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相关文档获取

约束限制:

满足正则匹配"^[a-z0-9]{32}$",32位小写字母和数字

取值范围:

长度为32个字符,只能由小写英文字母和数字组成

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

id

否

String

参数解释:

DDS实例ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

name

否

String

参数解释:

DDS实例名称

约束限制:

以 * 起始表示按后续值模糊匹配,* 不能单独使用

取值范围:

不涉及

默认取值:

不涉及

mode

否

String

参数解释:

实例模式

约束限制:

不涉及

取值范围:

  • Sharding-集群实例

  • ReplicaSet-副本集实例

  • Single-单节点实例

默认取值:

不涉及

datastoreType

否

String

参数解释:

数据库版本类型

约束限制:

不涉及

取值范围:

DDS-Community

默认取值:

不涉及

vpcId

否

String

参数解释:

虚拟私有云ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

subnet_id

否

String

参数解释:

子网ID,可通过虚拟私有云服务查询子网列表获取

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

tags

否

String

参数解释:

标签信息,用于筛选目标资源,多个标签以逗号分隔,单个标签格式为key=value

约束限制:

最多包含20组标签,key不能为空或重复

取值范围:

不涉及

默认取值:

不涉及

offset

否

Integer

参数解释:

分页偏移

约束限制:

不涉及

取值范围:

0~10000

默认取值:

0

limit

否

Integer

参数解释:

每页数量限制

约束限制:

不涉及

取值范围:

0~10000

默认取值:

0

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

查询成功

无

请求示例

获取dds实例列表

/v1/2b31ed5200000ebedb6e570000000000/sdg/asset/dds/instances

响应示例

状态码:200

{
  "instances" : [ {
    "id" : "0cfd1d3e-2c4a-4d1f-8e2b-9a3c4d5e6f70",
    "name" : "dds-instance-01",
    "status" : "ACTIVE",
    "region" : "cn-north-4",
    "port" : 8635,
    "type" : "ReplicaSet",
    "projectId" : "2b31ed5200000ebedb6e570000000000",
    "source_type" : "from_dds",
    "private_ips" : [ "192.168.1.10" ],
    "created" : "2024-01-01T00:00:00Z",
    "vpc_id" : "3a7b8c9d-0e1f-2a3b-4c5d-6e7f8a9b0c1d",
    "subnet_id" : "f7e6d5c4-b3a2-1908-7f6e-5d4c3b2a1908",
    "security_group_id" : "826314dd-1b5b-4037-b976-5f9b7a17df46"
  } ],
  "total_count" : 1
}

状态码

状态码

描述

200

查询成功

错误码

请参见错误码。

相关文档