文档首页/ 数据安全中心 DSC/ API参考/ API/ 资产发现与管理/ 获取DWS实例列表 - ListDws
更新时间：2026-10-09 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取DWS实例列表 - ListDws

功能介绍

功能介绍：获取DWS实例列表

调用方法

请参见如何调用API。

授权信息

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

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

URI

GET /v1/{project_id}/sdg/asset/dws

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

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

默认取值：

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

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

默认取值：

不涉及

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

clusters

Array of Dws objects

参数解释：

集群列表

取值范围：

不涉及
表4 Dws

参数

参数类型

描述

id

String

参数解释：

资源ID，唯一标识

取值范围：

不涉及

status

String

参数解释：

操作结果状态

取值范围：

不涉及

project_id

String

参数解释：

项目ID

取值范围：

不涉及

subnet_id

String

参数解释：

子网ID

取值范围：

不涉及

security_group_id

String

参数解释：

安全组ID

取值范围：

不涉及

vpc_id

String

参数解释：

虚拟私有云ID

取值范围：

不涉及

version

String

参数解释：

实例版本

取值范围：

不涉及

port

Integer

参数解释：

连接端口

取值范围：

不涉及

name

String

参数解释：

DWS实例名称

取值范围：

不涉及

endpoints

Array of Endpoints objects

参数解释：

终端节点列表

取值范围：

不涉及

private_ip

Array of strings

参数解释：

ecs的私网IP

取值范围：

不涉及

address

String

参数解释：

连接地址

取值范围：

不涉及

public_ip

PublicIp object

参数解释：

弹性公网IP

取值范围：

不涉及

created

String

参数解释：

创建

取值范围：

不涉及
表5 Endpoints

参数

参数类型

描述

connect_info

String

参数解释：

连接信息

取值范围：

不涉及
表6 PublicIp

参数

参数类型

描述

id

String

参数解释：

资源ID，唯一标识

取值范围：

不涉及

public_ip_address

String

参数解释：

公共IP地址地址

取值范围：

不涉及

status

String

参数解释：

操作结果状态

取值范围：

不涉及

bandwidth_size

Integer

参数解释：

带宽大小

取值范围：

不涉及

请求示例

获取DWS实例列表

/v1/2b31ed520xxxxxxebedb6e57xxxxxxxx/sdg/asset/dws

响应示例

状态码：200

{
  "clusters" : [ {
    "id" : "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "status" : "ENABLE",
    "project_id" : "f7e6d5c4-b3a2-1908-7f6e-5d4c3b2a1908",
    "subnet_id" : "3a7b8c9d-0e1f-2a3b-4c5d-6e7f8a9b0c1d",
    "security_group_id" : "826314dd-1b5b-4037-b976-5f9b7a17df46",
    "vpc_id" : "0cfd1d3e-2c4a-4d1f-8e2b-9a3c4d5e6f70",
    "version" : "1.0.0",
    "port" : 3306,
    "name" : "asset-resource-01",
    "endpoints" : [ {
      "connect_info" : "asset-value-01"
    } ],
    "private_ip" : [ "192.168.1.10", "192.168.1.11" ],
    "address" : "192.168.1.100",
    "public_ip" : {
      "id" : "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
      "public_ip_address" : "192.168.1.100",
      "status" : "ENABLE",
      "bandwidth_size" : 1
    },
    "created" : "asset-value-01"
  } ]
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码。

父主题： 资产发现与管理

相关文档