文档

ListExternalDataSources - 获取数据源列表

更新时间:

获取数据源列表

调试

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

授权信息

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

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

请求参数

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

实例 ID。

gp-xxxxxxx
PageSizeinteger

每页记录数,取值说明:

  • 30
  • 50
  • 100

默认值:30。

50
PageNumberinteger

页码,大于 0 且不超过 Integer 的最大值,默认值:1

1
RegionIdstring

实例所在地域 ID。

cn-shanghai

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

BBE00C04-A3E8-4114-881D-0480A72CB92E
TotalRecordCountinteger

总记录数。

2
PageNumberinteger

当前页码。

1
Itemsarray<object>

Hadoop 外部表服务列表。

Itemsobject
DataSourceIdinteger

服务 ID。

123
DataSourceNamestring

服务名称。

hdfs_pxf
DataSourceTypestring

数据源类型。

枚举值:
  • hivehive
  • postgresqlpostgresql
  • hdfshdfs
  • mysqlmysql
  • sqlServersqlServer
hdfs
DataSourceDescriptionstring

数据源描述。

test
CreateTimestring

创建时间。

2019-09-08T16:00:00Z
ModifyTimestring

最后修改时间。

2019-10-08T16:00:00Z
DataSourceStatusstring

服务状态位,取值:

  • 初始化中 Init

  • 运行中 Running

  • 异常 Exception

Running
StatusMessagestring

服务状态信息,例如异常情况,则显示异常原因。正常 Running 状态下空值。

""
DataSourceDirstring

服务目录,在该目录下保留有 Hadoop 相关的配置文件。

HadoopDir
ExternalDataServiceIdinteger

外部数据服务 id

123

示例

正常返回示例

JSON格式

{
  "RequestId": "BBE00C04-A3E8-4114-881D-0480A72CB92E",
  "TotalRecordCount": 2,
  "PageNumber": 1,
  "Items": [
    {
      "DataSourceId": 123,
      "DataSourceName": "hdfs_pxf",
      "DataSourceType": "hdfs",
      "DataSourceDescription": "test",
      "CreateTime": "2019-09-08T16:00:00Z",
      "ModifyTime": "2019-10-08T16:00:00Z",
      "DataSourceStatus": "Running",
      "StatusMessage": "\"\"",
      "DataSourceDir": "HadoopDir",
      "ExternalDataServiceId": 123
    }
  ]
}

错误码

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