Configures snapshot callbacks.
Operation description
QPS Limit
The QPS limit for this API per user is 30 times/second. Exceeding this limit will result in API calls being throttled, which may impact your business operations. Please use the API reasonably. For more information, please refer to QPS Limitation.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| live:AddLiveSnapshotNotifyConfig | create | *Domain acs:cdn:*:{#accountId}:domain/{#DomainName} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| DomainName | string | Yes | The main streaming domain. | www.yourdomain***.com |
| NotifyUrl | string | Yes | The callback URL. Specify a valid URL that is up to 500 characters in length. | http://callback.yourdomain***.com |
| NotifyReqAuth | string | No | Specifies whether to enable callback authentication. Valid values:
Note
This parameter is required if you set the NotifyAuthKey parameter to yes.
| yes |
| NotifyAuthKey | string | No | The callback authentication key. The key must be 16 to 32 characters in length and can contain only letters and digits. Note
This parameter is required if you set the NotifyReqAuth parameter to yes.
| yourkey |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F****"
}Error codes
| HTTP status code | Error code | Error message |
|---|---|---|
| 400 | MissingParam | %s |
| 400 | MalformedParam | %s |
| 409 | ConfigAlreadyExists | %s |
| 500 | InternalError | %s |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2023-03-14 | The Error code has changed | View Change Details |