DescribeCustomScenePolicies - Edge Security Acceleration

Queries the configurations of a scenario-specific policy.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
esa:DescribeCustomScenePolicies	get	All Resources ``	none	none

Request parameters

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

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	85H66C7B-671A-4297-9187-2C4477247A74
TotalCount	integer	The total number of entries returned.	1
Quota	integer	The policy quota.	10
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
DataModule	array<object>	The scenario-specific policies.
Item	object	The information about the scenario-specific policy.
Name	string	The name of the scenario-specific policy.	test
Template	string	The name of the policy template. Valid value: promotion: major events.	promotion
StartTime	string	The time when the policy takes effect. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2023-03-04T16:00:00Z
EndTime	string	The time when the policy expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2023-03-06T16:00:00Z
Status	string	The status of the policy. Valid values: Disabled Pending Running Expired	Expired
Objects	array	The IDs of websites that are associated with the policy.
object	string	The ID of the website that is associated with the policy.	123456****
PolicyId	long	The policy ID.	1234****

Examples

Sample success responses

JSONformat

{
  "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
    }
  ]
}

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.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2025-02-19	The Error code has changed	View Change Details