文档

DescribeSampleData - 查询是否加载样本数据集

更新时间:

查询AnalyticDB PostgreSQL版实例中是否加载了样本数据集。

调试

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

授权信息

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

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

请求参数

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

实例 ID。

说明 您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的实例 ID。
gp-bp12ga6v69h86****

返回参数

名称类型描述示例值
object

返回数据。

RequestIdstring

请求 ID。

84CD7CAF-FA7B-5178-B19F-D8CDE307D5FA_8111
HasSampleDataboolean

是否加载了样本数据集,取值如下:

  • true:已加载样本数据集。
  • false:未加载样本数据集。
true
ErrorMessagestring

该信息表示 API 在调用过程中出现了意料之外的错误,但不影响 API 的正常使用。

******
DBInstanceIdstring

实例 ID。

gp-bp12ga6v69h86****
SampleDataStatusstring

样本数据集的加载状态,取值说明:

  • loaded:已加载。
  • loading:加载中。
  • unload:未加载。
loaded

示例

正常返回示例

JSON格式

{
  "RequestId": "84CD7CAF-FA7B-5178-B19F-D8CDE307D5FA_8111",
  "HasSampleData": true,
  "ErrorMessage": "******",
  "DBInstanceId": "gp-bp12ga6v69h86****",
  "SampleDataStatus": "loaded"
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
  • 本页导读 (1)
文档反馈