文档

ListStreamingDataSources - 查询所有实时服务数据源

更新时间:

查询所有实时服务数据源

调试

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

授权信息

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

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

请求参数

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

地域 ID。

说明 您可以调用 DescribeRegions 接口查看可用的地域 ID。
cn-beijing
DBInstanceIdstring

实例 ID。

gp-bp10g78o9807yv9h3
PageSizeinteger

每页记录数,取值说明:

  • 30
  • 50
  • 100

默认值:30

30
PageNumberinteger

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

1

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

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

总记录数。

2
PageNumberinteger

当前页码。

1
DataSourceItemsarray<object>

返回的数据源列表。

DataSourceItemsobject
DataSourceIdinteger

数据源 ID。

1
DataSourceNamestring

数据源名称

test-kafka
DataSourceTypestring

数据源类型,取值:

  • kafka
kafka
DataSourceConfigstring

数据源配置

{"brokers":"broker0:9091,broker1:9091","topic":"topic"}
DataSourceDescriptionstring

数据源描述。

test-kafka
CreateTimestring

创建时间。

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

最后修改时间。

2019-09-08T17:00:00Z
Statusstring

服务状态,取值如下:

  • 初始化中 init

  • 运行中 running

  • 异常 exception

running
ServiceIdinteger

服务 ID。

1
ErrorMessagestring

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

""

示例

正常返回示例

JSON格式

{
  "RequestId": "B4CAF581-2AC7-41AD-8940-D56DF7AADF5B",
  "TotalRecordCount": 2,
  "PageNumber": 1,
  "DataSourceItems": [
    {
      "DataSourceId": 1,
      "DataSourceName": "test-kafka",
      "DataSourceType": "kafka",
      "DataSourceConfig": "{\"brokers\":\"broker0:9091,broker1:9091\",\"topic\":\"topic\"}",
      "DataSourceDescription": "test-kafka",
      "CreateTime": "2019-09-08T16:00:00Z",
      "ModifyTime": "2019-09-08T17:00:00Z",
      "Status": "running",
      "ServiceId": 1,
      "ErrorMessage": "\"\""
    }
  ]
}

错误码

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