DescribeResultExportConfig - 获取结果集导出配置信息

更新时间:

获取用户配置的结果集导出信息

调试

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

授权信息

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

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

请求参数

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

地域 ID。

cn-shenzhen
DBClusterIdstring

集群 ID。

说明 调用 DescribeDBClusters 接口可以查看目标地域下所有 AnalyticDB MySQL 集群的集群 ID。
amv-8vbf80pjcz*****
ExportTypestring

导出类型,枚举类型,当前可选值为:

  • SLS:标识导出目的为 SLS。
  • OSS:标识导出目的为 OSS。
SLS

返回参数

名称类型描述示例值
object

ResultData<?>

RequestIdstring

请求 ID。

1AD222E9-E606-4A42-BF6D-8A4442913CEF
Successboolean

请求是否成功。取值说明:

  • True:成功。
  • False:失败。
true
HttpStatusCodeinteger

HTTP 请求返回的响应状态码,200 表示请求发送成功。

200
Messagestring

调用结果的信息。取值说明:

  • 请求正常,返回 OK
  • 请求异常,返回具体异常信息。
OK
Codestring

接口状态或 POP 错误码。

InvalidInput
Dataobject

返回数据。

ExportTypestring

导出类型,枚举类型,当前可选值为:

  • SLS:标识导出目的为 SLS。
  • OSS:标识导出目的为 OSS。
OSS
SlsInfoobject

导出类型为 SLS 时,对应的 SLS 配置信息。

SlsProjectstring

SLS Project 名称。

test-project
ResourceGroupstring

导出 SQL 运行的资源组名称。

aps
LogstoreTtlinteger

结果集导出临时生成的 logstore 的过期时间,单位为天,过期后自动删除。 最小 1 天,最大 30 天。

10
OssInfoobject

导出类型为 OSS 时,对应的 OSS 信息。

ExportBasePathstring

导出结果存储的 OSS 路径地址。

oss://testBucketName/data_result
ResourceGroupstring

导出 SQL 运行的资源组名称。

aps
ResultFileTtlinteger

Oss 文件过期时间,单位为天,最小 1 天,最大 30 天。

10

示例

正常返回示例

JSON格式

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "Success": true,
  "HttpStatusCode": 200,
  "Message": "OK",
  "Code": "InvalidInput",
  "Data": {
    "ExportType": "OSS",
    "SlsInfo": {
      "SlsProject": "test-project",
      "ResourceGroup": "aps",
      "LogstoreTtl": 10
    },
    "OssInfo": {
      "ExportBasePath": "oss://testBucketName/data_result\n",
      "ResourceGroup": "aps",
      "ResultFileTtl": 10
    }
  }
}

错误码

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