Adds a live stream encapsulation configuration.
Operation description
- The first time you configure encapsulation for a domain name, domain acceleration is automatically configured and takes effect in 3 to 5 minutes.
- If the streaming domain resides in a region outside China, including Singapore, Germany (Frankfurt), Japan (Tokyo), India (Mumbai) (shut down), and Indonesia (Jakarta), you may encounter high latency issues. We recommend that you test and verify whether the settings meet expectations.
- You can call this operation to add a live stream encapsulation configuration. The configuration takes effect only after you re-ingest the stream.
QPS limit
You can call this operation up to 300 times per minute per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limits.
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:AddLivePackageConfig | *Domain acs:cdn:*:{#accountId}:domain/{#DomainName} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| DomainName | string | Yes | The main streaming domain. | example.com |
| AppName | string | Yes | The application name. The value | AppName |
| StreamName | string | Yes | The stream name. The value | StreamName |
| Protocol | string | Yes | The streaming protocol and encapsulation format. Valid values:
| HLS_CMAF |
| SegmentNum | integer | No | The number of segments.
| 3 |
| SegmentDuration | integer | No | The segment length. Unit: seconds.
| 5 |
| PartDuration | integer | No | The part length. Unit: milliseconds.
| 350 |
| IgnoreTranscode | boolean | No | Specifies whether to ignore the transcoded stream. Valid values:
| true |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "05D00B48-DF50-5DC0-A07D-A250DFAE****"
}Error codes
| HTTP status code | Error code | Error message |
|---|---|---|
| 400 | MissingParam | %s |
| 400 | InvalidParams | %s |
| 400 | ConfigAlreadyExists | %s |
| 400 | InvalidProtocol | %s |
| 400 | InvalidSegmentNum | %s |
| 400 | InvalidSegmentDuration | %s |
| 400 | InvalidPartDuration | %s |
| 409 | ConfigConflicts | %s |
| 500 | InternalErr | %s |
| 500 | DomainConfigFailed | %s |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|