ListStreamingDataServices - Query All Real-time Data Services

Create External Data Source Configuration.

调试

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

授权信息

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

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

请求参数

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

Region ID

cn-beijing
DBInstanceIdstring

Instance ID.

gp-bp10g78o9807yv9h3
PageNumberinteger

Page number, greater than 0 and not exceeding the maximum value of Integer, default value: 1.

1
PageSizeinteger

Number of records per page, with the following values:

  • 30 (default)
  • 50
  • 100
50

返回参数

名称类型描述示例值
object
RequestIdstring

Request ID.

B4CAF581-2AC7-41AD-8940-D56DF7AADF5B
ServiceItemsarray<object>

Returns real-time data service items

itemsobject
ServiceIdstring

Service ID.

1
ServiceTypestring

Service type, with the following value:

  • adbpgss
adbpgss
ServiceNamestring

Service name.

test-adbpgss
ServiceDescriptionstring

Service description.

test-adbpgss
ServiceSpecstring

Service specification (in CU).

8
Statusstring

Service status, with the following values:

  • Init: Initializing

  • Running: In operation

  • Exception: Abnormal

  • Paused: Suspended

Running
ServiceIpstring

Service IP.

192.168.0.1
ServicePortstring

Service port.

5432
CreateTimestring

Creation time.

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

Last modified time

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

Whether it is a managed service.

true
ServiceOwnerIdstring

Service owner ID.

123
TotalRecordCountinteger

Total record count.

1

示例

正常返回示例

JSON格式

{
  "RequestId": "B4CAF581-2AC7-41AD-8940-D56DF7AADF5B",
  "ServiceItems": [
    {
      "ServiceId": "1",
      "ServiceType": "adbpgss",
      "ServiceName": "test-adbpgss",
      "ServiceDescription": "test-adbpgss",
      "ServiceSpec": "8",
      "Status": "Running",
      "ServiceIp": "192.168.0.1",
      "ServicePort": "5432",
      "CreateTime": "2019-09-08T16:00:00Z",
      "ModifyTime": "2019-09-08T17:00:00Z",
      "ServiceManaged": true,
      "ServiceOwnerId": "123"
    }
  ],
  "TotalRecordCount": 1
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-06-27OpenAPI 返回结构发生变更查看变更详情