检索绑定的资源使用者和共享资源 - SearchResourceShareAssociations

功能介绍

检索您拥有的资源共享实例中绑定的共享资源和资源使用者。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
ram:resourceShares:searchResourceShareAssociations
Read
-
-
-
-

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
ram:resourceShares:searchResourceShareAssociations	Read	-	-	-	-

URI

POST /v1/resource-share-associations/search

请求参数

表1 请求Header参数
参数	是否必选	参数类型	描述
X-Security-Token	否	String	如果正在使用临时安全凭据，则此header是必需的，该值是临时安全凭据的安全令牌（会话令牌）。

表2 请求Body参数
参数	是否必选	参数类型	描述
association_status	否	String	指定绑定的状态。
association_type	是	String	指定绑定的类型（principal或resource）。
limit	否	Integer	页面中最大结果的数量。当未指定limit参数情况下，系统默认值为2000。
marker	否	String	页面标记。
principal	否	String	指定绑定的资源使用者。
resource_urn	否	String	指定绑定的共享资源URN。
resource_share_ids	否	Array of strings	指定资源共享实例的ID列表。
resource_ids	否	Array of strings	指定共享资源ID列表。

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
resource_share_associations	Array of ResourceShareAssociation objects	绑定的详细信息列表。
page_info	PageInfo object	分页详细信息。

表4 ResourceShareAssociation
参数	参数类型	描述
associated_entity	String	绑定的实体。这可以是共享资源的URN、账号ID、组织根的URN或OU的URN之一。
association_type	String	绑定中包含的实体类型。
created_at	String	绑定被创建的时间。
updated_at	String	最后一次更新绑定的时间。
external	Boolean	标识资源使用者是否和共享的拥有者属于同一个组织
resource_share_id	String	资源共享实例的ID。
resource_share_name	String	资源共享实例的名称。
status	String	绑定的当前状态。
status_message	String	绑定的当前状态的描述。

表5 PageInfo
参数	参数类型	描述
previous_marker	String	上一页的页面标识。
next_marker	String	下一页的页面标识。
current_count	Integer	页面数量。

请求示例

检索您拥有的资源共享实例中绑定的共享资源和资源使用者。

POST /v1/resource-share-associations/search

{
  "association_status" : "string",
  "association_type" : "principal",
  "limit" : 2000,
  "marker" : "string",
  "principal" : "string",
  "resource_urn" : "string",
  "resource_share_ids" : [ "string" ],
  "resource_ids" : [ "string" ]
}

响应示例

状态码：200

请求成功。

{
  "resource_share_associations" : [ {
    "associated_entity" : "string",
    "association_type" : "string",
    "created_at" : "2022-09-19T02:10:16.960Z",
    "updated_at" : "2022-09-19T02:10:16.960Z",
    "external" : true,
    "resource_share_id" : "string",
    "resource_share_name" : "string",
    "status" : "string",
    "status_message" : "string"
  } ],
  "page_info" : {
    "previous_marker" : "string",
    "next_marker" : "string",
    "current_count" : 2000
  }
}