DescribeSampleSqlRawTexts - ApsaraDB for OceanBase - Alibaba Cloud Documentation Center

You can call this operation to query the original text of a sampled SQL statement.

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
oceanbase:DescribeSampleSqlRawTexts	none	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	No	The ID of the OceanBase cluster.	ob317v4uif****
TenantId	string	No	The ID of the tenant.	ob2mr3oae0****
StartTime	string	Yes	The start time. The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.	2023-04-12T04:38:38Z
EndTime	string	Yes	The end time. The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.	2023-04-12T05:38:38Z
DbName	string	Yes	The name of the database.	test_db
SqlId	string	Yes	The ID of the SQL statement.	8D6E84**0B8FB1823D199E2CA1**
TraceId	string	No	The trace ID of the executed query, which is the value of TraceId returned by DescribeSQLSamples. Note Note Not all trace IDs of slow SQL statements can be used to query the original text.	YB420A700EFB-00060D53E42D0C61-0-0
Limit	string	No	The number of returned rows of the SQL statement.	20
DynamicSql	boolean	No	Specifies whether the SQL statement is an aggregation statement.	true

Response parameters

Parameter	Type	Description	Example
	object	The return result of the request.
RequestId	string	The ID of the request.	EE205C00-30E4-**-**-87E3A8A2AA0C
Data	object	The data list.
SqlText	array	The SQL statement.
SqlText	string	The SQL statement.	{ "RequestId": "EE205C00-30E4-**-**-87E3A8A2AA0C", "Data": { "SqlText": [ "\"INSERT INTO test (id, k, c, pad) VALUES (36, 87, 11,62582 )\"" ] } }

Examples

Sample success responses

JSONformat

{
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "Data": {
    "SqlText": [
      {
        "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
        "Data": {
          "SqlText": [
            "INSERT INTO test (id, k, c, pad) VALUES (36, 87, 11,62582 )"
          ]
        }
      }
    ]
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2025-07-08	The internal configuration of the API is changed, but the call is not affected	View Change Details
2024-10-29	The request parameters of the API has changed	View Change Details