DescribeSQLWebSocketDomain - AnalyticDB - Alibaba Cloud Documentation Center

Queries the WebSocket domain name of an AnalyticDB for MySQL cluster.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
adb:DescribeSQLWebSocketDomain	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID Note You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
DBClusterId	string	Yes	The cluster ID. Note You can call the DescribeDBClusters operation to query the IDs of all AnalyticDB for MySQL clusters within a region.	amv-bp1lw6g669zpi660

Response parameters

Parameter	Type	Description	Example
	object
Code	long	The status code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.	200
Message	string	The returned message. Valid values: If the request was successful, a success message is returned.**** If the request failed, an error message is returned.	Success
RequestId	string	The request ID.	E03F0806-A67B-5B24-8562-9589F20DEEB5
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
Domain	string	The domain name.	adb-ws-beijingnew.console.alibabacloud.com/query

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.