This topic describes basic information about the Dynamic Content Delivery Network (DCDN) API.
Overview of OpenAPI Explorer
Alibaba Cloud provides OpenAPI Explorer for developers to understand and use the API operations of Alibaba Cloud services in a quick and efficient manner. OpenAPI Explorer integrates multiple features related to API operations, including intelligent search, documentation, online debugging, SDK download, sample code, error diagnosis, and call statistics. In OpenAPI Explorer, you can call the API operations of Alibaba Cloud services and view API requests and responses. In addition, OpenAPI Explorer automatically generates the corresponding SDK sample code to facilitate the use of Alibaba Cloud services. For more information, see What is an OpenAPI?
Version description
API version | Description |
The recommended version. |
Online debugging
DCDN provides features such as API debugging in OpenAPI Explorer. Before you call an API operation, make sure that you are familiar with the information about DCDN, such as the API versions, endpoints, and integration methods.
Debugging page
Access the debugging page of the DCDN API.
Endpoints
You can select an endpoint based on the region in which your resource resides to reduce latency. For example, if you use DCDN in the China (Zhangjiakou) region, the public endpoint is cn-zhangjiakoudcdn.aliyuncs.com.
For more information, see Endpoints.
User identities
By default, after you log on to OpenAPI Explorer with your Alibaba Cloud account, the account is used to perform online debugging. An Alibaba Cloud account has permissions on all API operations. If you use an Alibaba Cloud account to call API operations, security risks may arise. We recommend that you call API operations or perform routine O&M as a Resource Access Management (RAM) user. Before you call API operations as a RAM user, grant the required permissions to the RAM user based on your business requirements. The RAM user must have the permissions to manage DCDN resources. For more information, see Use RAM to implement access control.
Identity | Supported |
Yes | |
RAM user (recommended) | Yes |
RAM role (recommended) | Yes |
References
Integration methods
DCDN provides various integration methods such as SDK and CLI. You can select a method based on your business requirements.
Integration method | Supported |
Yes | |
Yes | |
Yes | |
Yes | |
Yes |
Alibaba Cloud SDK
Alibaba Cloud provides SDKs in multiple programming languages, including Java, C#, Go, Python, TypeScript, Node.js, PHP, and C++. You can integrate SDKs into your applications to directly call API operations. The SDKs encapsulate information such as the signature logic, timeout mechanism, and retry mechanism and return structured response objects based on specifications. This provides convenience for developers. For more information, see Alibaba Cloud SDKs.
You can use Alibaba Cloud SDKs to call DCDN API operations. For more information about supported languages and dependencies, visit the DCDN SDK Center.
Alibaba Cloud CLI
You can run
aliyuncommands to interact with Alibaba Cloud services and manage cloud service resources. For more information, see What is Alibaba Cloud CLI?You can use Alibaba Cloud CLI to call DCDN API operations. For more information, see Sample commands.
Terraform
Terraform is an open source tool that is used to preview, configure, and manage cloud infrastructure and resources in a secure and efficient manner. Terraform works in a similar way as Resource Orchestration Service (ROS). Terraform calls API operations by interpreting templates. For more information, see What is Terraform?
You can use Terraform to manage DCDN resources, including regular and data resources.
For information about how to use Terraform to orchestrate DCDN resources, see Integrate DCDN by using Terraform.
Resource type
Resource
Description
Resources
Improves website performance and speeds up content delivery.
Provides DCDN-accelerated domain names.
Provides routines in EdgeRoutine.
Provides IP Application Accelerator (IPA)-accelerated domain names.
Provides key-value pairs in EdgeKV.
Provides EdgeKV namespaces.
Provides WAF-protected domain names.
Provides WAF protection policies.
Provides accelerated domain names that are associated with a WAF protection policy.
Provides WAF protection rules.
Data Sources
Provides a collection of DCDN-accelerated domain names for a specified filter.
Provides IPA-accelerated domain names that belong to the current Alibaba Cloud account.
Provides key-value pairs that belong to the current account.
Automatically activates DCDN.
Provides WAF-protected domain names that belong to the current Alibaba Cloud account.
Provides WAF protection policies that are configured by the current Alibaba Cloud account.
Provides WAF protection rules that are available for the current Alibaba Cloud account.
ROS
ROS is an Alibaba Cloud service that can simplify the management of cloud computing resources. You can create a template to describe the cloud computing resources that you need, such as Elastic Compute Service (ECS) and ApsaraDB RDS instances, and the relationship between the resources. ROS automatically creates and configures all resources based on the template to implement automated deployment and O&M. For more information, see What is ROS?.
You can use ROS to call DCDN API operations. Only regular resources can be orchestrated by using ROS.
Regular resource:
ALIYUN::DCDN::Domain: adds a domain name to DCDN.
Custom API encapsulation
To make native HTTP calls, you must create custom requests and sign the requests. For more information about the signature mechanism, see List of operations by function and Request syntax and signature method V3.
Usage notes
If an error is returned after you call an API operation, check whether the request parameters and the parameter values are valid based on the returned error code. For more information, see Service error codes.
You can also use the Alibaba Cloud OpenAPI diagnostics platform to perform self-service diagnostics based on the returned request ID or SDK error message.