BindZoneVpc - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Binds a zone to or unbinds a zone from one or more VPCs. This operation defines the scope in which the zone is effective.

Operation description

Notes:

You should set the scope for a domain name only after you configure all its DNS records. If you set the scope when you create the domain name, DNS resolution for that domain name will fail within the specified scope until you add DNS records. This does not apply if the recursive resolution proxy for subdomains is enabled.

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

none

*Zone

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

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the return value. Valid values: zh: Chinese. en: English. Default value: en	en
ZoneId	string	Yes	The unique ID of the zone.	34d4031b63c527358b710a61346a****
UserClientIp	string	No	The IP address of the client.	127.0.XX.XX
Vpcs	array<object>	No	The list of VPCs. Note If you leave this parameter empty, all VPCs are unbound from the zone.
	object	No	Information about the associated VPC.
VpcId	string	No	The ID of the VPC. If a zone is already bound to a VPC, the VPC is unbound from the zone if you do not specify this parameter.	vpc-f8zvrvr1payllgz38****
RegionId	string	No	The ID of the region where the VPC is located.	cn-beijing
VpcType	string	No	The type of the VPC. Valid values: STANDARD: a standard VPC. EDS: an Elastic Desktop Service (EDS) workspace VPC.	STANDARD
ClientToken	string	No	A client token to ensure the idempotence of the request. Generate a unique value on your client for this parameter. The token can contain only ASCII characters and cannot be more than 64 characters long.	6447728c8578e66aacf062d2df4446dc

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	46973D4C-E3E4-4ABA-9190-9A9DE406C7E

Examples

Success response

JSON format

{
  "RequestId": "46973D4C-E3E4-4ABA-9190-9A9DE406C7E"
}

Error codes

HTTP status code	Error code	Error message	Description
400	ZoneVpc.Zone.Repeated	Vpc is bind to same zone name.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.