最近更新时间:2023.10.23 16:15:05
首次发布时间:2023.09.25 14:37:16
删除指定的 Vhost
和 APP
下的某个指定类型的回调配置。
请求频率:单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DeleteCallback | 接口名称。当前 API 的名称为 DeleteCallback 。 |
Version | String | 是 | 2023-01-01 | 接口版本。当前 API 的版本为 2023-01-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Vhost | String | 否 | push.live.example.com | 域名空间名称。如创建回调 UpdateCallback 时传了参数 Vhost ,删除时需要传 Vhost 。 |
Domain | String | 否 | push.live.example.com | 推流域名。如创建回调 UpdateCallback 时传了参数 Domain ,删除时需要传 Domain 。 |
MessageType | String | 否 |
| 消息类型。缺省情况下表示删除所有消息类型。包括以下类型。
|
App | String | 否 | example_app | 应用名称。缺省情况下表示删除 Vhost 下的所有回调配置。如果入参选择 Domain ,则不可同时传 App 。 |
本接口无特有的返回参数。更多信息请见返回结构。
POST https://live.volcengineapi.com?Action=DeleteCallback&Version=2023-01-01 { "App": "example_app", "Domain": "", "MessageType": "push", "Vhost": "push.live.example.com" }
{ "ResponseMetadata": { "RequestId": "201806041104200100100232280022D30", "Action": "DeleteCallback", "Version": "2023-01-01", "Service": "live", "Region": "cn-north-1" } }
下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。
状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
200 | CommonErr | - | 未分类错误。建议重试,如果仍返回该错误码,请联系技术支持。 |
400 | InvalidParam | - | 输入的参数无效或不符合要求,请参照请求参数说明进行检查。 |
400 | InvalidParam.BindError | Request parameter error, please check input data | 参数未通过校验,请检查参数类型是否正确。 |
400 | InvalidParam.OutOfRange | %s should be one of {[%s]}%s should be between %d and %d | 参数超出允许范围,请检查错误消息中指定参数的取值是否超出取值范围。 |
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. | 内部服务超时,请联系技术支持。 |