UpdateCustomScenePolicy - Update custom scene policy - 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:UpdateCustomScenePolicy

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Name	string	Yes	The name of the policy.	test
Template	string	Yes	The template name. Valid value: promotion: major promotion	promotion
StartTime	string	Yes	The start time of the policy. Specify the time in the ISO 8601 format: yyyy-MM-ddTHH:mm:ssZ (UTC).	2023-04-03T16:00:00Z
EndTime	string	Yes	The end time of the policy. Specify the time in the ISO 8601 format: yyyy-MM-ddTHH:mm:ssZ (UTC).	2023-04-03T19:00:00Z
Objects	string	No	Site IDs to associate with the policy, separated by commas. Note Deprecated. Use `SiteIds` instead. If `SiteIds` is specified, `Objects` is ignored. You must specify either `Objects` or `SiteIds`.	123456**,123457**
PolicyId	integer	Yes	The policy ID. You can call the DescribeCustomScenePolicies operation to obtain it.	1
SiteIds	string	No	Site IDs to associate with the policy, separated by commas.	123456**,123457**

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368
Name	string	The name of the policy.	test
Template	string	The template name. Valid value: promotion: major promotion	promotion
StartTime	string	The start time of the policy. The time is in the ISO 8601 format: yyyy-MM-ddTHH:mm:ssZ (UTC).	2023-04-03T16:00:00Z
EndTime	string	The end time of the policy. The time is in the ISO 8601 format: yyyy-MM-ddTHH:mm:ssZ (UTC).	2023-04-03T19:00:00Z
Objects	array	The associated site IDs. Note Deprecated. Use `SiteIds` instead.
	string	A site ID.	123456****
PolicyId	integer	The ID of the policy.	1
SiteIds	string	The associated site IDs, separated by commas.	123456**,123457**

Examples

Success response

JSON format

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "Name": "test",
  "Template": "promotion",
  "StartTime": "2023-04-03T16:00:00Z\n",
  "EndTime": "2023-04-03T19:00:00Z\n",
  "Objects": [
    "123456****"
  ],
  "PolicyId": 1,
  "SiteIds": "123456****,123457****\n"
}

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	PolicyNotExist	The policy does not exist.	The policy does not exist.
400	InvalidParameter.ObjectsAndSiteIds	The specified Objects and SiteIds variables cannot both be empty strings.	The specified Objects and SiteIds variables cannot both be empty strings.
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.