SetSnapshotCallbackAuth - ApsaraVideo Live - Alibaba Cloud Documentation Center

Operation description

Before calling this API, configure a callback URL first. For more information, see AddLiveAppSnapshotConfig.
The snapshot service supports adding a signature header to HTTP or HTTPS callback requests. This allows the receiving server to authenticate the signature and prevent unauthorized or invalid requests. For more information, see Usage notes for callback authentication.

QPS limits

You can call this operation up to 30 times per second per account. Requests that exceed this limit are dropped and you may experience service interruptions.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

live:SetSnapshotCallbackAuth

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
DomainName	string	Yes	The main streaming domain.	example.aliyundoc.com
CallbackReqAuth	string	Yes	Specifies whether to enable callback authentication. Valid values: yes: enables no: disables	yes
CallbackAuthKey	string	Yes	The authentication key.	yourkey

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	16A96B9A-F203-4EC5-8E43-CB92E68F4CD5

Examples

Success response

JSON format

{
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD5"
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParam	%s, please check and try again later.	Parameter is missing, please check and try again.
400	MalformedParam	%s, please check and try again later.	Invalid parameter, please check and try again.
500	InternalError	%s.	error on the live liveapi server.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.