DescribeCustomScenePolicies API Overview - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

Retrieves the configurations of custom scene policies.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageSize	integer	No	The number of entries per page. Default value: 10. Valid values: 5, 10, and 20.	10
PageNumber	integer	No	The page number. Valid values: 1 to 100000.	1
PolicyId	integer	No	The policy ID.	1234****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	85H66C7B-671A-4297-9187-2C4477247A74
TotalCount	integer	The total number of entries.	1
Quota	integer	The maximum number of policies that you can create.	10
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries on the current page.	10
DataModule	array<object>	The configurations of custom scene policies.
	object	A custom scene policy configuration.
Name	string	The name of the custom scene policy.	test
Template	string	The template name. Valid value: promotion: A major event.	promotion
StartTime	string	The start time of the policy. The time is specified in UTC, in the yyyy-MM-ddTHH:mm:ssZ format.	2023-03-04T16:00:00Z
EndTime	string	The end time of the policy. The time is specified in UTC, in the yyyy-MM-ddTHH:mm:ssZ format.	2023-03-06T16:00:00Z
Status	string	The effective status of the policy. Valid values: disabled: The policy is disabled. pending: The policy is waiting to take effect. running: The policy is in effect. expired: The policy has expired.	Expired
Objects	array	A list of associated site IDs. Note This field is deprecated. We recommend that you use the `SiteIds` field instead.
	string	A site ID associated with the policy.	123456****
PolicyId	integer	The policy ID.	1234****
SiteIds	string	A comma-separated list of site IDs associated with the policy.	123456**,123457**

Examples

Success response

JSON format

{
  "RequestId": "85H66C7B-671A-4297-9187-2C4477247A74",
  "TotalCount": 1,
  "Quota": 10,
  "PageNumber": 1,
  "PageSize": 10,
  "DataModule": [
    {
      "Name": "test",
      "Template": "promotion",
      "StartTime": "2023-03-04T16:00:00Z",
      "EndTime": "2023-03-06T16:00:00Z\n",
      "Status": "Expired",
      "Objects": [
        "123456****"
      ],
      "PolicyId": 0,
      "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.
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.