API概览

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

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

服务

API

标题

API概述

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

资源夹

API

标题

API概述

CreateFolder 创建资源夹 调用CreateFolder创建资源夹。
GetFolder 获取资源夹信息 调用GetFolder获取资源夹信息。
DeleteFolder 删除资源夹 调用DeleteFolder删除资源夹。
ListFoldersForParent 查询指定资源夹的子资源夹列表 调用ListFoldersForParent查询指定资源夹的子资源夹列表。
UpdateFolder 修改资源夹 调用UpdateFolder修改资源夹名称。
ListAncestors 查看指定资源夹的所有父资源夹信息 调用ListAncestors查看指定资源夹的所有父资源夹信息。

成员

API

标题

API概述

CreateResourceAccount 创建成员 调用CreateResourceAccount创建资源账号类型的成员。
GetAccount 查询成员信息 调用GetAccount查询成员信息。
MoveAccount 移动成员 调用MoveAccount将成员移动到另一个资源夹。
UpdateAccount 修改成员 调用UpdateAccount修改成员名称或切换成员类型。
ListAccounts 查询整个资源目录下的所有成员列表 查询整个资源目录下的所有成员列表。
RemoveCloudAccount 移除云账号类型的成员 调用RemoveCloudAccount移除云账号类型的成员。
ListAccountsForParent 查询资源夹下的成员列表 调用ListAccountsForParent查询资源夹下的成员列表。
GetPayerForAccount 获取结算账号信息 调用GetPayerForAccount获取结算账号信息。
UpdatePayerForAccount 更新成员的结算账号 更新成员的结算账号。
InviteAccountToResourceDirectory 邀请外部账号加入资源目录 调用InviteAccountToResourceDirectory邀请外部账号加入资源目录。
AcceptHandshake 接受邀请 被邀请的阿里云账号调用AcceptHandshake接受邀请。
GetHandshake 获取邀请信息 调用GetHandshake获取邀请信息。
DeclineHandshake 拒绝邀请 调用DeclineHandshake拒绝邀请。
CancelHandshake 取消邀请 调用CancelHandshake取消邀请。
ListHandshakesForAccount 查询当前账号的邀请记录 调用ListHandshakesForAccount查询当前账号的邀请记录。
ListHandshakesForResourceDirectory 查看资源目录下的所有邀请列表 调用ListHandshakesForResourceDirectory查看资源目录下的所有邀请列表。
SendVerificationCodeForBindSecureMobilePhone 向安全手机发送验证码 为资源账号类型的成员设置安全手机号码时,调用SendVerificationCodeForBindSecureMobilePhone向安全手机发送验证码。
BindSecureMobilePhone 设置安全手机号码 调用BindSecureMobilePhone为资源账号类型的成员设置安全手机号码。
SetMemberDeletionPermission 开启或关闭成员删除许可 调用SetMemberDeletionPermission开启或关闭成员删除许可。
SetMemberDisplayNameSyncStatus 开启或关闭成员显示名称同步状态 开启或关闭成员显示名称同步状态。
CheckAccountDelete 成员删除检查 调用CheckAccountDelete执行成员删除检查任务。
GetAccountDeletionCheckResult 查询成员删除检查结果 调用GetAccountDeletionCheckResult查询成员删除检查结果。
DeleteAccount 删除资源账号 调用DeleteAccount删除资源类型的成员。
GetAccountDeletionStatus 查询成员删除状态 调用GetAccountDeletionStatus查询成员删除状态。
TagResources 绑定标签 调用TagResources为资源目录的成员绑定标签。
UntagResources 解绑标签 调用UntagResources解绑资源目成员的标签。
ListTagResources 查询标签列表 调用ListTagResources查询资源目录成员绑定的标签列表。
ListTagKeys 查询标签键列表 调用ListTagKeys查询标签键列表。
ListTagValues 查询指定标签键对应的标签值 调用ListTagValues查询指定标签键对应的标签值。
ChangeAccountEmail 修改成员邮箱 调用ChangeAccountEmail修改成员邮箱。
RetryChangeAccountEmail 重新发送修改成员邮箱的确认邮件 调用RetryChangeAccountEmail重新发送修改成员邮箱的确认邮件。
CancelChangeAccountEmail 取消修改成员邮箱 调用CancelChangeAccountEmail取消修改成员邮箱。
AddMessageContact 添加联系人 添加消息通知联系人。
SendEmailVerificationForMessageContact 向联系人邮箱发送验证信息 向联系人的邮箱发送验证信息。
SendPhoneVerificationForMessageContact 向联系人手机发送验证信息 向联系人的手机号码发送验证信息。
ListMessageContactVerifications 查询联系人待验证记录 查询联系人的手机或邮箱的待验证记录。
AssociateMembers 绑定联系人 为资源目录、资源夹或成员绑定联系人。
DisassociateMembers 解绑联系人 为资源目录、资源夹或成员解绑联系人。
GetMessageContact 查询联系人信息 查询联系人信息。
ListMessageContacts 查询联系人列表 查询联系人列表。
DeleteMessageContact 删除联系人 删除联系人。
GetMessageContactDeletionStatus 查询联系人删除状态 查询联系人删除状态。
UpdateMessageContact 更新联系人信息 更新联系人信息。
CancelMessageContactUpdate 取消更新联系人手机或邮箱 取消更新联系人手机或邮箱。
PrecheckForConsolidatedBillingAccount 检查账号是否可以作为财务托管主账号 检查管理账号或者成员是否可以作为财务托管主账号。

管控策略

API

标题

API概述

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

可信服务

API

标题

API概述

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