如果你已创建业务标识,你可以查询指定 AppID 下所有业务标识的相关信息。你可以使用 GetAllBusinessID 这个 OpenAPI 实现这一功能。

接口行为

你可以调用GetAllBusinessID 这个 OpenAPI 获取指定 AppId 下所有业务标识的相关信息。

调用接口

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

接口限制

QPS 不超过 20。

请求方式

使用 POST 方式发起请求。

请求参数
Query
参数名类型必填示例值描述
ActionString是GetAllBusinessID接口名称,本接口取值:GetAllBusinessID
VersionString是2020-12-01接口版本,本接口取值:2020-12-01
Body
参数名类型必填示例值描述
AppIdstring是Your_AppId应用的唯一标识
Limitstring否50返回的业务标识上限。最大值为100,默认值为100。
Offsetstring否100偏移量,单位为条,默认值为0。
请求示例代码
Query
https://rtc.volcengineapi.com?Action=GetAllBusinessID&Version=2020-12-01
postscript
Body
{
    "AppID": "Your_AppID",
    "Offset": "Your_Offset",
    "Limit": "Your_Limit"
}
json
返回调用结果
返回参数说明

返回结果参看 BaseResponse。

其中 Result 的结构如下:

参数名类型描述
BusinessRecordsBusinessRecords业务标识相关信息

BusinessRecords

参数名类型示例值描述
AppIdstringYour_AppId应用的唯一标识
BusinessIdstringYour_BusinessId业务 ID
RemarksstringYour_Remarks业务名称
CreatedTimestring2022-09-15T15:16:37+08:00该业务标识创建时间戳,格式为 RFC3339,单位为秒

其中 TotalSize 的结构如下:

参数名类型描述
TotalSizeInt该 AppId 下业务标识总数
正常返回示例
{
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "GetAllBusinessID",
        "Version": "2020-12-01",
        "Service": "rtc",
        "Region": "cn-north-01"
    },
    "Result": {
        "BusinessRecords": {
            "AppId": "Your_AppId",
            "BusinessId": "Your_BusinessId",
            "Remarks": "Your_Remarks",
            "CreatedTime": "2022-09-15T15:16:37+08:00"
        },
        "TotalSize": 1
    }
}
json