Block and Unblock URLs via BlockObject API - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

Blocks access to a specified URL.

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

create

*Site

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

None

Request parameters

Parameter	Type	Required	Description	Example
SiteId	integer	Yes	The site ID, which can be obtained by calling the ListSites operation.	123456****
Type	string	Yes	The type. Valid values: block: Block. unblock: Unblock. Valid values: unblock : Unblock. block : Block.	block
Content	array	Yes	The content to block.
	string	No	The URL. Important The hostname in the URL must be a DNS record name (the RecordName field, which supports wildcard records) returned by ListRecords(SiteId). Using an unconfigured hostname returns InvalidParameter.RecordNotBelongToSite(400). Call ListRecords first to obtain the RecordName, and then use the RecordName as the hostname to construct the URL.	http://a.com/1.jpg
Maxage	integer	No	The effective period of the block, in seconds. Specify this parameter when the type is block.	864000

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	0AEDAF20-4DDF-4165-8750-47FF9C1929C9
TaskId	string	The task ID. This ID is returned when you create a block task.	15940956620

Examples

Success response

JSON format

{
  "RequestId": "0AEDAF20-4DDF-4165-8750-47FF9C1929C9",
  "TaskId": "15940956620"
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingTimeParameter	The StartTime and EndTime must be both specified.	Please provide both a start time and an end time.
400	InvalidEndTime.Mismatch	The specified EndTime is earlier than the StartTime.	The end time you entered is earlier than the start time. Please check and try again.
400	DomainNameOverLimit	A maximum of 500 domains are supported for each request.	Only 500 domain names are supported at a time. Please reduce the number of domain names to request again.
400	InvalidTime	The query time cannot exceed the last 3 days.	The query time cannot exceed the last 3 days.
400	MissingParameter.ObjectType	The ObjectType parameter is required if DomainName or ObjectType is specified.	Specify the ObjectType parameter.
400	InvalidStationParameter	The specified Station is invalid.	The specified node parameter is invalid.
400	TooManyRequests	Too many requests.Please try again later.	Requests are too frequent, please try again later.
400	InvalidTaskId.Malformed	The specified taskId is invalid.	The specified task ID is invalid.
400	InvalidParameters.InvalidUrls	The specified urls are invalid.	The requested URL parameter is invalid.
400	InvalidParameters	The specified parameters are invalid.	Parameter is illegal.
400	InvalidParameter.RecordNotBelongToSite	The record name passed in does not belong to the current site.	The record name passed in does not belong to the current site.
400	InvalidParameter.RecordNotProxied	The proxy is not turned on for the record name passed in.	The proxy is not turned on for the incoming record.
400	InvalidParameter.SiteNotActivated	The site passed in is not activated.	The incoming site is not activated.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.