CreateLivePrivateLine - ApsaraVideo Live - Alibaba Cloud Documentation Center

Creates a Global Accelerator (GA) instance and binds it to an acceleration circuit.

Operation description

You can call this operation to create a Global Accelerator instance and attach it to a live stream channel. You must specify the start and end points of the acceleration at the stream level.
The template takes effect only if the AppName and StreamName match the corresponding names in the streaming URL.

QPS limits

The queries per second (QPS) limit for this operation is 50 per user. Calls that exceed this limit are throttled, which can affect your business. We recommend that you call this operation within this limit.

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:CreateLivePrivateLine

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
DomainName	string	Yes	The streaming domain.	demo.aliyundoc.com
AppName	string	Yes	The application name.	live
StreamName	string	Yes	The stream name.	testStream
VideoCenter	string	Yes	The live center. Valid values are cn-beijing, cn-shanghai, cn-shenzhen, cn-qingdao, ap-northeast-1, ap-southeast-5, eu-central-1, ap-southeast-1, and ap-south-1. These values represent the live centers located in Beijing, Shanghai, Shenzhen, Qingdao, Japan, Indonesia, Germany, and Singapore.	cn-shanghai
AccelerationType	string	Yes	The acceleration type. Valid values: play: streaming acceleration. publish: stream ingest acceleration.	play
AccelerationArea	string	Yes	The acceleration area.	ap-southeast-1
Reuse	string	Yes	Specifies whether to reuse an existing acceleration instance. Valid values: yes: Reuse an existing acceleration instance. no: Create a new acceleration instance.	no
MaxBandwidth	string	No	The maximum bandwidth for acceleration. Unit: Mbps. This parameter is required if you set Reuse to no.	200
InstanceId	string	No	The ID of the acceleration instance that you want to reuse. This parameter is required if you set Reuse to yes.	ga-bp1iovsdpf01ym9su****

Response parameters

Parameter	Type	Description	Example
	object	The returned data.
RequestId	string	The request ID.	7908F2FF-44F8-120F-9FD6-85AE4B6C****

Examples

Success response

JSON format

{
  "RequestId": "7908F2FF-44F8-120F-9FD6-85AE4B6C****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParam	Parameter invalid.	Illegal input parameters
400	NoSpecialConfiguration	no special configuration for acceleration_area.
400	ConfigAlreadyExists	Config has already exist.
400	HasNoPermission	You do not have permission to create accelerator.
400	PostPayNotOpen	The Accelerator PostPay service is not open.
400	TryAgain	Create SLR first and please try again.
400	HasNoPermisionToCreateSLR	You do not have ram:CreateServiceLinkedRole to create SLR.
500	InternalError	The request processing has failed due to backend service exception.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.