Domain name for API request: vod.intl.tencentcloudapi.com.
Tencent Cloud VOD provides media upload, media management, media processing, and other services. During or after the execution of these services, Tencent Cloud VOD also provides various event notifications, allowing developers to detect service processing status and perform next business operations.
Developers can use this API to query the current configuration of event notification receiving methods, recipient addresses, and which events have callback notification enabled.
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 | VOD application ID. For customers who activate VOD services after December 25, 2023, this field must be set to the app ID when accessing resources in VOD applications (whether the default application or a newly created application). |
| Parameter Name | Type | Description |
|---|---|---|
| Mode | String | Method of receiving event notifications. "PUSH" indicates normal callback (https://www.tencentcloud.com/document/product/266/33779?from_cn_redirect=1#.E6.99.AE.E9.80.9A.E5.9B.9E.E8.B0.83), and "PULL" indicates reliable callback (https://www.tencentcloud.com/document/product/266/33779?from_cn_redirect=1#.E5.8F.AF.E9.9D.A0.E5.9B.9E.E8.B0.83). |
| NotificationUrl | String | Use the normal callback mode for the address to receive V3 event notifications. |
| UploadMediaCompleteEventSwitch | String | Whether to receive video upload completed event notifications. "OFF" means the event notification is ignored, and "ON" means event notifications are received. |
| DeleteMediaCompleteEventSwitch | String | Whether to receive video deletion completed event notifications. "OFF" means the event notification is ignored, and "ON" means event notifications are received. |
| PersistenceCompleteEventSwitch | String | Whether to receive event notifications for clip solidification completion. "OFF" means the event notification is ignored, and "ON" means event notifications are received. |
| 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. |
文档反馈