# Alibaba Cloud Cloud DNS PrivateZone API

> Alibaba Cloud Cloud DNS PrivateZone API on Apizie: 58 endpoints (Creates a custom line, Creates an outbound endpoint, Creates a forwarding rule, Adds cross-account VPC authorization, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-pvtz`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/pvtz
- Page: https://zieapi.vercel.app/api/cloud/aliyun-pvtz
- OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-pvtz/openapi.json

Alibaba Cloud OpenAPI for Cloud DNS PrivateZone (pvtz, version 2018-01-01). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Creates a custom line
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/add-custom-line` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| Lang | string | no | The language |
| Name | string | yes | The name of the custom line |
| ShareScope | string | no | This parameter is not available to users. You do not need to specify this parameter |
| DnsCategory | string | no | This parameter is not available to users. You do not need to specify this parameter |
| Ipv4s | string | yes | The list of IPv4 CIDR blocks (JSON-encoded) |

### Creates an outbound endpoint
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/add-resolver-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| Name | string | yes | The name of the endpoint. The name can be up to 20 characters in length. An error is returned if the limit is exceeded |
| VpcRegionId | string | yes | The region ID of the outbound VPC |
| VpcId | string | yes | The ID of the outbound virtual private cloud (VPC). All outbound DNS query traffic from the Resolver is forwarded through this VPC. To… |
| SecurityGroupId | string | yes | The ID of the security group. The rules in the security group are applied to the outbound VPC. To prevent service interruptions caused by… |
| IpConfig | string | yes | The list of source IP addresses for outbound traffic. You must add at least 2 and at most 6 IP addresses. To ensure high availability, an… |
| Lang | string | no | The language of the response. Valid values: zh: Chinese. en: English. Default value: en |

### Creates a forwarding rule
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/add-resolver-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| Name | string | no | The name of the forwarding rule. Specify a name based on your business requirements and the purpose of the rule |
| Type | string | no | The type of the forwarding rule. Valid values: OUTBOUND: forwards DNS queries to external IP addresses. This is the only supported value.… |
| ZoneName | string | yes | The domain name (zone) for which you want to forward DNS resolution requests. You cannot change this value after the forwarding rule is… |
| EndpointId | string | no | The ID of the outbound endpoint. The outbound endpoint is used to forward DNS query traffic to the IP addresses specified in the… |
| ForwardIp | string | yes | The IP addresses and ports of the external DNS system. These are the IP addresses and ports of the destination servers to which DNS query… |
| Lang | string | no | The language of the response. Valid values: zh: Chinese. en: English. Default value: en |
| Vpcs | string | no | The Vpcs (JSON-encoded) |
| EdgeDnsClusters | string | no | The EdgeDnsClusters (JSON-encoded) |

### Adds cross-account VPC authorization
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/add-user-vpc-authorization` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| AuthorizedUserId | integer | yes | The ID of the Alibaba Cloud account that owns the authorized resource. Cross-account authorization only supports Alibaba Cloud accounts… |
| AuthCode | string | no | The verification code. If AuthChannel is empty or set to AUTH_CODE, specify the verification code. In other cases, specify a random… |
| AuthType | string | no | The authorization type. Valid values: NORMAL: normal authorization. CLOUD_PRODUCT: cloud product authorization |
| AuthChannel | string | no | The authorization channel. Valid values: AUTH_CODE: verification code authorization. RESOURCE_DIRECTORY: resource directory authorization.… |

### Creates a built-in authoritative domain name. The built-in authoritative domain name can be added to a…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/add-zone` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| Lang | string | no | The language of the response. Valid values: zh: Chinese. en: English. Default value: en |
| ZoneName | string | no | The name of the zone to add |
| ProxyPattern | string | no | Specifies whether to enable recursive proxy for subdomains. Valid values: ZONE: Disable. When a subdomain that does not exist under the… |
| ResourceGroupId | string | no | The ID of the resource group |
| ZoneType | string | no | This parameter is not available to users. Do not specify this parameter |
| ZoneTag | string | no | This parameter is not available to users. Do not specify this parameter |
| ClientToken | string | no | Ensures the idempotence of the request. Generate a parameter value on your client to ensure that the value is unique across different… |
| DnsGroup | string | no | The zone type of the built-in authoritative zone. Valid values: NORMAL_ZONE: normal zone. DNS resolution responses are cached. The system… |

### Adds a built-in authoritative DNS record. Within the effective parsing scope, the internal network DNS…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/add-zone-record` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| ZoneId | string | yes | The ID of the zone |
| Lang | string | no | The language of the returned values. Valid values: zh: Chinese. en: English. Default value: en |
| Rr | string | yes | The hostname record. The hostname record is the prefix of the domain name. Common values include www, @, * (wildcard), and mail (commonly… |
| Type | string | yes | The DNS record type. Supported types: A: Maps the domain name to an IPv4 address in dotted decimal format. AAAA: Maps the domain name to… |
| Line | string | no | The source of the DNS query. Valid values: default: The default DNS line, which acts as a global line. We recommend configuring the… |
| Weight | integer | no | The weight value, which must be an integer from 1 to 100. Default value: 1. You can set different weight values for each address so that… |
| Ttl | integer | no | The local cache time. Valid values: 5, 30, 60, 3600 (1 hour), 43200 (12 hours), and 86400 (1 day). Unit: seconds. Default value: 60 |
| Priority | integer | no | The priority of the MX record. A smaller value indicates a higher priority. Valid values: [1,99] |
| Value | string | yes | The record value. Enter the corresponding record value based on the DNS record type |
| UserClientIp | string | no | The IP address of the user |
| Remark | string | no | The remark |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can generate the value on the client. The value must be unique… |

### Associates a forwarding rule with a VPC
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/bind-resolver-rule-vpc` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| Lang | string | no | The language of the response. Valid values: zh: Chinese. en: English. Default value: en |
| RuleId | string | yes | The ID of the forwarding rule |
| Vpc | string | no | The list of VPCs to associate (JSON-encoded) |

### Associates or dissociates a zone with or from a list of VPCs to set the effective scope of the zone
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/bind-zone-vpc` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| Lang | string | no | The language of the response. Valid values: zh: Chinese. en: English. Default value: en |
| ZoneId | string | yes | The ID of the zone |
| UserClientIp | string | no | The user IP address |
| Vpcs | string | no | The list of VPCs. If this parameter is left empty, all VPCs are dissociated (JSON-encoded) |
| ClientToken | string | no | Ensures the idempotence of the request. Generate a parameter value on your client to ensure that the value is unique across different… |

### Modifies the location zone of a zone
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/change-zone-dns-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| ZoneId | string | yes | The global ID of the zone |
| DnsGroup | string | yes | The built-in authoritative location zone. Valid values: NORMAL_ZONE: Normal zone. FAST_ZONE: Accelerated zone. Starting April 30, 2025… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can generate the parameter value from your client to ensure… |

### Checks whether a zone name can be added based on rules
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/check-zone-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| Lang | string | no | The language of the response. Valid values: zh: Chinese. en: English. Default value: en |
| ZoneName | string | no | The name of the zone. This parameter is required |
| UserClientIp | string | no | The IP address of the user |

### Deletes a custom line
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/delete-custom-line` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| Lang | string | no | The language |
| LineId | string | yes | The unique ID of the custom line |

### Deletes an endpoint based on the endpoint ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/delete-resolver-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| EndpointId | string | yes | The endpoint ID, which is the unique identifier of the endpoint |
| Lang | string | no | Specifies the language of the response. Valid values: zh: Chinese. en: English. Default value: en |

### Deletes a forwarding rule by its ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/delete-resolver-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| RuleId | string | yes | The ID of the forwarding rule |
| Lang | string | no | The language |

### Deletes cross-account authorization based on the account ID and authorization type
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/delete-user-vpc-authorization` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| AuthorizedUserId | integer | yes | The ID of the Alibaba Cloud account that owns the authorized resources |
| AuthType | string | no | The authorization type. Valid values: NORMAL: standard authorization. CLOUD_PRODUCT: cloud service authorization. Default value: NORMAL |

### Deletes an idle built-in authoritative zone
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/delete-zone` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| Lang | string | no | The language of the response. Valid values: zh: Chinese. en: English. Default value: en |
| ZoneId | string | yes | The zone ID, which uniquely identifies the zone. If a domain name effective scope is configured for a built-in authoritative zone, you… |
| UserClientIp | string | no | The IP address of the user |
| ClientToken | string | no | Ensures the idempotence of the request. You can generate a value from your client to ensure that the value is unique across different… |

### Deletes a DNS record based on the record ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/delete-zone-record` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| Lang | string | no | The language of the response. Valid values: zh: Chinese. en: English. Default value: en |
| RecordId | integer | yes | The ID of the DNS record |
| UserClientIp | string | no | The user IP address |
| ClientToken | string | no | Ensures the idempotence of the request. The value is generated by the client and must be unique across different requests. The value can… |

### You can call the DescribeChangeLogs operation to retrieve the operation logs for a private zone. The logs…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/describe-change-logs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| Keyword | string | no | The keyword, such as a behavior or content. Fuzzy search is supported. The keyword is not case-sensitive |
| Lang | string | no | The language of the response. Valid values: zh: Chinese. en: English. Default value: en |
| ZoneId | string | no | The ID of the zone. If you specify this parameter, the operation returns the change logs of DNS records for the specified zone. If you… |
| PageNumber | integer | no | The number of the page to return. The value must be an integer that is greater than 0. Default value: 1 |
| PageSize | integer | no | The number of entries to return on each page. Maximum value: 100. Default value: 20 |
| StartTimestamp | integer | no | The start time. This value is a UNIX timestamp |
| EndTimestamp | integer | no | The end time. This value is a UNIX timestamp |
| EntityType | string | no | The type of log to obtain. Valid values: PV_ZONE: operation logs of built-in authoritative zones. PV_RECORD: operation logs of DNS… |
| UserClientIp | string | no | The IP address of the user |

### Queries the details of a custom line
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/describe-custom-line-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| Lang | string | no | The language |
| LineId | string | yes | The unique ID of the custom line |

### Queries the list of custom lines
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/describe-custom-lines` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| Lang | string | no | The language |
| PageNumber | integer | no | The page number. Default value: 1 |
| PageSize | integer | no | The paging Settings for the number of entries to return on each page in a paged query. Maximum value: 100. Default value: 10 |

### Retrieves a list of VPCs that a user can analyze
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/describe-intranet-user-can-analysis-vpcs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| NetworkType | string | no | The network type |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of entries per page |
| QueryTreeLevel | integer | no | The level in the query hierarchy. For example, you can query for VPCs that belong to a specific cloud account |
| VpcOwner | integer | no | The owner of the VPC |
| VpcType | string | no | The VPC type |
| RegionId | string | no | The region ID |

### Queries the global overview of DNS resolution statistics for Alibaba Cloud DNS PrivateZone
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/describe-pvtz-statistics-global-overview` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| ServerRegion | string | no | The service region |
| OverviewPeriod | string | no | The statistical period |
| NetworkParams | string | no | The network parameters (JSON-encoded) |

### Queries the trend of Alibaba Cloud DNS PrivateZone parse statistics information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/describe-pvtz-statistics-history` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| ServerRegion | string | no | The service region |
| Module | string | no | The statistics module |
| StatisticalType | string | no | The collection statistics type |
| StartTimestamp | string | no | The start time (UNIX timestamp) |
| EndTimestamp | string | no | The end time (UNIX timestamp) |
| ZoneName | string | no | The zone name |
| DomainName | string | no | The domain name |
| Rcode | string | no | The DNS response code |
| NetworkParams | string | no | The network parameters (JSON-encoded) |

### Queries the summary list of Alibaba Cloud DNS PrivateZone parse statistics information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/describe-pvtz-statistics-summary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| ServerRegion | string | no | The service region |
| StartTimestamp | string | no | The start time (UNIX timestamp) |
| EndTimestamp | string | no | The end time (UNIX timestamp) |
| Module | string | no | The statistics module |
| StatisticalType | string | no | The collection statistics type |
| ZoneName | string | no | The zone name |
| DomainName | string | no | The domain name |
| Rcode | string | no | The DNS response code |
| Direction | string | no | The sort direction (ASC, DESC) |
| PageNumber | integer | no | The page number of the returned data |
| PageSize | integer | no | The number of entries per page |
| NetworkParams | string | no | The network parameters (JSON-encoded) |
| Period | string | no | The statistical period |
| GrowType | string | no | The report on subdomains with sudden increases or decreases in request volume |
| OrderBy | string | no | The sort field. Sort by fluctuation rate: fluctuation_ratio |

### Queries the overview of DNS parse statistics information at the zone dimension for Alibaba Cloud DNS…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/describe-pvtz-statistics-zone-overview` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| AcceptLanguage | string | no | The supported language. Valid values: zh-CN: Chinese en-US: English Default value: en-US. This parameter takes precedence over Lang |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… |
| ServerRegion | string | no | The service region |
| OverviewPeriod | string | no | The statistical period |
| Module | string | no | The statistics module |
| NetworkParams | string | no | The network parameters (JSON-encoded) |

### Call the DescribeRegions operation to query a list of available regions. You can filter the list by criteria…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/describe-regions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| Lang | string | no | The language of the response. Valid values: zh: Chinese. en: English. Default value: en. This parameter has a lower priority than… |
| UserClientIp | string | no | The IP address of the user |
| AcceptLanguage | string | no | The supported language. Valid values: zh-CN: Chinese en-US: English Default value: en-US. This parameter has a higher priority than Lang |
| AuthorizedUserId | integer | no | The ID of the Alibaba Cloud account to which the authorized resources belong |
| VpcType | string | no | The type of the VPC. Valid values: STANDARD: standard VPC. EDS: Elastic Desktop Service (EDS) VPC |
| Scene | string | no | The scenario. Valid values: AUTH: built-in authoritative server FWD: forwarding management RA: traffic analysis |

### Queries details about the number of requests based on conditions such as a time range
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/describe-request-graph` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| Lang | string | no | The language of the response. Valid values: zh: Chinese. en: English. Default value: en |
| UserClientIp | string | no | The user's IP address |
| ZoneId | string | no | The zone ID. To query the number of requests for a zone, specify either ZoneId or both BizType and BizId |
| VpcId | string | no | The ID of the Virtual Private Cloud (VPC) |
| StartTimestamp | integer | yes | The start of the time range to query. This is a UNIX timestamp |
| EndTimestamp | integer | yes | The end of the time range to query. This is a UNIX timestamp |
| BizType | string | no | The business type. Valid values: AUTH_ZONE: An authoritative zone. RESOLVER_RULE: A forwarding rule |
| BizId | string | no | The data ID. This parameter is used with BizType. If BizType is set to AUTH_ZONE, set this parameter to the zone ID. If BizType is set to… |

### Call DescribeResolverAvailableZones to retrieve a list of available zones
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/describe-resolver-available-zones` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| Lang | string | no | The language of the response. Valid values: zh: Chinese. en: English. Default value: en |
| ResolverRegionId | string | yes | The region ID |
| AzId | string | no | The zone ID |

### You can call DescribeResolverEndpoint to retrieve the details of an endpoint by its ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/describe-resolver-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| Lang | string | no | The language of the response. Valid values: zh: Chinese. en: English. Default value: en |
| EndpointId | string | yes | The ID of the endpoint |

### You can call DescribeResolverEndpoints to retrieve a list of endpoints
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/describe-resolver-endpoints` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| Keyword | string | no | The keyword for the endpoint name. A fuzzy search is performed |
| Lang | string | no | The language of the response. Valid values: zh: Chinese. en: English. Default value: en |
| PageNumber | integer | no | The page number for a paged query. The value starts from 1. The default value is 1 |
| PageSize | integer | no | The number of entries per page. The maximum value is 100. The default value is 20 |
| Status | string | no | The status of the endpoint. Valid values: SUCCESS: The endpoint is working as expected. INIT: The endpoint is being created. FAILED: The… |
| VpcRegionId | string | no | The ID of the region where the outbound virtual private cloud (VPC) is located |

### Call the DescribeResolverRule operation to retrieve the details of a forwarding rule
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/describe-resolver-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| Lang | string | no | The language of the response. Valid values: zh: Chinese. en: English. Default value: en |
| RuleId | string | yes | The forwarding rule ID |

### Retrieves a list of forwarding rules
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/describe-resolver-rules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| Keyword | string | no | The keyword for the forwarding rule name. Fuzzy search is supported and case-insensitive |
| Lang | string | no | The language of the response. Valid values: zh: Chinese. en: English. Default value: en |
| PageNumber | integer | no | The page number for paging in a paged query. Settings: the starting value is 1. Default value: 1 |
| PageSize | integer | no | The data volume per page for paging in a paged query. Settings: the maximum value is 100. Default value: 20 |
| NeedDetailAttributes | string | no | Specifies whether to return additional information, such as the list of VPCs associated with the forwarding rule. Valid values: true: Yes.… |
| EndpointId | string | no | The ID of the outbound endpoint |

### Call the DescribeStatisticSummary operation to retrieve a summary of yesterday's request volume. This…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/describe-statistic-summary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| Lang | string | no | The language of the response. Valid values: zh: Chinese. en: English. Default value: en |
| UserClientIp | string | no | The user's IP address |

### Call DescribeSyncEcsHostTask to retrieve the details of a hostname sync task based on a zone ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/describe-sync-ecs-host-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| Lang | string | no | The language of the response. Valid values: zh: Chinese. en: English. Default value: en |
| ZoneId | string | yes | The unique ID of the zone |

### Queries the tags that are added to resources in PrivateZone
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/describe-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| Lang | string | no | The language of the response. Valid values: zh: Chinese. en: English. Default value: en |
| ResourceType | string | yes | The resource type. Set the value to ZONE |
| PageNumber | integer | no | The page number. The start value is 1. Default value: 1 |
| PageSize | integer | no | The number of entries per page. Maximum value: 100. Default value: 20 |

### Queries the service status of the current user, which indicates whether the service is activated or has…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/describe-user-service-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| Lang | string | no | The language of the response. Valid values: zh: Chinese. en: English. Default: en |

### Queries the cross-account authorizations
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/describe-user-vpc-authorizations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| AuthType | string | no | The authorization type. Valid values: NORMAL: Regular authorization. CLOUD_PRODUCT: Cloud service authorization |
| PageNumber | integer | no | The page number settings for paging in a paged query. The starting value is 1. Default value: 1 |
| PageSize | integer | no | The data volume settings per page for paging in a paged query. Maximum value: 100. Default value: 20 |
| AuthorizedUserId | integer | no | The ID of the Alibaba Cloud account to which the authorized resources belong |

### Call the DescribeZoneInfo operation to retrieve the details of a specified built-in authoritative zone. The…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/describe-zone-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| Lang | string | no | The language of the response. Valid values: zh: Chinese. en: English. Default: en |
| ZoneId | string | yes | The unique ID of the zone |

### Queries the details of a DNS record
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/describe-zone-record` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| RecordId | integer | yes | The ID of the DNS record |

### You can call DescribeZoneRecords to query DNS records for a zone
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/describe-zone-records` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| Lang | string | no | The language of the response. Valid values: zh: Chinese. en: English. Default value: en |
| Keyword | string | no | The keyword for the hostname. The search is not case-sensitive. Use the SearchMode parameter to switch between a fuzzy search and an exact… |
| ZoneId | string | yes | The unique ID of the zone |
| PageNumber | integer | no | The page number. Pages start from 1. The default value is 1 |
| PageSize | integer | no | The number of entries to return on each page. The maximum value is 100. The default value is 20 |
| UserClientIp | string | no | The client IP address of the user |
| Tag | string | no | The tag. Valid values: ecs: Queries the hostnames that are synchronized from ECS instances to the zone. If you do not specify this… |
| SearchMode | string | no | The search mode. Valid values: LIKE: fuzzy search EXACT: exact search (default) This parameter is used with the Keyword parameter |

### Call the DescribeZoneVpcTree operation to query the zones and the Virtual Private Clouds (VPCs) attached to…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/describe-zone-vpc-tree` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| Lang | string | no | The language of the response. Valid values: zh: Chinese. en: English. Default value: en |
| UserClientIp | string | no | The IP address of the client |

### You can call the DescribeZones operation to query a list of zones available to your account
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/describe-zones` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| Lang | string | no | The language of the response. Valid values: zh: Chinese. en: English. Default value: en |
| PageNumber | integer | no | The page number. Pages start from page 1. Default value: 1 |
| PageSize | integer | no | The number of entries to return on each page. Maximum value: 100. Default value: 20 |
| Keyword | string | no | The keyword of the zone name. The search is not case-sensitive. You can set the SearchMode parameter to switch between exact search and… |
| SearchMode | string | no | The search mode. This parameter takes effect only when the Keyword parameter is specified. Valid values: LIKE: fuzzy search (default)… |
| QueryRegionId | string | no | The region ID of the VPC that is associated with the zone |
| QueryVpcId | string | no | The ID of the VPC that is associated with the zone |
| ResourceGroupId | string | no | The ID of the resource group to which the zone belongs |
| ZoneType | string | no | The type of the zones to query. Valid values: AUTH_ZONE: authoritative zones. CLOUD_PRODUCT_ZONE: zones for cloud services. Default value:… |
| ZoneTag | string | no | The list of cloud service types (JSON-encoded) |
| ResourceTag | string | no | The resource tags that are added to the zone (JSON-encoded) |

### Queries the tags that are added to resources in Private Zone
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/list-tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| Lang | string | no | The language of the response. Valid values: zh: Chinese en: English Default value: en |
| ResourceType | string | yes | The resource type. Set the value to ZONE |
| NextToken | string | no | The token that is used to start the next query. It is returned in the response to the previous query |
| Size | integer | no | The number of entries to return on each page. Maximum value: 200. Default value: 20 |
| ResourceId | string | no | A list of resource IDs. In this case, a list of zone IDs. You can specify up to 50 IDs (JSON-encoded) |
| Tag | string | no | A list of tags (JSON-encoded) |

### You can call the MoveResourceGroup operation to move a resource to a different resource group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/move-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| Lang | string | no | The language of the response. Valid values: zh: Chinese en: English Default value: en |
| ResourceId | string | yes | The unique ID of the zone |
| NewResourceGroupId | string | yes | The ID of the destination resource group |
| ClientToken | string | no | A client token that ensures the idempotence of the request. Generate a unique value on your client. The token must contain only ASCII… |

### Searches for custom lines
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/search-custom-lines` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| Lang | string | no | The language |
| PageNumber | integer | no | The current page number. Pages start from 1. Default value: 1 |
| PageSize | integer | no | The Settings for the number of entries to return on each page during paging in a paged query. Maximum value: 100. Default value: 10 |
| Name | string | no | The name of the custom line |
| Ipv4 | string | no | The IPv4 address |
| Creator | string | no | The list of creator IDs (JSON-encoded) |
| CreateTimestampStart | integer | no | The start creation time (timestamp) |
| CreateTimestampEnd | integer | no | The end creation time (timestamp) |
| UpdateTimestampStart | integer | no | The start update time (timestamp) |
| UpdateTimestampEnd | integer | no | The end update time (timestamp) |

### Sets the recursive resolution proxy for subdomains
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/set-proxy-pattern` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| Lang | string | no | The language of the response. Valid values: zh: Chinese. en: English. Default value: en |
| ZoneId | string | yes | The unique ID of the zone |
| 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… |
| UserClientIp | string | no | The IP address of the client |
| 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… |

### Sets the weight enabling status
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/set-zone-lba-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| ZoneId | string | yes | Zone ID |
| Lang | string | no | The language |
| Rr | string | yes | The hostname record |
| Type | string | yes | The DNS record type. Currently, only A and AAAA record types support the weight toggle |
| Line | string | yes | The resolution line |
| Open | string | yes | Specifies whether to enable the weight configuration. Valid values: true: Enabled. false: Disabled |
| UserClientIp | string | no | The IP address of the user |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… |

### You can call SetZoneRecordStatus to set the status of a DNS record for a zone. This enables or pauses DNS…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/set-zone-record-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| Lang | string | no | The language of the response. Valid values: zh: Chinese. en: English. The default value is en |
| RecordId | integer | yes | The ID of the DNS record |
| Status | string | yes | The status of the DNS record. Valid values: ENABLE: Enables DNS resolution. DISABLE: Pauses DNS resolution |
| UserClientIp | string | no | The client IP address |
| ClientToken | string | no | A client token that is used to ensure the idempotence of the request. The client generates this value. The value must be unique among… |

### You can call the TagResources operation to add or modify tags for one or more zones in a batch
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| Lang | string | no | The language of the response. Valid values: zh: Chinese. en: English. Default value: en |
| ResourceType | string | yes | The resource type. The value must be ZONE |
| OverWrite | string | no | Specifies whether to modify the tag list. Valid values: True: Overwrites the existing tag list. False (default): Appends tags to the… |
| ResourceId | string | yes | The list of resource IDs. These are the IDs of the zones. You can specify up to 50 IDs (JSON-encoded) |
| Tag | string | yes | The list of tags (JSON-encoded) |

### You can call the UntagResources operation to remove tags from one or more zones in PrivateZone
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/untag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| Lang | string | no | The language of the return value. Valid values: zh: Chinese. en: English. Default value: en |
| ResourceType | string | yes | The resource type. Set the value to ZONE |
| All | string | no | Specifies whether to remove all tags. Valid values: true: Removes all tags from the specified zones. false: Removes only the tags that… |
| ResourceId | string | yes | A list of resource IDs, which are the zone IDs. You can specify up to 50 resource IDs (JSON-encoded) |
| TagKey | string | no | A list of tag keys. You can specify up to 20 tag keys (JSON-encoded) |

### Updates a custom line
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/update-custom-line` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| Lang | string | no | The language of the response. Valid values: `en` and `zh`. Default value: `en` |
| LineId | string | yes | The unique ID of the custom line |
| Name | string | no | The name of the custom line |
| Ipv4s | string | yes | An array of IPv4 address ranges for the custom line. Specify each range in the `StartIP-EndIP` format (JSON-encoded) |
| DnsCategory | string | no | The DnsCategory |

### You can call the UpdateRecordRemark operation to modify the remarks of a DNS record based on its ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/update-record-remark` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| Lang | string | no | The language of the response. Valid values: zh: Chinese. en: English. Default value: en |
| RecordId | integer | yes | The ID of the DNS record |
| Remark | string | no | The remarks |
| ClientToken | string | no | A client token used to ensure the idempotence of a request. The client generates this value, which must be unique across different… |

### Updates an endpoint
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/update-resolver-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| EndpointId | string | yes | The endpoint ID |
| Name | string | no | The name of the endpoint |
| IpConfig | string | no | A list of source IP addresses for outbound traffic. Specify at least two and up to six IP addresses. To ensure high availability (HA), an… |
| Lang | string | no | The language of the response. Valid values: zh: Chinese. en: English. Default value: en |

### Modifies a forwarding rule
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/update-resolver-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| RuleId | string | yes | The ID of the forwarding rule |
| Name | string | no | The name of the forwarding rule |
| ForwardIp | string | no | The IP addresses and ports of external DNS servers. DNS queries are forwarded to these servers. You can specify up to six servers. Both… |
| Lang | string | no | The language of the response. Valid values: zh: Chinese. en: English. Default value: en |
| EndpointId | string | no | The ID of the endpoint |
| PriorityForwardConfigs | string | no | The PriorityForwardConfigs (JSON-encoded) |

### Call the UpdateSyncEcsHostTask operation to add or update a hostname sync task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/update-sync-ecs-host-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| Lang | string | no | The language of the response. Valid values: zh: Chinese. en: English. Default value: en |
| ZoneId | string | yes | The unique ID of the zone |
| Status | string | yes | The status of the ECS hostname sync task. Valid values: ON: enables the task. OFF: disables the task |
| Region | string | yes | The regions for synchronization (JSON-encoded) |

### The UpdateZoneRecord operation modifies a DNS record for a zone. You can change properties such as the host…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/update-zone-record` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| Rr | string | yes | The host record. This is the prefix of a domain name. Common examples include www, @, * (for wildcard DNS), and mail (for mailboxes). For… |
| Lang | string | no | The language of the response. Valid values: zh: Chinese. en: English. Default value: en |
| RecordId | integer | yes | The ID of the DNS record. To obtain the ID, call the DescribeZoneRecords operation to query a list of DNS records |
| Line | string | no | The DNS resolution line. The default value is default |
| Weight | integer | no | The weight of the record. Valid values are integers from 1 to 100. The default value is 1. You can set different weights for records to… |
| Type | string | yes | The type of the DNS record. The following types are supported: A: Maps a domain name to an IPv4 address in dotted decimal notation. AAAA:… |
| Ttl | integer | no | The time to live (TTL) in seconds (s). Valid values: 5, 30, 60, 3600 (1 hour), 43200 (12 hours), and 86400 (1 day) |
| Priority | integer | no | The priority of the MX record. You can set different priorities for mail servers. Valid values: 1 to 99. A smaller value indicates a… |
| Value | string | yes | The record value. Enter a value that corresponds to the record type |
| UserClientIp | string | no | The IP address of the client |
| ClientToken | string | no | A client token that is used to ensure the idempotence of the request. The client generates the value, which must be unique among different… |

### Updates the weight value of an authoritative DNS record in Alibaba Cloud DNS PrivateZone
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/update-zone-record-weight` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| Lang | string | no | The language |
| RecordId | integer | yes | The ID of the DNS record |
| Weight | integer | yes | The updated weight value `[0,100]` |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. If you do not specify this parameter, the system automatically… |

### Modifies the remark for a built-in authoritative domain name (zone)
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/update-zone-remark` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |
| Lang | string | no | The language of the response. Valid values: zh: Chinese. en: English. Default value: en |
| ZoneId | string | yes | The unique ID of the zone |
| Remark | string | no | The new remark. To clear the remark, set this parameter to an empty string |
| UserClientIp | string | no | The IP address of the client |
| ClientToken | string | no | A client-generated token that is used to ensure the idempotence of the request. Make sure that the token is unique for each request. The… |

### version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pvtz.aliyuncs.com |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/add-custom-line" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Cloud DNS PrivateZone API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-pvtz/add-custom-line with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Cloud DNS PrivateZone API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Cloud DNS PrivateZone itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Cloud DNS PrivateZone API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-pvtz.

### What is the status of the Alibaba Cloud Cloud DNS PrivateZone API?
Needs your own provider key (bring your own key)