集成概览

OpenAPI介绍

为了能够让开发者快速高效的学习和使用云产品OpenAPI，阿里云为用户提供OpenAPI网站。它是一款集OpenAPI智能搜索、文档、在线调试、SDK获取、CodeSample、调用出错诊断、调用统计为一体的产品。您可以在OpenAPI门户中调用阿里云各云产品开放的OpenAPI，查看OpenAPI请求和返回结果。此外，OpenAPI门户会自动生成相应的SDK调用示例，帮助您快速使用阿里云产品。更多信息，请参见什么是OpenAPI。

版本说明

阿里云OpenAPI通过版本号管控各时期云产品大版本的API列表，例如域名服务目前支持2018-01-29版本的API列表，2018-01-29代表的是API版本号而非时间概念，所展示的都是最新的API公开数据，并非自2018-01-29之后就未更新。

在线调试

域名服务在OpenAPI门户提供API调试功能。在调用前，您需要了解域名服务提供的版本、接入点、接口风格、调用方式等信息。

以 SaveSingleTaskForCreatingOrderActivate（提交域名注册任务）API 为例，在 OpenAPI 门户左侧导航树中选择目标 API，中间区域选择服务地址（如 华东1（杭州）），并填写请求参数，包括 DomainName（想要注册的域名，必填）、SubscriptionDuration（购买周期）、RegistrantProfileId（域名信息模板编号）、EnableDomainProxy（是否开启域名隐私保护服务）、PermitPremiumActivation（是否允许注册白金词）等，然后单击 发起调用。右侧面板可查看接口说明和请求参数文档。

调试入口

调试API入口为：域名服务调试-入口。

接入点说明

根据相关资源所在地域，选择对应的服务接入点地址，以获得最低延迟。

华东1（杭州）服务接入点（Endpoint）：domain.aliyuncs.com。

更多信息，请参见服务接入点。

接口风格

RPC风格。

用户身份

您阿里云账号登录OpenAPI网站后，OpenAPI默认使用您的阿里云账号进行在线OpenAPI调试。阿里云账号拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。请根据业务的实际情况按需分配权限后进行接口调用。RAM用户需具备操作云备份资源的权限。具体操作，请参见创建RAM用户进行云备份操作。

更多信息

• 身份、凭据与授权

• 流量控制与配额管理

集成方式

• 阿里云SDK

  • 阿里云为开发者提供了多种编程语言（Java、C#、Go、Python、Node.js/TypeScript、PHP、C++ 等）的SDK。开发者只需集成SDK，通过SDK暴露的方法直接调用OpenAPI。SDK统一封装了签名逻辑、超时机制、重试机制，并提供了接口请求Request对象和接口返回Response对象，易于开发。更多关于阿里云SDK的介绍，请参见阿里云SDK。

  • 支持使用域名服务SDK调用OpenAPI，支持语言及依赖的安装方法请参见Java SDK调用示例。

• 阿里云CLI

  • 阿里云命令行工具可以帮您在使用命令行终端时，使用aliyun命令与阿里云服务进行交互，管理云服务资源。有关阿里云CLI的更多详细信息，请参见什么是阿里云CLI。

  • 暂不支持使用阿里云CLI调用域名服务OpenAPI。

• Terraform

  • Terraform 是一种开源工具，用于安全高效地预览，配置和管理云基础架构和资源。它与阿里云的资源编排服务的运行机制类似，通过将模板转化为内部数据后完成 OpenAPI 调用。更多详情，请参见什么是 Terraform。

  • 暂不支持使用Terraform调用域名服务OpenAPI。

• 资源编排ROS

  • 资源编排服务ROS（Resource Orchestration Service）是阿里云提供的一项简化云计算资源管理的服务。开发者和管理员可以编写模板，在模板中定义所需的阿里云资源（例如：ECS 实例、RDS 数据库实例）、资源间的依赖关系等。ROS 的编排引擎将根据模板自动完成所有资源的创建和配置，实现自动化部署及运维。更多详情，请参见什么是资源编排服务。

  • 暂不支持使用资源编排调用域名服务OpenAPI。

• 自定义封装API调用

  • 原生HTTP调用需要您自己实现签名算法，并构建自定义请求，发起HTTP调用。有关签名机制的更多详细信息，请参见API概览和V3版本请求体&签名机制。

注意事项

• 如果调用短信服务API后返回错误，您需要根据返回的错误码提示检查传入的请求参数及其取值是否正确。更多信息，请参见公共错误码。

• 您也可以记录下调用返回的RequestID或SDK报错信息，通过阿里云OpenAPI诊断平台进行自助诊断。