SetLiveDomainStagingConfig - ApsaraVideo Live - Alibaba Cloud Documentation Center

Operation description

Usage notes

Obtain an accelerated domain name. You can then call this operation to set or modify domain name configurations in the staging environment. For more information, see Functions format description.

QPS limit

This operation is limited to 30 queries per second (QPS) per user. API calls that exceed this limit are throttled, which may affect your business. For more information, see QPS limits.

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

update

*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 accelerated domain name.	developer.aliyundoc.com
Functions	string	Yes	The list of features. Specify ConfigId only when you modify a configuration. For more information, see Functions format description.	[{"functionArgs":[{"argName":"enable","argValue":"on"},{"argName":"pri","argValue":"1"},{"argName":"rule","argValue":"xxx"}],"functionName":"edge_function"}]

Function format description

To set a configuration, see the following example: [{"functionArgs":[{"argName":"enable","argValue":"on"},{"argName":"pri","argValue":"1"},{"argName":"rule","argValue":"xxx"}],"functionName":"edge_function"}]
To modify a configuration, specify the configuration item using the ConfigId parameter, which is of the Long data type. See the following example: [{"functionArgs":[{"argName":"enable","argValue":"on"},{"argName":"pri","argValue":"1"},{"argName":"rule","argValue":"yyy"}],"ConfigId":123456,"functionName":"edge_function"}]

Note: All parameter values are strings.

Feature name	Required parameters	Optional parameters
edge_function: The Edge Routine.	- rule: The DSL rule. - pri: The priority. - enable: Specifies whether the rule is enabled. Valid values: on and off.	- name: The rule name. - pos: The position where the rule is executed. - brk: Specifies whether to skip the remaining rules at the current execution position after the current rule is hit. - option: The option control. - grammar: The grammar control. Valid values: empty, es2, and js. - jsmode: The JavaScript domain name whitelist control. Valid values: redirect and bypass.

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368

Examples

Success response

JSON format

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}

Error codes

HTTP status code	Error code	Error message
400	InvalidFunctionName.ValueNotSupported	%s
400	InvalidArgName.ValueNotSupported	%s
400	InvalidArgValue.Malformed	%s
400	InvalidRule.Malformed	%s
400	ConfigurationConflicts	The staging environment has a configuration in effect. You cannot modify the production environment configuration.
400	InvalidDomain.BelongToConfigGroup	The domain is bound to a configuration group. Modify the domain in the configuration group.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.