全部产品
Search
文档中心

云原生数据仓库AnalyticDB:ListExternalDataServices - 获取外部数据服务列表

更新时间:Nov 19, 2024

获取外部数据服务列表。

调试

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

授权信息

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

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

请求参数

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

地域 ID,您可通过接口 DescribeRegions 查看可用的地域 ID。

cn-hangzhou
DBInstanceIdstring

实例 ID。

gp-bp10g78o9807yv9h3
PageNumberinteger

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

1
PageSizeinteger

每页记录数,取值说明:

  • 30
  • 50
  • 100

默认值:30

50

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

B4CAF581-2AC7-41AD-8940-D56DF7AADF5B
TotalRecordCountinteger

总记录数。

2
PageNumberinteger

当前页码。

1
ServiceItemsarray<object>

列表项

itemsobject

列表项

ServiceIdstring

服务 ID。

1
ServiceTypestring

服务类型,取值:

  • pxf
pxf
ServiceNamestring

服务名称。

test-pxf
ServiceDescriptionstring

服务描述。

test-pxf
ServiceSpecstring

服务规格(单位 CU)。

8
Statusstring

服务状态,取值:

  • Init:初始化中

  • Running:运行中

  • Exception:异常

  • Paused:暂停

Running
CreateTimestring

创建时间。

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

最后修改时间。

2019-09-08T17:00:00Z

示例

正常返回示例

JSON格式

{
  "RequestId": "B4CAF581-2AC7-41AD-8940-D56DF7AADF5B",
  "TotalRecordCount": 2,
  "PageNumber": 1,
  "ServiceItems": [
    {
      "ServiceId": "1",
      "ServiceType": "pxf",
      "ServiceName": "test-pxf",
      "ServiceDescription": "test-pxf",
      "ServiceSpec": "8",
      "Status": "Running",
      "CreateTime": "2019-09-08T16:00:00Z",
      "ModifyTime": "2019-09-08T17:00:00Z"
    }
  ]
}

错误码

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