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

检索资源共享实例

功能介绍

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

调试

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

URI

POST https://{endpoint}/v1/resource-shares/search

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Security-Token

否

String

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

参数

是否必选

参数类型

描述

limit

否

Integer

分页页面的最大值。

name

否

String

资源共享实例名称。

marker

否

String

页面标记。

permission_id

否

String

权限ID。

resource_owner

是

String

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

resource_share_ids

否

Array of strings

资源共享实例的ID列表。

resource_share_status

否

String

资源共享实例的状态。

tag_filters

否

Array of TagFilter objects

资源共享实例的标签。
表3 TagFilter

参数

是否必选

参数类型

描述

key

是

String

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

values

否

Array of strings

标签"键"对应的"值"列表。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

resource_shares

Array of ResourceShare objects

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

page_info

PageInfo object

分页详细信息。
表5 ResourceShare

参数

参数类型

描述

id

String

资源共享实例的ID。

name

String

资源共享实例的名称。

description

String

资源共享实例的描述。

allow_external_principals

Boolean

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

owning_account_id

String

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

status

String

资源共享实例的状态。

tags

Array of Tag objects

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

created_at

String

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

updated_at

String

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

参数

参数类型

描述

key

String

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

value

String

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

参数

参数类型

描述

previous_marker

String

上一页的页面标识。

next_marker

String

下一页的页面标识。

current_count

Integer

页面数量。

请求示例

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

POST https://{endpoint}/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

请求成功。

错误码

请参见错误码。

父主题： 资源共享实例

相关文档