DCDN API integration overview-Edge Security Acceleration(ESA)-阿里云帮助中心

Learn how to integrate Dynamic Content Delivery Network (DCDN) through API, SDK, CLI, Terraform, and ROS.

Overview of OpenAPI Explorer

OpenAPI Explorer lets you search, debug, and call DCDN API operations online. It provides documentation, SDK sample code generation, error diagnosis, and call statistics. What is an OpenAPI?

Version description

API version	Description
2018-01-15	The recommended version.

Online debugging

DCDN supports API debugging in OpenAPI Explorer. Before calling an API operation, familiarize yourself with DCDN API versions, endpoints, and integration methods.

Debugging page

Access the debugging page of the DCDN API.

Endpoints

Select an endpoint based on the region where 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, OpenAPI Explorer uses your Alibaba Cloud account for debugging. Because this account has full API permissions, we recommend that you use a RAM user for routine API calls and O&M. Grant the RAM user the required DCDN permissions before use. For more information, see Implement access control with RAM.

Identity	Supported
Alibaba Cloud account	Yes
RAM user (recommended)	Yes
RAM role (recommended)	Yes

References

Integration methods

DCDN supports multiple integration methods, including SDK and CLI.

Integration method	Supported
Alibaba Cloud SDK	Yes
Alibaba Cloud CLI	Yes
Terraform	Yes
Resource Orchestration Service (ROS)	Yes
Custom API encapsulation	Yes

Alibaba Cloud SDK

Alibaba Cloud SDKs are available in Java, C#, Go, Python, TypeScript, Node.js, PHP, and C++. SDKs handle signature logic, timeouts, and retries, and return structured response objects. For more information, see Alibaba Cloud SDKs.
Use Alibaba Cloud SDKs to call DCDN API operations. For supported languages and dependencies, visit the DCDN SDK Center.

Alibaba Cloud CLI

Run aliyun commands to interact with Alibaba Cloud services and manage resources. For more information, see What is Alibaba Cloud CLI
Use Alibaba Cloud CLI to call DCDN API operations. Sample commands.

Terraform

Terraform is an open source tool for managing cloud infrastructure as code. It calls API operations by interpreting templates, similar to ROS. For more information, see What is Alibaba Cloud Terraform?
Terraform supports both regular and data DCDN resources.

Orchestrate DCDN resources with Terraform. Integrate DCDN by using Terraform.

Resource type	Resource	Description
Resources	alicloud_dcdn_domain	Improves website performance and speeds up content delivery.
	alicloud_dcdn_domain_config	Provides DCDN-accelerated domain names.
	alicloud_dcdn_er	Provides routines in EdgeRoutine.
	alicloud_dcdn_ipa_domain	Provides IP Application Accelerator (IPA)-accelerated domain names.
	alicloud_dcdn_kv	Provides key-value pairs in EdgeKV.
	alicloud_dcdn_kv_namespace	Provides EdgeKV namespaces.
	alicloud_dcdn_waf_domain	Provides WAF-protected domain names.
	alicloud_dcdn_waf_policy	Provides WAF protection policies.
	alicloud_dcdn_waf_policy_domain_attachment	Provides accelerated domain names that are associated with a WAF protection policy.
	alicloud_dcdn_waf_rule	Provides WAF protection rules.
Data Sources	alicloud_dcdn_domains	Provides a collection of DCDN-accelerated domain names for a specified filter.
	alicloud_dcdn_ipa_domains	Provides IPA-accelerated domain names that belong to the current Alibaba Cloud account.
	alicloud_dcdn_kv_account	Provides key-value pairs that belong to the current account.
	alicloud_dcdn_service	Automatically activates DCDN.
	alicloud_dcdn_waf_domains	Provides WAF-protected domain names that belong to the current Alibaba Cloud account.
	alicloud_dcdn_waf_policies	Provides WAF protection policies that are configured by the current Alibaba Cloud account.
	alicloud_dcdn_waf_rules	Provides WAF protection rules that are available for the current Alibaba Cloud account.

ROS

ROS automates cloud resource deployment through templates. Define resources such as ECS and ApsaraDB RDS instances and their dependencies, and ROS creates and configures them. For more information, see What is Resource Orchestration Service.
ROS supports DCDN API operations for regular resources only.
- Regular resource:
  - ALIYUN::DCDN::Domain: adds a domain name to DCDN.

Custom API encapsulation

For native HTTP calls, create and sign requests manually. For more information about the signature mechanism, see API overview and Request syntax and signature method V3.

Usage notes

If an API call returns an error, verify your request parameters against the Service error codes

Use the Alibaba Cloud OpenAPI diagnostics platform to diagnose errors by request ID or SDK error message.