调用 DescribeCallback 接口，查询已添加的回调配置。
请求频率：单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DescribeCallback | 接口名称。当前 API 的名称为 DescribeCallback。 |
| Version | String | 是 | 2023-01-01 | 接口版本。当前 API 的版本为 2023-01-01。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
Vhost | String | 否 |
| 域名空间，即直播流地址的域名所属的域名空间。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，查看需要查询的直播流使用的域名所属的域名空间。 说明
|
Domain | String | 否 |
| 直播流使用的推流域名，默认为空，表示查询所有当前域名空间（Vhost）下的在线流。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，查看直播流使用的域名。 说明
|
| App | String | 否 | Live | 应用名称，取值与直播流地址中 AppName 字段取值相同，默认为空，表示查询所有应用名称。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 30 个字符。 |
MessageType | String | 否 |
| 回调类型。默认为空，表示查询全部回调类型，取值及含义如下所示。
|
下表仅列出本接口特有的返回参数。更多信息请见返回结构。
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| CallbackList | Array of CallbackList | - | 回调列表。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| App | String | push.example.com | 应用名称。 |
| AuthKeyPrimary | String | 1622194197-0-0-5552*****e4e20387c6dc18afce**** | 回调消息发送鉴权密钥，开启回调消息鉴权时生效。 |
| CallbackDetailList | Array of CallbackDetailList | - | 回调数据列表。 |
MessageType | String |
| 回调的消息类型，取值及含义如下所示。
|
TranscodeCallback | Integer |
| 是否开启转码流回调，默认为 0。取值及含义如下所示。
|
| Vhost | String | push.example.com | 域名空间。 |
| CreateTime | String | 2021-01-02 23:04:05 | 回调配置创建时间。 |
AuthEnable | Boolean |
| 回调消息发送是否开启鉴权，默认为
|
| CreateTimeUTC | String | 2021-01-02T15:04:05Z | 回调配置创建时间，格式为 RFC3339 的 UTC 时间，精度为秒。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| CallbackType | String | http | 回调类型，返回 HTTP，表示可以使用 HTTP 和 HTTPS 地址接收回调消息。 |
| URL | String | http://example.com/callback | 回调消息接收地址。 |
POST https://live.volcengineapi.com?Action=DescribeCallback&Version=2023-01-01
{
"Vhost": "push.example.com"
}
{
"ResponseMetadata": {
"RequestID": "202108291443190102121532040E197F15",
"Action": "DescribeCallback",
"Version": "2023-01-01",
"Service": "live",
"Region": "cn-north-1"
},
"Result": {
"CallbackList": [
{
"App": "live",
"AuthEnable": false,
"AuthKeyPrimary": "",
"CallbackDetailList": [
{
"CallbackType": "http",
"URL": "http://example.com/callback"
}
],
"CreateTime": "2021-01-02 23:04:05",
"CreateTimeUTC": "2021-01-02T15:04:05Z",
"Domain": "",
"MessageType": "push",
"TranscodeCallback": 0,
"Vhost": "push.example.com"
}
]
}
}
下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。
| 状态码 | 错误码 | 错误信息 | 说明 |
|---|---|---|---|
| 200 | CommonErr | - | 未分类错误。建议重试，如果仍返回该错误码，请联系技术支持。 |
| 400 | InvalidParam | - | 输入的参数无效或不符合要求，请参照请求参数说明进行检查。 |
| 400 | InvalidParam.BindError | Request parameter error, please check input data | 参数未通过校验，请检查参数类型是否正确。 |
| 403 | RequestForbidden | - | 请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。 |
| 403 | RequestForbidden.AccountIDNotAllow | this AccountID does not have permission to access the corresponding resource, please check the request parameters | 请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。 |
| 403 | RequestForbidden.BillingStatus | Billing status is not available for the AccountID, please activate the service or recharge. | 未开通视频直播服务或账号欠费，造成账单不可用，请检查服务开通情况和账号欠费情况。 |
| 404 | ResourceNotFound | - | 未找到资源（域名空间、域名、应用、配置模版、证书）。建议重试，如果仍返回该错误码，请联系技术支持。 |
| 404 | ResourceNotFound.VhostNotExist | vhost not found | 未找到域名空间（Vhost）。请检查传入的域名空间是否与实际使用的域名空间一致。 |
| 500 | InternalError | an internal error occurred, please contact the administrator. | 出现内部错误，请联系技术支持。 |
| 500 | InternalError.DB | an internal error related to database occurred, please contact the administrator. | 出现与数据库相关的内部错误，请联系技术支持。 |
| 502 | InternalServiceError | an internal error occurred, please contact the administrator. | 服务间出现错误，请联系技术支持。 |
| 502 | InternalServiceError.BadResponse | an internal error occurred, please contact the administrator. | 服务间出现错误，请联系技术支持。 |
| 504 | InternalServiceTimeout | Internal Service is timeout. please contact the administrator. | 内部服务超时，请联系技术支持。 |
视频直播提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。