本文为您介绍使用阿里云CDNOpenAPI的基本信息。
OpenAPI介绍
为了能够让开发者快速高效地学习和使用云产品OpenAPI,阿里云为用户提供OpenAPI网站。它是一款集OpenAPI智能搜索、文档、在线调试、SDK获取、CodeSample、调用出错诊断、调用统计为一体的产品。您可以在OpenAPI门户中调用阿里云各云产品开放的OpenAPI,查看OpenAPI请求和返回结果。此外,OpenAPI门户会自动生成相应的SDK调用示例,帮助您快速使用阿里云产品。更多信息,请参见什么是OpenAPI。
版本说明
|
版本号 |
说明 |
|
推荐使用。 |
在线调试
CDN在OpenAPI门户提供API调试等功能。在调用前,您需要了解CDN提供的版本、接入点说明、集成方式等信息。
以 AddCdnDomain(添加域名)接口为例,在 OpenAPI 门户左侧导航栏选择域名管理 > 添加/删除域名 > 添加域名 AddCdnDomain,在中间参数配置区域填写必填参数 CdnType(加速域名的业务类型)、DomainName(需要接入CDN的加速域名)、Sources(回源地址列表),以及可选参数 ResourceGroupId、CheckUrl、Scope、TopLevelDomain 等,然后单击发起调用。调用前需注意:需先开通 CDN 服务;加速域名必须完成备案;每次只能添加一个域名;每个用户最多添加 50 个域名;单个用户调用频率限制为 30 次/秒。
调试入口
调试API入口为:CDN API调试入口。
接入点说明
根据相关资源所在地域,选择对应的服务接入点地址,以获得最低延迟。例如华东2(上海)的CDN公网接入地址为cn-shanghai.aliyuncs.com。
更多信息,请参见CDN服务接入点。
用户身份
您阿里云账号登录OpenAPI网站后,默认使用您的阿里云账号进行在线OpenAPI调试。由于阿里云账号拥有所有API的访问权限,存在较高的风险。强烈建议您创建并使用RAM用户进行API访问或日常运维。请根据业务的实际情况按需分配权限后进行接口调用。RAM用户需具备操作CDN资源的权限。具体操作,请参见使用RAM进行访问控制。
|
用户身份 |
支持情况 |
|
支持 |
|
|
RAM 用户(推荐) |
支持 |
|
RAM角色(推荐) |
支持 |
更多信息
集成方式
CDN产品提供SDK、CLI等多种集成方式,您可以根据业务的实际需要进行选择。
|
调用方式 |
支持情况 |
|
阿里云SDK(推荐) |
支持 |
|
支持 |
|
|
支持 |
|
|
支持 |
|
|
支持 |
阿里云SDK
-
阿里云为开发者提供了多种编程语言(Java、C#、Go、Py thon、Node.js/TypeScript、PHP、C++ 等)的SDK。开发者只需要集成SDK,通过SDK暴露的方法直接调用OpenAPI 。SDK统一封装了签名逻辑、超时机制、重试机制,并根据文档返回结构化Response对象,易于开发。更多关于阿里云SDK的介绍,请参见阿里云SDK。
-
支持在OpenAPI通过阿里云SDK调用CDN。支持语言及依赖安装方法请参见CDN_SDK中心。
阿里云CLI
-
支持使用阿里云CLI调用CDN。更多信息,请参见使用阿里云CLI。
-
阿里云命令行工具可以帮您在使用命令行终端时,使用
aliyun命令与阿里云服务进行交互,管理云服务资源。有关阿里云CLI的更多详细信息,请参见什么是阿里云CLI。
Terraform
-
Terraform 是一种开源工具,用于安全高效地预览,配置和管理云基础架构和资源。它与阿里云的资源编排服务的运行机制类似,通过将模板转化为内部数据后完成 OpenAPI 调用。更多详情,请参见了解阿里云Terraform。
-
快速使用Terraform编排CDN,请参见Terraform集成示例。
-
支持使用Terraform管理CDN的资源,支持常规资源和数据资源清单的部分如下。
资源类型
资源
说明
Resources
提供CDN域配置资源。
提供CDN与资源及域名。
提供了CDN FC的触发器资源。
提供了CDN实时日志传递资源。
Date Sources
提供CDN阻塞区域。
提供了验证IP是否为CDN节点的功能。
提供当前阿里云用户的CDN实时日志交付功能。
提供自动启用CDN服务。
资源编排ROS
-
资源编排服务ROS(Resource Orchestration Service)是阿里云提供的一项简化云计算资源管理的服务。开发者和管理员可以编写模板,在模板中定义所需的阿里云资源(例如:ECS 实例、RDS 数据库实例)、资源间的依赖关系等。ROS 的编排引擎将根据模板自动完成所有资源的创建和配置,实现自动化部署及运维。更多详情,请参见什么是资源编排服务。
-
快速使用资源编排ROS编排CDN,请参见资源编排ROS集成示例。
-
支持使用资源编排服务ROS调用CDN。编排的部分资源包括普通资源和数据资源。
-
普通资源:
-
ALIYUN::CDN::Domain:用于添加加速域名。
-
ALIYUN::CDN::DomainConfig:用于批量配置域名。
-
-
数据资源:
-
DATASOURCE::CDN::Domains:用于查询已创建加速域名的基础信息。
-
-
自定义封装API调用
-
原生HTTP调用需要您自己实现签名算法,并构建自定义请求,发起HTTP调用。有关签名机制的更多详细信息,请参见文档API概览和V3版本请求体&签名机制。
注意事项
如果调用API后返回错误,您需要根据返回的错误码提示检查传入的请求参数及其取值是否正确,更多信息请参见错误码中心。
您也可以记录下调用返回的RequestID或SDK报错信息,通过阿里云OpenAPI诊断平台进行自助诊断。