API概览

更新时间:
复制 MD 格式

API标准及多语言预置SDK

本产品(cloudcontrol/2022-08-30)的OpenAPI采用ROA签名风格。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(147535001692),在专家指导下进行签名对接。

在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

自定义签名场景

若您的业务场景有特殊需求,需通过自签名方式对接 API,建议优先咨询我们的技术支持团队(服务钉钉群:147535001692),获取专业指导以确保高效接入。

账号与安全准备

阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露,所有相关资源都将面临未经授权访问的风险。为确保安全,建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey,同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下,才使用阿里云账号。

元数据查询

API

标题

API概述

GetResourceType 查询资源类型的详情 获取资源元数据。
ListProducts 列举产品 列举支持的产品。
ListResourceTypes 列举资源类型 列举产品的资源类型。

资源管理

API

标题

API概述

CreateResource 创建资源 创建资源。
DeleteResource 删除资源 用户通过此接口删除资源。
GetResources 查询资源 通过此接口查询资源。
UpdateResource 更新资源 通过此接口更新资源。

异步任务管理

API

标题

API概述

GetTask 查询任务 通过此接口查询指定异步任务详情。
CancelTask 取消任务 通过此接口取消指定异步任务。

数据查询

API

标题

API概述

ListDataSources 查询资源属性可选值 用户通过此接口查询资源属性可选值(RegionID、ZoneId等)。

其他

API

标题

API概述

GetPrice 资源询价 该接口为询价接口,用户可通过此接口查询资源价格。