All Products
Search
Document Center

Database Autonomy Service:GetSqlConcurrencyControlKeywordsFromSqlText

Last Updated:Mar 22, 2024

Generates a throttling keyword string based on an SQL statement.

Operation description

This operation supports the following database engines:

  • ApsaraDB RDS for MySQL
  • PolarDB for MySQL

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:
    • The required resource types are displayed in bold characters.
    • 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.
OperationAccess levelResource typeCondition keyAssociated operation
hdm:GetSqlConcurrencyControlKeywordsFromSqlTextRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ConsoleContextstringNo

The reserved parameter.

None
InstanceIdstringYes

The instance ID.

rm-2ze5hpn2b99d2****
SqlTextstringYes

The SQL statement based on which a throttling keyword string is to be generated.

SELECT * FROM test where name = 'das'

Response parameters

ParameterTypeDescriptionExample
object
Codestring

The HTTP status code returned.

200
Messagestring

The returned message.

Note If the request was successful, Successful is returned. If the request failed, an error message such as an error code is returned.
Successful
Datastring

The throttling keyword string that was generated based on the SQL statement.

SELECT~FROM~test~where~name
RequestIdstring

The request ID.

30A643F5-D7A6-55F5-AB75-DF501427****
Successstring

Indicates whether the request was successful. Valid values:

  • true
  • false
true

The returned throttling keyword string is generated based on SQL syntax. To throttle a specific value, you must add the value to the string. For example, if the original SQL statement is SELECT \* FROM test where name = 'das', the following throttling keyword string is returned: SELECT~FROM~test~where~name. If you want to throttle the das value, you must add ~das to the string, so that the string becomes SELECT~FROM~test~where~name~das.

Examples

Sample success responses

JSONformat

{
  "Code": "200",
  "Message": "Successful",
  "Data": "SELECT~FROM~test~where~name",
  "RequestId": "30A643F5-D7A6-55F5-AB75-DF501427****",
  "Success": "true"
}

Error codes

HTTP status codeError codeError message
400InvalidParamsThe request parameters are invalid.
403NoPermissionYou are not authorized to do this action.

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

Change history

Change timeSummary of changesOperation
No change history