PrivateZone provides a visualization console and supports multiple calling methods including OpenAPI online debugging, Alibaba Cloud SDK, and Alibaba Cloud CLI. This topic describes the OpenAPI operations and integration methods that PrivateZone supports. To improve your development efficiency when using DNS, we recommend that you select appropriate operations and integration methods based on your needs.
API reference
To help developers quickly and efficiently learn and use cloud product OpenAPI operations, Alibaba Cloud provides the OpenAPI Explorer website. OpenAPI Explorer integrates multiple features related to API operations, including intelligent search, documentation, online debugging, SDK download, sample code, error diagnosis, and call statistics. You can learn more about PrivateZone API.
Endpoint description
Select an endpoint based on the region where your resource resides to reduce latency. The global public endpoint of PrivateZone is pvtz.aliyuncs.com, and the global VPC endpoint is pvtz.vpc-proxy.aliyuncs.com.
Public endpoints can be accessed globally.
However, VPC endpoints are accessible only within a VPC in the corresponding Alibaba Cloud region. VPC endpoints provide the following advantages:
Higher security: VPC endpoints can be accessed only within a VPC. This provides higher security and privacy.
Fast response: VPC endpoints deliver faster responses than public endpoints because VPC endpoints enable data transmission over VPCs. Additionally, problems such as network latency and bandwidth limitations can be prevented.
Lower cost: VPC endpoints are accessed over an internal network.
User identity
PrivateZone supports calling OpenAPI operations by using the following user identities. We recommend that you use a Resource Access Management (RAM) user or a RAM role and assign permissions as needed based on your business requirements before you call API operations.
User identity | Support |
Support | |
RAM user (recommended) | Support |
RAM role (recommended) | Support |
We recommend that you use a RAM user or a RAM role and assign permissions as needed based on your business requirements before you call API operations.
More information
Integration methods
PrivateZone provides multiple integration methods such as SDK and CLI. You can select an appropriate method based on your business requirements.
Overview of integration methods
Calling method | Support |
Alibaba Cloud SDK (recommended) | Support |
Alibaba Cloud CLI | Support |
Resource Orchestration Service (ROS) | Not supported |
Custom encapsulated API calls | Support |
We recommend that you use a RAM user or a RAM role and assign permissions as needed based on your business requirements before you call API operations.
Precautions
If an error is returned after you call a PrivateZone API operation, you need to check whether the request parameters and their values are correct based on the error code. For more information, see Common error codes.
You can also record the RequestID returned by the call or the SDK error message, and use the Alibaba Cloud OpenAPI diagnostic platform for self-diagnosis.