GetStatementResult - 获取异步SQL执行结果

更新时间:

获取异步SQL执行结果。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
gpdb:GetStatementResultget
*全部资源
*

请求参数

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

实例 ID。可调用 DescribeDBInstances 获取。

gp-xxxxxxxxx
RegionIdstring

实例所在地域 ID。

cn-beijing
SecretArnstring

访问凭证。通过 CreateSecret 接口创建。

说明 通过子账号访问此接口时,需要有对此 SecretArn 的 UseSecret 或 GetSecretValue 的权限。
acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ
Databasestring

数据库名称。

test
Idstring

异步 SQL 时的任务 ID。

9A920F47-416A-4044-817C-7C2A72AD16D3

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

ABB39CC3-4488-4857-905D-2E4A051D0521
Messagestring

返回信息。

success
Statusstring

API 执行状态,取值如下:

  • false:执行失败。
  • true:执行成功。
success
Dataobject

异步调用的返回结果。

Recordsarray

多行数据。

Recordsarray

单行数据。

RecordField

单个数据。

ColumnMetadataarray

列元数据列表。

ColumnMetadataColumnMetadata

列元数据。

TotalNumRowslong

总共条目。

10

示例

正常返回示例

JSON格式

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Message": "success",
  "Status": "success",
  "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
  }
}

错误码

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