文档首页/ 资源访问管理 RAM/ API参考/ API/ 资源使用者/ 检索资源使用者或者资源所有者 - SearchSharedPrincipals
更新时间:2026-08-13 GMT+08:00
分享

检索资源使用者或者资源所有者 - SearchSharedPrincipals

功能介绍

检索共享资源的使用者或者共享给您的资源所有者。

调试

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

授权信息

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

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    ram:sharedPrincipals:search

    List

    -

    -

    -

    -

URI

POST /v1/shared-principals/search

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Security-Token

String

参数解释

如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。

约束限制

不涉及

取值范围

只能由英文字母、数字、加号、斜杠、等号及连字符组成,长度为1~16384个字符。

默认取值

不涉及

表2 请求Body参数

参数

是否必选

参数类型

描述

limit

Integer

参数解释

页面中最大结果的数量。

约束限制

不涉及

取值范围

1~2000。

默认取值

2000

marker

String

参数解释

页面标记。

约束限制

不涉及

取值范围

只能由数字组成,长度为 1~64 个字符。

默认取值

不涉及

principals

Array of strings

参数解释

指定资源使用者。数组元素为资源使用者的账号ID或URN格式的字符串。账号ID可通过IAM查询账号信息接口获取,URN可通过调用查询共享资源列表接口获取。

约束限制

不涉及

resource_urn

String

参数解释

指定资源的URN。可通过调用查询共享资源列表接口获取。

约束限制

不涉及

取值范围

只能由字母、数字、加号、斜杠、等号、连字符及下划线组成,采用冒号分隔的5段格式,其中第1段长度至少1个字符、第2段长度不超过255个字符、第3和第4段长度分别为1~64个字符、第5段长度至少1个字符。且总长度为0~1500个字符。

默认取值

不涉及

resource_owner

String

参数解释

指定查询的资源共享实例所有者类型。

约束限制

不涉及

取值范围

  • self:查询自己创建的资源共享实例。

  • other-accounts:查询其他账号共享给您的资源共享实例。

默认取值

不涉及

resource_share_ids

Array of strings

参数解释

指定资源共享实例的ID列表。数组元素为资源共享实例ID格式的字符串,只能由英文字母、数字及'-'、'_'组成,长度为1~36个字符。获取方式:通过创建资源共享实例或查询资源共享实例列表接口获取。

约束限制

不涉及

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

shared_principals

Array of SharedPrincipal objects

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

page_info

PageInfo object

参数解释

分页详细信息。包含 previous_marker,next_marker 与 current_count 字段

表4 SharedPrincipal

参数

参数类型

描述

resource_share_id

String

资源使用者绑定的资源共享实例的ID。取值范围:只能由英文字母、数字及“-”组成,长度为0~36个字符。

id

String

资源使用者的账号ID或URN。取值范围:不涉及。

created_at

String

资源使用者与资源共享实例关联的时间。UTC时间格式,格式为yyyy-MM-ddTHH:mm:ssZ,例如2020-09-25T12:05:00Z。取值范围:不涉及。

updated_at

String

最后一次更新资源使用者与资源共享实例关联的时间。UTC时间格式,格式为yyyy-MM-ddTHH:mm:ssZ,例如2020-09-25T12:05:00Z。取值范围:不涉及。

表5 PageInfo

参数

参数类型

描述

previous_marker

String

参数解释

上一页的页面标识。

取值范围

只能由数字组成,且长度为1~64个字符

next_marker

String

参数解释

下一页的页面标识。

取值范围

只能由数字组成,且长度为1~64个字符

current_count

Integer

参数解释

当前页面的记录数量。

取值范围

1~2000

请求示例

检索共享资源的使用者或者共享给您的资源所有者。

POST /v1/shared-principals/search

{
  "limit" : 2000,
  "marker" : "0",
  "principals" : [ "string" ],
  "resource_urn" : "dns::123abc:zone:123abc",
  "resource_owner" : "self",
  "resource_share_ids" : [ "string" ]
}

响应示例

状态码:200

请求成功。

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

状态码

状态码

描述

200

请求成功。

错误码

请参见错误码

相关文档