Build a Custom Scene Policy via API for Peak Traffic Control - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

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

esa:CreateCustomScenePolicy

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Name	string	Yes	The policy name.	test
Template	string	Yes	The template name. Valid value: promotion: a policy for major events.	promotion
StartTime	string	Yes	The policy start time. The time must be in UTC and in ISO 8601 format: `yyyy-MM-ddTHH:mm:ssZ`.	2021-11-07T17:00:00Z
EndTime	string	Yes	The policy end time. The time must be in UTC and in ISO 8601 format: `yyyy-MM-ddTHH:mm:ssZ`.	2021-11-07T18:00:00Z
Objects	string	No	The IDs of the sites to associate with the policy. Separate multiple site IDs with commas. Note This parameter is deprecated. Use `SiteIds` instead. If `SiteIds` is specified, the value of this parameter is ignored. To prevent ambiguity, specify a value for either `SiteIds` or `Objects`.	7096621098**,7096621099**
SiteIds	string	No	The IDs of the sites to associate with the policy. Separate multiple site IDs with commas.	7096621098**,7096621099**

Response elements

Element	Type	Description	Example
	object	The data returned.
RequestId	string	The request ID.	0AEDAF20-4DDF-4165-8750-47FF9C1929C9
Name	string	The policy name.	test
Template	string	The template name.	promotion
StartTime	string	The policy start time. The time must be in UTC and in ISO 8601 format: `yyyy-MM-ddTHH:mm:ssZ`.	2021-11-07T17:00:00Z
EndTime	string	The policy end time. The time must be in UTC and in ISO 8601 format: `yyyy-MM-ddTHH:mm:ssZ`.	2021-11-07T18:00:00Z
Objects	array	A list of associated site IDs. Note This field is deprecated. Read the value from the `SiteIds` field instead.
	string	The site ID.	7096621098****
PolicyId	integer	The policy ID.	1
SiteIds	string	The associated site IDs, separated by commas.	7096621098**, 7096621099**

Examples

Success response

JSON format

{
  "RequestId": "0AEDAF20-4DDF-4165-8750-47FF9C1929C9",
  "Name": "test",
  "Template": "promotion",
  "StartTime": "2021-11-07T17:00:00Z",
  "EndTime": "2021-11-07T18:00:00Z",
  "Objects": [
    "7096621098****"
  ],
  "PolicyId": 1,
  "SiteIds": "7096621098****, 7096621099****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The specified parameter is invalid.	The specified parameter is invalid.
400	PolicyNameExist	The policy name already exists.	Policy name already exists.
400	CreateTimeError	The effective time of the same policy template cannot overlap.	The effective time of the same policy template cannot overlap.
400	ScenePolicyQuotaExceedLimit	The maximum number of scenario policies has been reached. Each account can create up to 10 scenario policies.	The maximum number of scenario policies has been reached. Each account can create up to 10 scenario policies.
500	InternalError	Failed to call the service. Try again later or contact technical support.	Failed to call the service. Try again later or contact technical support.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.