调用DescribeSQLWebSocketDomain API获取注册的WebSocket域名-云原生数据仓库AnalyticDB-阿里云-云原生数据仓库AnalyticDB(AnalyticDB)-阿里云帮助中心

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

adb:DescribeSQLWebSocketDomain

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。说明您可以调用 DescribeRegions 接口查看指定 AnalyticDB MySQL 数仓版支持的地域 ID。	cn-hangzhou
DBClusterId	string	否	集群 ID。说明您可以通过 DescribeDBClusters 接口查看账号下所有集群的详细信息，包括集群 ID。	amv-bp1lw6g669zpi660
Module	string	否	应用模块名称。 SQLWebSocket：SQL 开发。 Assistant：智能助手。枚举值： SQLWebSocket : SQLWebSocket Assistant : Assistant	Assistant

返回参数

名称	类型	描述	示例值
	object
Code	integer	状态码。说明 200 表示成功。	200
Message	string	调用结果的附加信息。取值说明：请求正常，返回 Success。请求异常，返回具体异常错误码。	Success
RequestId	string	阿里云为该请求生成的唯一标识符。	E03F0806-A67B-5B24-8562-9589F20DEEB5
Success	boolean	调用是否成功，取值说明： true：成功。 false：失败。	true
Domain	string	域名。	adb-ws-beijing.console.aliyun.com/query

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "Success",
  "RequestId": "E03F0806-A67B-5B24-8562-9589F20DEEB5",
  "Success": true,
  "Domain": "adb-ws-beijing.console.aliyun.com/query"
}

错误码

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

变更历史

更多信息，参考变更详情。