OpenAPI介紹

為了能夠讓開發(fā)者快速高效的學(xué)習(xí)和使用云產(chǎn)品OpenAPI，阿里云為用戶提供OpenAPI網(wǎng)站。它是一款集OpenAPI智能搜索、文檔、在線調(diào)試、SDK獲取、CodeSample、調(diào)用出錯(cuò)診斷、調(diào)用統(tǒng)計(jì)為一體的產(chǎn)品。您可以在OpenAPI門戶中調(diào)用阿里云各云產(chǎn)品開放的OpenAPI，查看OpenAPI請求和返回結(jié)果。此外，OpenAPI門戶會(huì)自動(dòng)生成相應(yīng)的SDK調(diào)用示例，幫助您快速使用阿里云產(chǎn)品。更多信息，請參見什么是 OpenAPI。

版本說明

阿里云OpenAPI通過版本號管控各時(shí)期云產(chǎn)品大版本的API列表，例如域名服務(wù)目前支持2018-01-29版本的API列表，2018-01-29代表的是API版本號而非時(shí)間概念，所展示的都是最新的API公開數(shù)據(jù)，并非自2018-01-29之后就未更新。

在線調(diào)試

域名服務(wù)在OpenAPI門戶提供API調(diào)試功能。在調(diào)用前，您需要了解域名服務(wù)提供的版本、接入點(diǎn)、接口風(fēng)格、調(diào)用方式等信息。

調(diào)試入口

調(diào)試API入口為：域名服務(wù)調(diào)試-入口。

接入點(diǎn)說明

根據(jù)相關(guān)資源所在地域，選擇對應(yīng)的服務(wù)接入點(diǎn)地址，以獲得最低延遲。

華東1（杭州）服務(wù)接入點(diǎn)（Endpoint）：domain.aliyuncs.com。

更多信息，請參見服務(wù)接入點(diǎn)。

接口風(fēng)格

RPC風(fēng)格。

用戶身份

您阿里云賬號登錄OpenAPI網(wǎng)站后，OpenAPI默認(rèn)使用您的阿里云賬號進(jìn)行在線OpenAPI調(diào)試。阿里云賬號擁有所有API的訪問權(quán)限，風(fēng)險(xiǎn)很高。強(qiáng)烈建議您創(chuàng)建并使用RAM用戶進(jìn)行API訪問或日常運(yùn)維。請根據(jù)業(yè)務(wù)的實(shí)際情況按需分配權(quán)限后進(jìn)行接口調(diào)用。RAM用戶需具備操作云備份資源的權(quán)限。具體操作，請參見創(chuàng)建RAM用戶及授權(quán)。

更多信息

• 身份、憑據(jù)與授權(quán)

• 流量控制與配額管理

集成方式

• 阿里云SDK

  • 阿里云為開發(fā)者提供了多種編程語言（Java、C#、Go、Python、Node.js/TypeScript、PHP、C++ 等）的SDK。開發(fā)者只需集成SDK，通過SDK暴露的方法直接調(diào)用OpenAPI。SDK統(tǒng)一封裝了簽名邏輯、超時(shí)機(jī)制、重試機(jī)制，并提供了接口請求Request對象和接口返回Response對象，易于開發(fā)。更多關(guān)于阿里云SDK的介紹，請參見阿里云SDK。

  • 支持使用域名服務(wù)SDK調(diào)用OpenAPI，支持語言及依賴的安裝方法請參見SDK快速入門。

• 阿里云CLI

  • 阿里云命令行工具可以幫您在使用命令行終端時(shí)，使用aliyun命令與阿里云服務(wù)進(jìn)行交互，管理云服務(wù)資源。有關(guān)阿里云CLI的更多詳細(xì)信息，請參見什么是阿里云CLI。

  • 暫不支持使用阿里云CLI調(diào)用域名服務(wù)OpenAPI。

• Terraform

  • Terraform 是一種開源工具，用于安全高效地預(yù)覽，配置和管理云基礎(chǔ)架構(gòu)和資源。它與阿里云的資源編排服務(wù)的運(yùn)行機(jī)制類似，通過將模板轉(zhuǎn)化為內(nèi)部數(shù)據(jù)后完成 OpenAPI 調(diào)用。更多詳情，請參見什么是 Terraform。

  • 暫不支持使用Terraform調(diào)用域名服務(wù)OpenAPI。

• 資源編排ROS

  • 資源編排服務(wù)ROS（Resource Orchestration Service）是阿里云提供的一項(xiàng)簡化云計(jì)算資源管理的服務(wù)。開發(fā)者和管理員可以編寫模板，在模板中定義所需的阿里云資源（例如：ECS 實(shí)例、RDS 數(shù)據(jù)庫實(shí)例）、資源間的依賴關(guān)系等。ROS 的編排引擎將根據(jù)模板自動(dòng)完成所有資源的創(chuàng)建和配置，實(shí)現(xiàn)自動(dòng)化部署及運(yùn)維。更多詳情，請參見什么是資源編排服務(wù)。

  • 暫不支持使用資源編排調(diào)用域名服務(wù)OpenAPI。

• 自定義封裝API調(diào)用

  • 原生HTTP調(diào)用需要您自己實(shí)現(xiàn)簽名算法，并構(gòu)建自定義請求，發(fā)起HTTP調(diào)用。有關(guān)簽名機(jī)制的更多詳細(xì)信息，請參見API概覽和V3版本請求體&簽名機(jī)制。

注意事項(xiàng)

• 如果調(diào)用短信服務(wù)API后返回錯(cuò)誤，您需要根據(jù)返回的錯(cuò)誤碼提示檢查傳入的請求參數(shù)及其取值是否正確。更多信息，請參見公共錯(cuò)誤碼。

• 您也可以記錄下調(diào)用返回的RequestID或SDK報(bào)錯(cuò)信息，通過阿里云OpenAPI診斷平臺進(jìn)行自助診斷。