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

检索共享邀请

功能介绍

通过条件检索资源共享邀请。

调试

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

URI

POST https://{endpoint}/v1/resource-share-invitations/search

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Security-Token

否

String

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

参数

是否必选

参数类型

描述

resource_share_ids

否

Array of strings

资源共享实例的ID列表。

resource_share_invitation_ids

否

Array of strings

资源共享邀请的ID列表。

status

否

String

资源共享邀请的当前状态。

limit

否

Integer

分页页面的最大值。

marker

否

String

分页位置标识。从marker指定索引的下一条数据开始查询。查询第一页数据时，不需要传入此参数，查询后续页码数据时，将查询前一页数据响应体中marker值配入此参数。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

resource_share_invitations

Array of ResourceShareInvitation objects

资源共享邀请的详细信息。

page_info

PageInfo object

分页详细信息。
表4 ResourceShareInvitation

参数

参数类型

描述

receiver_account_id

String

接收资源共享邀请的账号ID。

resource_share_id

String

资源共享实例的ID。

resource_share_name

String

资源共享实例的名称。

resource_share_invitation_id

String

资源共享邀请的ID。

sender_account_id

String

发送资源共享邀请的账号ID。

status

String

资源共享邀请的当前状态。

created_at

String

创建邀请的时间。

updated_at

String

最后一次更新邀请的时间。
表5 PageInfo

参数

参数类型

描述

previous_marker

String

上一页的页面标识。

next_marker

String

下一页的页面标识。

current_count

Integer

页面数量。

请求示例

通过条件检索资源共享邀请。

POST https://{endpoint}/v1/resource-share-invitations/search

{
  "resource_share_ids" : [ "string" ],
  "resource_share_invitation_ids" : [ "string" ],
  "status" : "string",
  "limit" : 2000,
  "marker" : "string"
}

响应示例

状态码： 200

请求成功。

{
  "resource_share_invitations" : [ {
    "receiver_account_id" : "string",
    "resource_share_id" : "string",
    "resource_share_name" : "string",
    "resource_share_invitation_id" : "string",
    "sender_account_id" : "string",
    "status" : "string",
    "created_at" : "2022-09-23T06:43:43.999Z",
    "updated_at" : "2022-09-23T06:43:43.999Z"
  } ],
  "page_info" : {
    "previous_marker" : "string",
    "next_marker" : "string",
    "current_count" : 2000
  }
}

状态码

状态码

描述

200

请求成功。

错误码

请参见错误码。

父主题： 资源共享邀请

相关文档