API概览

更新时间:
复制 MD 格式

API标准及多语言预置SDK

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

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

自定义签名场景

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

账号与安全准备

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

资源标签

API

标题

API概述

TagResources 为云资源创建并绑定标签 为指定的多个云产品的多个云资源统一创建并绑定标签。
UntagResources 为云资源统一解绑标签 为指定的多个云产品的多个云资源统一解绑标签。
ListTagResources 查询资源标签列表 查询多个云产品的多个云资源绑定的标签列表。
ListResourcesByTag 基于标签查询资源 基于标签查询资源。
ListTagKeys 查询标签键列表 查询标签键列表。
ListTagValues 查询指定标签键对应的标签值 查询指定标签键对应的标签值。
CreateTags 创建预置标签 创建预置标签。
DeleteTag 删除预置标签 删除预置标签。
OpenCreatedBy 启用创建者标签 启用创建者标签。
CheckCreatedByEnabled 校验创建者标签启用状态 校验创建者标签启用状态。
CloseCreatedBy 禁用创建者标签 禁用创建者标签。
ListSupportResourceTypes 查询标签支持的资源类型和标签能力项 查询标签支持的资源类型和标签能力项。
DescribeRegions 查询支持标签的地域信息 查询支持标签的地域信息。

标签策略

API

标题

API概述

CreatePolicy 创建标签策略 创建标签策略。
DeletePolicy 删除标签策略 删除标签策略。
AttachPolicy 将标签策略绑定到目标节点 将标签策略绑定到目标节点。
DetachPolicy 解绑指定的标签策略 解绑指定的标签策略。
ModifyPolicy 修改标签策略 修改标签策略。
GetPolicy 查询标签策略详情 查询标签策略详情。
GetPolicyEnableStatus 查询标签策略状态 查询标签策略状态。
ListPolicies 查询标签策略列表 查询标签策略列表。
ListPoliciesForTarget 查询目标节点绑定的标签策略列表 查询目标节点绑定的标签策略列表。
GetEffectivePolicy 查询有效策略 查询有效策略。
ListTargetsForPolicy 查询标签策略绑定的目标节点 查询标签策略绑定的目标节点。
ListConfigRulesForTarget 查询目标节点的标签检测任务列表 查询目标节点的标签检测任务列表。
GetConfigRuleReport 查询上一次生成的不合规资源检测报告的基本信息 查询上一次生成的不合规资源检测报告的基本信息。
GenerateConfigRuleReport 生成不合规资源检测报告 生成不合规资源检测报告。

关联资源标签设置

API

标题

API概述

CreateAssociatedResourceRules 创建关联资源标签规则 创建关联资源标签规则。
UpdateAssociatedResourceRule 更新关联资源标签规则 更新关联资源标签规则。
ListAssociatedResourceRules 查询关联资源标签规则列表 查询关联资源标签规则列表。
DeleteAssociatedResourceRule 删除关联资源标签规则 删除关联资源标签规则。