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概述

EnableResourceDirectory 开通资源目录 调用EnableResourceDirectory开通资源目录。
SendVerificationCodeForEnableRD 发送验证码 通过创建新管理账号开通资源目录时,调用 SendVerificationCodeForEnableRD 向新管理账号的安全手机号码发送验证码。
GetResourceDirectory 获取资源目录信息 调用GetResourceDirectory获取资源目录信息。管理账号调用时,返回管理账号开通的资源目录详情。成员调用时,返回成员所属的资源目录详情。
DestroyResourceDirectory 关闭资源目录 调用DestroyResourceDirectory关闭资源目录。此操作不可恢复,请您慎重操作。

资源夹

API

标题

API概述

CreateFolder 创建资源夹 调用CreateFolder创建资源夹。
GetFolder 获取资源夹信息 调用GetFolder获取资源夹信息。
UpdateFolder 修改资源夹名称 调用UpdateFolder修改资源夹名称。
DeleteFolder 删除资源夹 调用DeleteFolder删除资源夹。
ListFoldersForParent 查看指定资源夹的子资源夹信息 调用ListFoldersForParent查询指定资源夹的子资源夹列表。
ListAncestors 查看指定资源夹的所有父资源夹信息 调用ListAncestors查看指定资源夹的所有父资源夹信息。返回结果将按照从上到下的顺序展示资源夹信息。

成员

API

标题

API概述

CreateResourceAccount 创建资源账号类型的成员 调用CreateResourceAccount创建资源账号类型的成员。
UpdateAccount 修改成员信息 调用UpdateAccount修改成员名称或切换成员类型。
GetAccount 获取成员信息 调用GetAccount获取成员信息。
GetPayerForAccount 获取结算账号信息 调用GetPayerForAccount获取成员的结算账号信息。
ListAccounts 查看整个资源目录下的成员信息 调用ListAccounts查询整个资源目录下的所有成员列表。
ListAccountsForParent 查看资源夹下的成员列表 调用ListAccountsForParent查询资源夹下的成员列表。
MoveAccount 将成员移动到另一个资源夹 调用MoveAccount将成员移动到另一个资源夹。
RemoveCloudAccount 移除云账号类型的成员 调用RemoveCloudAccount移除云账号类型的成员。移除后,该成员将作为独立的阿里云账号存在,不再被资源目录的管理账号管控。
BindSecureMobilePhone 设置安全手机号码 调用BindSecureMobilePhone为资源账号类型的成员设置安全手机号码。
SendVerificationCodeForBindSecureMobilePhone 向安全手机发送验证码 为资源账号类型的成员设置安全手机号码时,调用SendVerificationCodeForBindSecureMobilePhone向安全手机发送验证码。
ChangeAccountEmail 修改成员邮箱 调用ChangeAccountEmail修改成员邮箱。
RetryChangeAccountEmail 重新发送修改成员邮箱的确认邮件 调用RetryChangeAccountEmail重新发送修改成员邮箱的确认邮件。
CancelChangeAccountEmail 取消修改成员邮箱 调用CancelChangeAccountEmail取消修改成员邮箱。
CheckAccountDelete 成员删除检查 调用CheckAccountDelete执行成员删除检查任务。
DeleteAccount 删除资源类型的成员 调用DeleteAccount删除资源类型的成员。
SetMemberDeletionPermission 开启或关闭成员删除许可 调用SetMemberDeletionPermission开启或关闭成员删除许可。
GetAccountDeletionStatus 查询成员删除状态 调用GetAccountDeletionStatus查询成员删除状态。
GetAccountDeletionCheckResult 查询成员删除检查结果 调用GetAccountDeletionCheckResult查询成员删除检查结果。
InviteAccountToResourceDirectory 邀请外部账号加入资源目录 调用InviteAccountToResourceDirectory邀请外部账号加入资源目录。
GetHandshake 获取邀请信息 调用GetHandshake获取邀请信息。
CancelHandshake 取消邀请 调用CancelHandshake取消邀请。
ListHandshakesForAccount 查看当前账号下的邀请记录 调用ListHandshakesForAccount查询当前账号下的邀请记录。
ListHandshakesForResourceDirectory 查看资源目录下的所有邀请列表 调用ListHandshakesForResourceDirectory查看资源目录下的所有邀请列表。
AcceptHandshake 被邀请的阿里云账号接受邀请 被邀请的阿里云账号调用AcceptHandshake接受邀请。
DeclineHandshake 被邀请的阿里云账号拒绝邀请 被邀请的阿里云账号调用DeclineHandshake拒绝邀请。

