SetCdnDomainStagingConfig - CDN - Alibaba Cloud Documentation Center

You can call SetCdnDomainStagingConfig to configure an accelerated domain name in the staging environment.

Operation description

Note

A single user can make up to 30 calls per second.

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

cdn:SetCdnDomainStagingConfig

update

*Domain

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

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The accelerated domain name. Only one domain name can be configured at a time.	example.com
Functions	string	Yes	The list of features. The format is as follows: Note functionName (the feature name): For information about the features that you can configure, see Feature list. Separate multiple parameters with commas (,). argName: a configuration item for functionName. You can specify multiple configuration items. argValue: the value of the configuration item for functionName. `[ { "functionArgs": [ { "argName": "Feature parameter A", "argValue": "Value of feature parameter A" }, { "argName": "Feature parameter B", "argValue": "Value of feature parameter B" } ], "functionName": "Feature name" } ]`	[{"functionArgs":[{"argName":"enable","argValue":"on"},{"argName":"pri","argValue":"1"},{"argName":"rule","argValue":"xxx"}],"functionName":"edge_function"}]

Description of the edge_function feature

All parameter values are processed as strings.

Feature name

Parameters

edge_function: edge function

Required parameters:
rule: the DSL rule.
pri: the priority.
enable: specifies whether to enable the rule. Valid values: on and off.
Optional parameters:
name: the name of the rule. Only letters and underscores (_) are supported.
pos: the position where the rule is executed.
brk: If this rule is hit, the remaining rules at the current execution position are skipped.
option: option control.
grammar: grammar control. Valid values: empty, es2, and js.
jsmode: 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
DomainConfigList	array<object>	The list of domain name configurations.
	object
ConfigId	integer	The configuration ID.	1234567
DomainName	string	The domain name.	www.example.com
FunctionName	string	The feature name.	set_resp_header

Examples

Success response

JSON format

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "DomainConfigList": [
    {
      "ConfigId": 1234567,
      "DomainName": "www.example.com",
      "FunctionName": "set_resp_header"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidFunctionName.ValueNotSupported	%s
400	InvalidArgValue.Malformed	%s
400	ConfigurationConflicts	The staging environment has a configuration in effect and cannot modify the production environment configuration.	Failed to modify the parameter settings in the production environment because the parameter settings are different from those in the stating environment. Set parameters in the staging environment before you publish them to the production environment.
400	InvalidArgName.ValueNotSupported	%s
400	GrayConfigExist	The domain exists other gray config.	The staging environment already contains settings for the domain name.
400	InvalidRule.Malformed	%s
400	InvalidDomain.BelongToConfigGroup	This Domain activated in configuration group and should modify by config group.
400	EdgeScriptCountExceedLimit	The number of rules exceeds the default limit.	The number of rules exceeds the limit. To increase the limit, submit a ticket.
400	EdgeScripOptionsHasInnerConfig	The extension has a background configuration or a parameter of this configuration is invalid. For more information, submit a ticket.	The extension has a background configuration or a configured parameter is invalid. For more information, submit a ticket.
400	EdgeScriptGrammarNotSupport	A background customization rule exists or a parameter of this configuration is invalid. For more information, submit a ticket.	A background custom rule exists or a configured parameter is invalid. For more information, submit a ticket.
400	EdgeScriptNotSupportJs	JavaScript rules are not supported. For more information, submit a ticket.	JavaScript rules are not supported. For more information, submit a ticket.
400	MissingRequiredArg	required argument missing.	When configuring the function, the necessary parameters are missing.
400	FunctionArgError	The function parameter of the domain configuration is incorrect.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.