全部产品
Search
文档中心

资源管理:API概览

更新时间:May 13, 2024
本产品(资源目录/2022-04-19)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用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查询整个资源目录下的所有成员列表调用ListAccounts查询整个资源目录下的所有成员列表。
RemoveCloudAccount移除云账号类型的成员调用RemoveCloudAccount移除云账号类型的成员。
ListAccountsForParent查询资源夹下的成员列表调用ListAccountsForParent查询资源夹下的成员列表。
GetPayerForAccount获取结算账号信息调用GetPayerForAccount获取结算账号信息。
InviteAccountToResourceDirectory邀请外部账号加入资源目录调用InviteAccountToResourceDirectory邀请外部账号加入资源目录。
AcceptHandshake接受邀请被邀请的阿里云账号调用AcceptHandshake接受邀请。
GetHandshake获取邀请信息调用GetHandshake获取邀请信息。
DeclineHandshake拒绝邀请调用DeclineHandshake拒绝邀请。
CancelHandshake取消邀请调用CancelHandshake取消邀请。
ListHandshakesForAccount查询当前账号的邀请记录调用ListHandshakesForAccount查询当前账号的邀请记录。
ListHandshakesForResourceDirectory查看资源目录下的所有邀请列表调用ListHandshakesForResourceDirectory查看资源目录下的所有邀请列表。
SendVerificationCodeForBindSecureMobilePhone向安全手机发送验证码为资源账号类型的成员设置安全手机号码时,调用SendVerificationCodeForBindSecureMobilePhone向安全手机发送验证码。
BindSecureMobilePhone设置安全手机号码调用BindSecureMobilePhone为资源账号类型的成员设置安全手机号码。
SetMemberDeletionPermission开启或关闭成员删除许可调用SetMemberDeletionPermission开启或关闭成员删除许可。
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查询指定成员被设置为哪些可信服务的委派管理员账号。