ExecuteStatement - AnalyticDB - Alibaba Cloud Documentation Center

Executes SQL statements.

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
gpdb:ExecuteStatement	create	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID. Note You can call the DescribeDBInstances operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.	gp-xxxxxxxxx
RegionId	string	Yes	The region ID of the instance.	cn-beijing
SecretArn	string	Yes	The Alibaba Cloud Resource Name (ARN) of the access credential for the created Data API account. You can call the CreateSecret operation to create an access credential. Note To call the ExecuteStatement operation as a Resource Access Management (RAM) user, the RAM user must have the permissions to call the UseSecret or GetSecretValue operation on the ARN of the access credential.	acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ
Database	string	Yes	The name of the database.	adbtest
RunType	string	No	The execution type. Valid values: synchronous asynchronous (not supported)	synchronous
StatementName	string	No	The name of the set of SQL statements that you want to execute. This parameter takes effect when the RunType parameter is set to asynchronous.	test
Sql	string	No	The SQL statements that you want to execute.	select * from table1
Sqls	array	No	The SQL statements.
	string	No	The SQL statement.	["set idle_in_transaction_session_timeout = 300000", "select * from table1"]
Parameters	array	No	The configuration parameters.
	any	No	The configuration parameter.	myvalue

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	ABB39CC3-4488-4857-905D-2E4A051D0521
Message	string	The returned message.	success
Status	string	The status of the operation. Valid values: success fail	success
DBInstanceId	string	The instance ID.	gp-xxxxxxxxx
SecretArn	string	The ARN of the access credential for the created Data API account.	acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ
CreatedAt	string	The time when the SQL statements were created.	2023-12-04T10:08:47+0800
Database	string	The name of the database.	adbtest
Id	string	The ID of the job for asynchronously executing the SQL statements.	ABB39CC3
Data	object	The returned results of the synchronous call.
Records	array	The rows of data.
Records	array	The row of data.
Record	Field	The data of the field.
ColumnMetadata	array	The metadata of the columns.
ColumnMetadata	ColumnMetadata	The metadata of the column.
TotalNumRows	long	The total number of entries returned.	10

Examples

Sample success responses

JSONformat

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Message": "success",
  "Status": "success",
  "DBInstanceId": "gp-xxxxxxxxx",
  "SecretArn": "acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ",
  "CreatedAt": "2023-12-04T10:08:47+0800",
  "Database": "adbtest",
  "Id": "ABB39CC3",
  "Data": {
    "Records": {
      "Records": [
        {
          "Record": [
            {
              "BlobValue": "",
              "BooleanValue": true,
              "DoubleValue": 0,
              "IsNull": true,
              "LongValue": 0,
              "StringValue": ""
            }
          ]
        }
      ]
    },
    "ColumnMetadata": {
      "ColumnMetadata": [
        {
          "Name": "",
          "DataType": "",
          "ColumnDefault": "",
          "MaxLength": 0,
          "Nullable": true,
          "SchemaName": "",
          "TableName": "",
          "IsCaseSensitive": true,
          "IsCurrency": true,
          "IsSigned": true,
          "Precision": 0,
          "Scale": 0,
          "IsPrimaryKey": true,
          "Comment": "",
          "UdtName": ""
        }
      ]
    },
    "TotalNumRows": 10
  }
}

Error codes

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