管控策略

API

标题

API概述

EnableControlPolicy 开启管控策略功能 调用EnableControlPolicy开启管控策略功能。
GetControlPolicyEnablementStatus 查询管控策略功能的开启或关闭状态 调用GetControlPolicyEnablementStatus查询管控策略功能的开启或关闭状态。
DisableControlPolicy 关闭管控策略功能 调用DisableControlPolicy关闭管控策略功能。
CreateControlPolicy 创建自定义管控策略 调用CreateControlPolicy创建自定义管控策略。
GetControlPolicy 查询管控策略详情 调用GetControlPolicy查询管控策略的详情。
UpdateControlPolicy 修改自定义管控策略 调用UpdateControlPolicy修改自定义管控策略。
DeleteControlPolicy 删除自定义管控策略 调用DeleteControlPolicy删除自定义管控策略。
AttachControlPolicy 绑定自定义管控策略 调用AttachControlPolicy绑定管控策略。
DetachControlPolicy 解绑自定义管控策略 调用DetachControlPolicy解绑管控策略。
ListControlPolicies 查询管控策略列表 调用ListControlPolicies查询管控策略列表。
ListControlPolicyAttachmentsForTarget 查询节点绑定的管控策略 调用ListControlPolicyAttachmentsForTarget查询资源夹或成员账号绑定的管控策略列表。
ListTargetAttachmentsForControlPolicy 查询管控策略绑定的节点 调用ListTargetAttachmentsForControlPolicy查询管控策略绑定的节点。

可信服务

API

标题

API概述

ListTrustedServiceStatus 查询已启用的可信服务列表 调用ListTrustedServiceStatus查询管理账号或委派管理员账号已启用的可信服务列表。
RegisterDelegatedAdministrator 添加委派管理员账号 调用RegisterDelegatedAdministrator将资源目录的成员账号设置为可信服务的委派管理员账号。
DeregisterDelegatedAdministrator 移除委派管理员账号 调用DeregisterDelegatedAdministrator移除可信服务的委派管理员账号。
ListDelegatedAdministrators 查询可信服务的委派管理员账号 调用ListDelegatedAdministrators查询可信服务的委派管理员账号列表。
ListDelegatedServicesForAccount 查询指定成员账号是否为委派管理员账号 调用ListDelegatedServicesForAccount查询指定成员被设置为哪些可信服务的委派管理员账号。

标签

API

标题

API概述

TagResources 绑定标签 调用TagResources为资源组或资源目录的成员绑定标签。
UntagResources 解绑标签 调用UntagResources解绑资源组或资源目成员的标签。
ListTagResources 查询标签列表 调用ListTagResources查询资源组或资源目录成员绑定的标签列表。
ListTagKeys 查询标签键列表 调用ListTagKeys查询资源目录成员的标签键列表。
ListTagValues 查询指定标签键对应的标签值 调用ListTagValues查询指定标签键对应的标签值。

其他(不维护)

API

标题

API概述

InitResourceDirectory 开通资源目录 调用InitResourceDirectory开通资源目录。开通资源目录后,系统会为您创建一个Root资源夹,并将当前账号设置为企业管理账号。该企业管理账号具有管理资源目录的所有权限。
CreateCloudAccount 创建云账号类型的成员 创建资源目录云账号类型的成员。
PromoteResourceAccount 将资源账号升级为云账号 将资源账号升级为云账号,异步操作。
ResendPromoteResourceAccountEmail 重新发送资源账号升级云账号邮件 重新发送资源账号升级为云账号的确认邮件。
ResendCreateCloudAccountEmail 重新发送创建云账号的邮件 重新发送创建云账号的确认邮件。
CancelCreateCloudAccount 取消创建云账号类型的成员 取消创建资源目录云账号类型的成员。
CancelPromoteResourceAccount 取消升级资源账号为云账号 取消升级资源目录资源账号为云账号。