如果你已创建应用,你可以查询指定 AppId 对应应用的相关信息。你可以使用 ListApps 这个 OpenAPI 实现这一功能。

接口行为

你可以调用 ListApps 这个 OpenAPI 获取当前账号已创建的 App 的相关信息:

调用接口

关于调用接口的服务地址、通信协议、字符编码和签名机制,参看调用 OpenAPI。

接口限制

QPS 不得超过 20。

请求方式

使用 POST 方式发起请求。

请求参数
Query
参数名类型必填示例值描述
ActionString是ListApps接口名称
VersionString是2020-12-01OpenAPI 版本
Body
参数名类型必填示例值描述
AppIdString否Your_AppId已创建的应用的 ID
ReverseInt32否1
  • 默认按照 App 创建时间升序返回;
  • 设置为 1 时,降序返回;
  • OffsetString否50
  • 偏移量,单位为条;
  • 因单次查询返回结果数量有限,如果需要大量查询,需要借助偏移量实现分页查询;
  • LimitString否100返回条目数的上限,默认为 50,最大为 100
    请求示例代码
    Query
    https://rtc.volcengineapi.com?Action=ListApps&Version=2020-12-01
    
    postscript
    Body
    {
        // 以下均为可选参数
        "AppId": "Your_AppId",
        "Reverse": "Your_Reverse",
        "Offset": "Your_Offset",
        "Limit": "Your_Limit"
    }
    
    json
    返回调用结果
    返回参数说明

    返回结果参看 BaseResponse。

    其中 Result 的结构如下:

    参数名类型描述
    TotalInt当前条件查询到的 App 数量
    OffsetInt偏移量,单位为条
    LimitInt返回条目数的限制
    ApplistArray of App见下表
    App
    参数名类型描述
    AppIdString应用 ID
    AppNameString应用名称
    CreatedAtString创建时间
    StatusInt
  • 服务状态。取值:
  • 0: 创建中——指 AppID 在初始化
  • 1: 运行中——指当前 AppID 为正常服务状态
  • 6: 欠费关停
  • 98: 已停用——指调用服务端停用接口,当前 AppID 被设置为不可用状态
  • AppKeyString主 AppKey,用于生成 Token
    SecondaryAppKeyString副 AppKey,启用后可用于生成 Token
    正常返回示例

    查询的指定 AppId 的信息在 Result 中显示。

    {
        "ResponseMetadata": {
            "RequestId": "2021081717484101022524310002120A9F",
            "Action": "ListApps",
            "Version": "2020-12-01",
            "Service": "rtc",
            "Region": "cn-north-1"
        },
        "Result": {
            "AppList": [
                {
                    "AppId": "600000000000000000000000",
                    "AppName": "myApp",
                    "CreateAt": "",
                    "Status": 1,
                    "AppKey": "a00000000000000000000000000000000",
                    "SecondaryAppKey": "b00000000000000000000000000000000",
                },
                {
                    ...
                }
            ],
            "Limit": "",
            "Offset": "",
            "Total": ""
        }
    }
    
    json