All Products
Search
Document Center

ApsaraVideo Live:AddLiveSnapshotNotifyConfig

更新時間:Nov 21, 2024

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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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 Resources is 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.
OperationAccess levelResource typeCondition keyAssociated operation
live:AddLiveSnapshotNotifyConfigcreate
*Domain
acs:cdn:*:{#accountId}:domain/{#DomainName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringYes

The main streaming domain.

www.yourdomain***.com
NotifyUrlstringYes

The callback URL. Specify a valid URL that is up to 500 characters in length.

http://callback.yourdomain***.com
NotifyReqAuthstringNo

Specifies whether to enable callback authentication. Valid values:

  • yes
  • no (default)
Note This parameter is required if you set the NotifyAuthKey parameter to yes.
yes
NotifyAuthKeystringNo

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

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

16A96B9A-F203-4EC5-8E43-CB92E68F****

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError message
400MissingParam%s
400MalformedParam%s
409ConfigAlreadyExists%s
500InternalError%s

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-03-14The Error code has changedView Change Details