文档首页/ 资源访问管理 RAM/ API参考/ API/ 资源使用者/ 检索资源使用者
更新时间：2024-10-31 GMT+08:00
查看PDF
分享

检索资源使用者

功能介绍

检索共享资源的使用者。

调试

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

URI

POST https://{endpoint}/v1/shared-principals/search

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Security-Token

否

String

如果正在使用临时安全凭据，则此header是必需的，该值是临时安全凭据的安全令牌（会话令牌）。
表2 请求Body参数

参数

是否必选

参数类型

描述

limit

否

Integer

分页页面的最大值。

marker

否

String

页面标记。

principals

否

Array of strings

指定资源使用者。

resource_urn

否

String

指定资源的URN。

resource_owner

是

String

指定资源共享实例的所有者（self或者other-accounts）。

resource_share_ids

否

Array of strings

指定资源共享实例的ID列表。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

shared_principals

Array of SharedPrincipal objects

资源使用者的详细信息列表。

page_info

PageInfo object

分页详细信息。
表4 SharedPrincipal

参数

参数类型

描述

resource_share_id

String

资源使用者绑定的资源共享实例的ID。

id

String

资源使用者的账号ID或URN。

created_at

String

资源使用者与资源共享实例关联的时间。

updated_at

String

最后一次更新资源共享实例的时间。
表5 PageInfo

参数

参数类型

描述

previous_marker

String

上一页的页面标识。

next_marker

String

下一页的页面标识。

current_count

Integer

页面数量。

请求示例

检索共享资源的使用者。

POST https://{endpoint}/v1/shared-principals/search

{
  "limit" : 2000,
  "marker" : "string",
  "principals" : [ "string" ],
  "resource_urn" : "string",
  "resource_owner" : "self",
  "resource_share_ids" : [ "string" ]
}

响应示例

状态码： 200

请求成功。

{
  "shared_principals" : [ {
    "resource_share_id" : "string",
    "id" : "string",
    "created_at" : "2022-09-19T02:33:13.496Z",
    "updated_at" : "2022-09-19T02:33:13.496Z"
  } ],
  "page_info" : {
    "previous_marker" : "string",
    "next_marker" : "string",
    "current_count" : 2000
  }
}

状态码

状态码

描述

200

请求成功。

错误码

请参见错误码。

父主题： 资源使用者