API概览

更新时间:
复制为 MD 格式

API标准及多语言预置SDK

本产品(资源管理/2020-03-31)的 OpenAPI 采用 RPC 签名机制,具体签名方式请参见签名机制说明我们已为开发者封装了主流编程语言的 SDK,您可通过 下载 SDK 快速调用 API,无需关注签名等底层实现细节,显著降低开发门槛与集成复杂度。

自定义签名场景

若您的业务场景有特殊需求,需通过自签名方式对接 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设置权限策略默认版本。
AttachPolicyRAM身份授权调用AttachPolicy为授权对象(RAM用户、RAM用户组或RAM角色)添加权限策略,即授权。完成授权后,被授权对象将获得指定资源组或阿里云账号内资源的访问权限。
DetachPolicyRAM身份移除权限调用DetachPolicy移除指定对象的权限策略。移除授权后,该对象将失去对当前资源组或账号中资源的操作权限。
ListPolicies查看权限策略列表调用ListPolicies查看权限策略列表。
GetPolicy获取指定的权限策略信息调用GetPolicy获取指定的权限策略信息。
ListPolicyAttachments查看授权列表调用ListPolicyAttachments查看授权列表。
CreatePolicyVersion创建权限策略版本调用CreatePolicyVersion创建权限策略版本。
DeletePolicyVersion删除权限策略版本调用DeletePolicyVersion删除权限策略版本。
ListPolicyVersions查看权限策略版本列表调用ListPolicyVersions查看权限策略版本列表。
GetPolicyVersion获取某个权限策略的版本调用GetPolicyVersion获取某个权限策略的版本。

标签

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