SetProxyPattern - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

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

pvtz:SetProxyPattern

update

*Zone

acs:pvtz::{#accountId}:zone/{#ZoneId}

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the response. Valid values: zh: Chinese. en: English. Default value: en	en
ZoneId	string	Yes	The unique ID of the zone.	df2d03865266bd9842306db586d3****
ProxyPattern	string	Yes	The proxy mode for recursive resolution of subdomains. Valid values: ZONE: Disables the proxy. If a subdomain does not exist, an NXDOMAIN response is returned. RECORD: Enables the proxy. If a subdomain does not exist, the system queries the forwarding and recursion modules and returns the final result.	ZONE
UserClientIp	string	No	The IP address of the client.	10.61.XX.XX
ClientToken	string	No	A client token to ensure the idempotence of the request. The token must be unique for each request. It can contain only ASCII characters and must be no more than 64 characters in length.	21079fa016944979537637959d09bc

Response elements

Element	Type	Description	Example
	object
ZoneId	string	The global ID of the zone.	df2d03865266bd9842306db586d3****
RequestId	string	The unique ID of the request.	0417DC19-11A0-5597-8717-2F705DE88925

Examples

Success response

JSON format

{
  "ZoneId": "df2d03865266bd9842306db586d3****\n",
  "RequestId": "0417DC19-11A0-5597-8717-2F705DE88925"
}

Error codes

HTTP status code	Error code	Error message	Description
400	Zone.Remark	50 characters long. It can only contain numbers,Chinese,English and special characters: _ - , . ，。

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.