Configures authentication for the callback for snapshots.
Operation description
Before you configure authentication for the callback for snapshots, you must specify a callback URL. For more information about how to specify a callback URL, see AddLiveAppSnapshotConfig .
You can call this operation to configure callback authentication for the snapshots from a main streaming domain. Make sure that the parameter settings are valid for calling this operation.
Limits on QPS
You can call this operation up to 30 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation. For more information, see QPS limit on an API operation in ApsaraVideo Live.
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:SetSnapshotCallbackAuth | update | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| DomainName | string | Yes | The main streaming domain. | example.aliyundoc.com |
| CallbackReqAuth | string | Yes | Specifies whether to enable callback authentication. Valid values:
| yes |
| CallbackAuthKey | string | Yes | The key that is used for callback authentication. | yourkey |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD5"
}Error codes
| HTTP status code | Error code | Error message |
|---|---|---|
| 400 | MissingParam | %s |
| 400 | MalformedParam | %s |
| 500 | InternalError | %s |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|