文档首页/ 资源访问管理 RAM/ API参考/ API/ 资源共享实例/ 检索资源共享实例 - SearchResourceShares
更新时间:2026-05-09 GMT+08:00
分享

检索资源共享实例 - SearchResourceShares

功能介绍

检索您创建的或者共享给您的资源共享实例详情。

调试

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

授权信息

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

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

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    ram:resourceShares:search

    Read

    -

    g:TagKeys

    -

    -

URI

POST /v1/resource-shares/search

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Security-Token

String

参数解释

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

约束限制

不涉及

取值范围

只能由英文字母、数字组成,且长度为至少 1 个字符

默认取值

不涉及

表2 请求Body参数

参数

是否必选

参数类型

描述

limit

Integer

参数解释

分页页面的大小。

约束限制

不涉及

取值范围

只支持数字,最小值为 1,最大值为 2000

默认取值

2000

name

String

参数解释

资源共享实例名称。

约束限制

不涉及

取值范围

由[0-64]个字符组成

默认取值

不涉及

marker

String

参数解释

页面标记,基于上一页页面标记取值,空字符串表明查询第一页。

约束限制

不涉及

取值范围

只支持数字,最小值为 1,最大值为 64

默认取值

不涉及

permission_id

String

参数解释

权限ID。

约束限制

不涉及

取值范围

只能由英文字母、数字及“_”、“-”组成,且长度为[0~36]个字符。

默认取值

不涉及

resource_owner

String

参数解释

检索您创建的或共享给您的(self或者other-accounts)资源共享实例。

约束限制

不涉及

取值范围

  • self: 检索您创建的共享资源实例

  • other-accounts: 检索共享给您的共享资源实例

默认取值

不涉及

resource_share_ids

Array of strings

参数解释

资源共享实例的ID列表。

约束限制

不涉及

resource_share_status

String

参数解释

资源共享实例的状态。

约束限制

不涉及

取值范围

由[0 - 36]个字符组成

默认取值

不涉及

tag_filters

Array of TagFilter objects

参数解释

资源共享实例的标签。

约束限制

不涉及

表3 TagFilter

参数

是否必选

参数类型

描述

key

String

参数解释

标签"键"的标识符或名称。

约束限制

不涉及

取值范围

只能由字母、数字、中文、下划线、点号、冒号、等号、加号、连字符、@符号及空格组成,不能以空格或"sys"开头,也不能以空格结尾。且长度为[1~128]个字符。

默认取值

不涉及

values

Array of strings

参数解释

标签"键"对应的"值"。您可以将标签的值设置为空字符串,但不能设置为null。

约束限制

不涉及

取值范围

只能由字母、数字、中文、下划线、点号、冒号、斜杠、等号、加号、连字符、@符号及空格组成。且长度为[0~255]个字符。

默认取值

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

resource_shares

Array of ResourceShare objects

参数解释

资源共享实例的详细信息列表。

约束限制

不涉及

page_info

PageInfo object

参数解释

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

约束限制

不涉及

表5 ResourceShare

参数

参数类型

描述

id

String

参数解释

资源共享实例的ID

约束限制

不涉及

取值范围

由[0-36]个字符组成

默认取值

不涉及

name

String

参数解释

资源共享实例的名称。

约束限制

不涉及

取值范围

由[0-128]个字符组成

默认取值

不涉及

description

String

参数解释

资源共享实例的描述。

约束限制

不涉及

取值范围

由[1-1024]个字符组成

默认取值

不涉及

allow_external_principals

Boolean

参数解释

资源共享实例是否支持共享给组织外账号。

约束限制

不涉及

取值范围

  • false: 资源共享实例不支持共享给组织外账号。

  • true: 资源共享实例支持共享给组织外账号。

默认取值

不涉及

owning_account_id

String

参数解释

资源共享实例的所有者ID。

约束限制

不涉及

取值范围

由[0-36]个字符组成

默认取值

不涉及

status

String

参数解释

资源共享实例的状态。

约束限制

不涉及

取值范围

由[0-36]个字符组成

默认取值

不涉及

tags

Array of Tag objects

参数解释

资源共享实例的标签列表。

约束限制

不涉及

created_at

String

参数解释

创建资源共享实例的时间。

约束限制

不涉及

取值范围

对应 RFC 3339 规范的日期时间格式,yyyy-MM-ddTHH:mm:ss.SSSZ

默认取值

无默认值

updated_at

String

参数解释

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

约束限制

不涉及

取值范围

对应 RFC 3339 规范的日期时间格式,yyyy-MM-ddTHH:mm:ss.SSSZ

默认取值

无默认值

表6 Tag

参数

参数类型

描述

key

String

参数解释

标签"键"的标识符或名称。

约束限制

不涉及

取值范围

只能由字母、数字、中文、下划线、点号、冒号、等号、加号、连字符、@符号及空格组成,不能以空格或"sys"开头,也不能以空格结尾。且长度为[1~128]个字符。

默认取值

不涉及

value

String

参数解释

标签"键"对应的"值"。您可以将标签的值设置为空字符串,但不能设置为null。

约束限制

不涉及

取值范围

只能由字母、数字、中文、下划线、点号、冒号、斜杠、等号、加号、连字符、@符号及空格组成。且长度为[0~255]个字符。

默认取值

不涉及

表7 PageInfo

参数

参数类型

描述

previous_marker

String

参数解释

上一页的页面标识。

约束限制

不涉及

取值范围

仅支持数字,且长度为[1- 64]个字符组成

默认取值

不涉及

next_marker

String

参数解释

下一页的页面标识。

约束限制

不涉及

取值范围

仅支持数字,且长度为[1- 64]个字符组成

默认取值

不涉及

current_count

Integer

参数解释

页面数量。

约束限制

不涉及

取值范围

仅支持数字,范围为 [1-2000]

默认取值

不涉及

请求示例

检索您创建的资源共享实例详情。

POST /v1/resource-shares/search

{
  "limit" : 2000,
  "name" : "string",
  "marker" : "string",
  "permission_id" : "string",
  "resource_owner" : "self",
  "resource_share_ids" : [ "string" ],
  "resource_share_status" : "string",
  "tag_filters" : [ {
    "key" : "string",
    "values" : [ "string" ]
  } ]
}

响应示例

状态码:200

请求成功。

{
  "resource_shares" : [ {
    "id" : "string",
    "name" : "string",
    "description" : "string",
    "allow_external_principals" : true,
    "owning_account_id" : "string",
    "status" : "string",
    "tags" : [ {
      "key" : "string",
      "value" : "string"
    } ],
    "created_at" : "2023-01-06T08:24:55.638Z",
    "updated_at" : "2023-01-06T08:24:55.638Z"
  } ],
  "page_info" : {
    "previous_marker" : "string",
    "next_marker" : "string",
    "current_count" : 2000
  }
}

状态码

状态码

描述

200

请求成功。

错误码

请参见错误码

相关文档