文档

ExecuteStatement - 执行SQL语句

更新时间:

调用ExecuteStatement接口对指定数据库执行SQL语句。

接口说明

本接口当前仅支持华东 1(杭州)、华北 2(北京)地域的 Serverless 实例使用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
SecretArnstring

Data API 账号的用户凭证,您可调用 DescribeSecrets 接口获取该参数的值。格式如下:acs:rds:{{region}}:{{accountId}}:rds-db-credentials/{{secretName}}-{{6 digits random string}}

acs:rds-api:cn-hangzhou:1266348003******:rds-db-credentials/mySecret-Uy****
ResourceArnstring

用于指向用户希望访问的资源,格式如下:acs:rds:{{regionId}}:{{accountId}}:dbinstance/{{instanceId}}

参数说明如下:

  • regionId:地域 ID,可调用 DescribeSecrets 接口获取。
  • accountId:阿里云账号 ID,可调用 DescribeSecrets 接口获取。
  • instanceId:实例 ID。
acs:rds:cn-hangzhou:1266348003******:dbinstance/rm-1234567890abc****
Databasestring

数据库名称。

test
ContinueAfterTimeoutboolean

如果调用超时,选择是否继续运行 SQL 语句,取值如下:

  • true:继续运行
  • false:停止运行
说明 默认情况下,SQL 语句在调用超时后停止运行。
true
FormatRecordsAsstring

是否将结果集格式化为单个 JSON 字符串。

  • 仅允许传入 NONEJSON
  • 默认值为 NONE
  • 此参数仅适用于 SELECT 语句,对于其他类型的语句将被忽略。
  • 结果将返回在 formattedRecords 中。
JSON
IncludeResultMetadataboolean

是否在结果中包含元数据的值,取值如下:

  • true:包含
  • false:不包含
true
Sqlstring

需要执行的 SQL 语句。

select * from users
TransactionIdstring

已启动的事务 ID,您可调用 BeginTransaction 接口获取该参数的值。

8609****-94e1-45ce-8e25-354e3dd8****
Parametersarray

待执行 SQL 语句的参数详情。

SqlParameter

参数值,详情请参见 SqlParameter

ResultSetOptionsobject

控制如何返回结果集的选项。

DecimalReturnTypestring

指定 DECIMAL 类型返回后,允许显示的数据类型。

  • STRING:将字段转换为 String 值。
  • DOUBLE_OR_LONG:如果它的 scale 为 0,则将字段转换为 Long 值,否则转换为 Double 值。
STRING
LongReturnTypestring

指定 LONG 类型返回后,允许显示的数据类型。

  • 允许取值为 LONGSTRING
  • 默认值为 LONG
  • 如果数值的长度或精度可能导致截断或舍入错误,建议请指定 STRING
STRING

返回参数

名称类型描述示例值
object

返回参数如下。

RequestIdstring

请求 ID。

CDAEE474-87E5-5AE3-A534-922F90D5867D
Successboolean

请求是否成功,返回值如下:

  • true:请求成功。
  • false:请求失败。
true
Codestring

状态码。

200
Messagestring

错误信息。

There is an error in the call.
DataExecuteStatementResult

返回数据,详情请参见 ExecuteStatementResult

示例

正常返回示例

JSON格式

{
  "RequestId": "CDAEE474-87E5-5AE3-A534-922F90D5867D",
  "Success": true,
  "Code": "200",
  "Message": "There is an error in the call.",
  "Data": {
    "ColumnMetadata": [
      {
        "ArrayBaseColumnType": 1,
        "IsAutoIncrement": true,
        "IsCaseSensitive": true,
        "IsCurrency": true,
        "IsSigned": false,
        "Label": "TBL_BIG",
        "Name": "name",
        "Nullable": 1,
        "Precision": 1,
        "Scale": 2,
        "SchemaName": "test_schema",
        "TableName": "users",
        "Type": 93,
        "TypeName": "TIMESTAMP"
      }
    ],
    "FormattedRecords": "[{ \"name\": \"jack\" }]",
    "GeneratedFields": [
      {
        "ArrayValue": "[item1, item2, item3]",
        "BlobValue": "aGVsbG8=",
        "BooleanValue": true,
        "IsNull": true,
        "LongValue": 3213212,
        "StringValue": "I am a string"
      }
    ],
    "NumberOfRecordsUpdated": 2,
    "Records": [
      [
        {
          "ArrayValue": "[item1, item2, item3]",
          "BlobValue": "aGVsbG8=",
          "BooleanValue": true,
          "IsNull": true,
          "LongValue": 3213212,
          "StringValue": "I am a string"
        }
      ]
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-09-14API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用