更新时间:2022-03-23 GMT+08:00
分享

查询App列表

功能介绍

本接口用于查询APP列表。

调试

您可以在API Explorer中调试该接口。

URI

GET /v2/{project_id}/apps

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

单次请求返回APP列表的最大数量。

取值范围:1~100。

默认值:10

最小值:1

最大值:100

缺省值:10

start_app_name

String

从该app名称开始返回app列表,返回的app列表不包括此app名称。

stream_name

String

返回该通道下的app列表。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

has_more_app

Boolean

是否还有更多满足条件的App。

  • true:是。

  • false:否。

apps

Array of DescribeAppResult objects

AppEntry list that meets the current request.

total_number

Integer

满足条件的App总数。

表5 DescribeAppResult

参数

参数类型

描述

app_name

String

App的名称。

app_id

String

App的唯一标识符。

create_time

Long

App创建的时间,单位毫秒。

commit_checkpoint_stream_names

Array of strings

关联通道列表。

请求示例

查询App列表

GET https://{Endpoint}/v2/{project_id}/apps

响应示例

状态码: 200

正常返回

{
  "total_number" : 1,
  "apps" : [ {
    "app_id" : "bd6IPpvgiIflQPMpi9M",
    "app_name" : "newstream",
    "create_time" : 1593569685875
  } ],
  "has_more_app" : true
}

状态码

状态码

描述

200

正常返回

400

Invalid Parameters

404

Application not found

500

Internal Server Error

错误码

请参见错误码

分享:

    相关文档

    相关产品

close