API概览

更新时间:
复制 MD 格式

API标准及多语言预置SDK

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

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

自定义签名场景

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

账号与安全准备

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

资源组

API

标题

API概述

CreateResourceGroup 创建资源组 调用CreateResourceGroup创建资源组。
DeleteResourceGroup 删除资源组 调用DeleteResourceGroup删除资源组。
UpdateResourceGroup 修改资源组的显示名称 调用UpdateResourceGroup修改资源组的显示名称。
ListResourceGroups 查询资源组列表 调用ListResourceGroups查询资源组列表。
ListResources 查看当前账号可以访问的资源列表 调用ListResources查询当前账号可以访问的资源组中的资源列表。
GetResourceGroup 查询资源组信息 调用GetResourceGroup查询资源组信息。
MoveResources 资源转组 调用MoveResources将资源从一个资源组转移到另一个资源组。
EnableAutoGrouping 开通自动转组 调用EnableAutoGrouping开通自动转组。开通后可以创建、更新、删除、查询自动转组规则。
DisableAutoGrouping 关闭自动转组 调用DisableAutoGrouping关闭自动转组。关闭自动转组功能后,已设置的自定义条件规则、关联资源跟随转组规则将会被删除,存量资源所属资源组不受影响。如您需要,您也可以在关闭自动转组功能1分钟后,重新开启该功能。
UpdateAutoGroupingConfig 更新自动转组设置 调用UpdateAutoGroupingConfig更新自动转组设置。目前仅支持设置是否开启存量关联资源跟随转组任务。
GetAutoGroupingStatus 查询自动转组状态 调用GetAutoGroupingStatus查询自动转组设置状态。
CreateAutoGroupingRule 创建自动转组规则 调用CreateAutoGroupingRule创建自动转组规则。支持自定义转组规则和关联资源跟随转组规则两类。
DeleteAutoGroupingRule 删除自动转组规则 调用DeleteAutoGroupingRule删除自动转组规则。
UpdateAutoGroupingRule 更新自动转组规则 调用UpdateAutoGroupingRule更新自动转组规则。
ListAutoGroupingRules 查询自动转组规则列表 调用ListAutoGroupingRules查询自动转组规则列表。
GetAutoGroupingRule 查询自动转组规则信息 调用GetAutoGroupingRule查询自动转组规则信息。
EnableAssociatedTransfer 开通关联资源跟随转组功能 调用EnableAssociatedTransfer开通关联资源跟随转组功能。
DisableAssociatedTransfer 关闭关联资源跟随转组功能 调用DisableAssociatedTransfer关闭关联资源跟随转组功能。
UpdateAssociatedTransferSetting 更新关联转组功能设置 调用UpdateAssociatedTransferSetting更新关联转组功能设置。
ListAssociatedTransferSetting 获取关联转组功能设置 调用ListAssociatedTransferSetting获取关联转组功能设置。
GetResourceGroupResourceCounts 查询可见资源组资源数量 查询可见资源组下的资源数量。
ListAutoGroupingRemediations 列出自动分组修正记录 调用ListAutoGroupingRemediations列出自动分组修正记录。
GetResourceGroupAdminSetting 查询资源组管理员配置 调用GetResourceGroupAdminSetting查询资源组管理员配置。
UpdateResourceGroupAdminSetting 更新资源组管理员配置 调用UpdateResourceGroupAdminSetting更新资源组管理员配置。
LookupResourceGroupEvents 查询资源组事件 查询资源组事件。
EnableResourceGroupNotification 开通组事件通知 调用EnableResourceGroupNotification开通组事件通知。
DisableResourceGroupNotification 关闭资源组通知 调用DisableResourceGroupNotification关闭组事件通知。
GetResourceGroupNotificationSetting 查看组事件通知设置 调用GetResourceGroupNotificationSetting查询资源组通知设置。
ListResourceGroupCapability 列出资源组能力项 列出资源组能力项。
ListResourceGroupsWithAuthDetails 列出资源组与用户授权信息 调用ListResourceGroupsWithAuthDetails列出资源组与用户授权信息。

角色

API

标题

API概述

CreateRole 创建角色 调用CreateRole创建角色。
DeleteRole 删除角色 调用DeleteRole删除角色。
UpdateRole 更新角色信息 调用UpdateRole更新RAM角色信息。
GetRole 获取角色信息 调用GetRole获取角色信息。
ListRoles 查看角色列表 调用ListRoles查看角色列表。

服务关联角色

API

标题

API概述

CreateServiceLinkedRole 创建服务关联角色 调用CreateServiceLinkedRole创建服务关联角色。
DeleteServiceLinkedRole 删除服务关联角色 调用DeleteServiceLinkedRole删除服务关联角色。
GetServiceLinkedRoleDeletionStatus 获取删除服务关联角色的任务状态 调用GetServiceLinkedRoleDeletionStatus获取删除服务关联角色的任务状态。

权限策略

API

标题

API概述

CreatePolicy 创建权限策略 调用CreatePolicy创建一个权限策略。
DeletePolicy 删除权限策略 调用DeletePolicy删除指定的权限策略。
SetDefaultPolicyVersion 设置权限策略默认版本 调用SetDefaultPolicyVersion设置权限策略默认版本。
AttachPolicy RAM身份授权 调用AttachPolicy为授权对象(RAM用户、RAM用户组或RAM角色)添加权限策略,即授权。完成授权后,被授权对象将获得指定资源组或阿里云账号内资源的访问权限。
DetachPolicy RAM身份移除权限 调用DetachPolicy移除指定对象的权限策略。移除授权后,该对象将失去对当前资源组或账号中资源的操作权限。
ListPolicies 查看权限策略列表 调用ListPolicies查看权限策略列表。
GetPolicy 获取指定的权限策略信息 调用GetPolicy获取指定的权限策略信息。
ListPolicyAttachments 查看授权列表 调用ListPolicyAttachments查看授权列表。
CreatePolicyVersion 创建权限策略版本 调用CreatePolicyVersion创建权限策略版本。
DeletePolicyVersion 删除权限策略版本 调用DeletePolicyVersion删除权限策略版本。
ListPolicyVersions 查看权限策略版本列表 调用ListPolicyVersions查看权限策略版本列表。
GetPolicyVersion 获取某个权限策略的版本 调用GetPolicyVersion获取某个权限策略的版本。

标签

API

标题

API概述

TagResources 绑定标签 调用TagResources为资源组或资源目录的成员绑定标签。
UntagResources 解绑标签 调用UntagResources解绑资源组或资源目成员的标签。
ListTagResources 查询标签列表 调用ListTagResources查询资源组或资源目录成员绑定的标签列表。