Domain name for API request: vod.intl.tencentcloudapi.com.
Tencent Cloud Video on Demand (VOD) provides customers with services such as media upload, media management, and media processing. During the execution process or when execution ends, VOD also offers various event notifications to help developers monitor service processing status and proceed with next business operations.
Developers can use this interface to query the current configuration of event notification receiving method, recipient address and which events have enabled callback notification.
Default API request rate limit: 100 requests/second.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeEventConfig. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-17. |
| Region | No | String | Common Params. This parameter is not required. |
| SubAppId | No | Integer | On-demand application ID. Customers who activate on-demand services from December 25, 2023 must fill this field with the app ID when accessing resources in on-demand applications (whether default or newly created). |
| Parameter Name | Type | Description |
|---|---|---|
| Mode | String | Method of receiving event notifications. "PUSH" is normal callback, "PULL" is reliable callback. |
| NotificationUrl | String | Use the normal callback mode for domain names or IP addresses to receive V3 version event notifications. |
| UploadMediaCompleteEventSwitch | String | Whether to receive video upload complete event notification. "OFF" means the event notification is ignored, and "ON" means to receive event notifications. |
| DeleteMediaCompleteEventSwitch | String | Whether to receive video deletion completion event notification. "OFF" means the event notification is ignored, and "ON" means to receive event notifications. |
| PersistenceCompleteEventSwitch | String | Whether to receive event notifications for clip solidification completion. "OFF" means the event notification is ignored, "ON" means to receive event notifications. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
https://vod.intl.tencentcloudapi.com/?Action=DescribeEventConfig
&<Common request parameters>
{
"Response": {
"Mode": "PUSH",
"NotificationUrl": "http://mydemo.com/receiveevent",
"UploadMediaCompleteEventSwitch": "ON",
"DeleteMediaCompleteEventSwitch": "OFF",
"PersistenceCompleteEventSwitch": "OFF",
"RequestId": "27217d38-95c0-4335-8532-e5154ffb03aa"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation | Operation failed. |
| FailedOperation.InvalidVodUser | The VOD service is not activated. |
| InternalError | Internal error. |
| InvalidParameter | Parameter error. |
| UnauthorizedOperation | Unauthorized operation. |
文档反馈