DescribeSQLWebSocketDomain-阿里云帮助中心

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

adb:DescribeSQLWebSocketDomain

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. Note Call the DescribeRegions API to query the region IDs supported by AnalyticDB for MySQL.	cn-hangzhou
DBClusterId	string	No	The cluster ID. Note Call the DescribeDBClusters API to query the details of all clusters in your account, including cluster IDs.	amv-bp1lw6g669zpi660
Module	string	No	The application module name. `SQLWebSocket`: The module for SQL development. `Assistant`: The module for the intelligent assistant. Valid values: SQLWebSocket : SQLWebSocket Assistant : Assistant	Assistant

Response elements

Element	Type	Description	Example
	object
Code	integer	The status code. A value of 200 indicates that the request succeeded.	200
Message	string	The response message. Returns Success if the request succeeds. Returns a specific error code if the request fails.	Success
RequestId	string	The unique identifier for the request.	E03F0806-A67B-5B24-8562-9589F20DEEB5
Success	boolean	Indicates whether the API call succeeded. Valid values: true: The call succeeded. false: The call failed.	true
Domain	string	The domain name.	adb-ws-beijing.console.aliyun.com/query

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.