AI 助理
备案控制台
文档
输入文档关键字查找
首页 资源管理 资源共享 开发参考 API参考 API目录 共享邀请 ListResourceShareInvitations - 查询收到的资源共享邀请信息

ListResourceShareInvitations - 查询收到的资源共享邀请信息

更新时间：
产品详情
我的收藏

资源使用者调用ListResourceShareInvitations查询自己收到的资源共享邀请信息。

接口说明

使用说明

本文将提供一个示例，查询当前账号在cn-hangzhou地域收到的资源共享邀请。返回结果显示，共收到 1 个邀请，且处于等待确认状态。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。
  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
    • 对于必选的资源类型，用背景高亮的方式表示。
    • 对于不支持资源级授权的操作，用全部资源表示。
  • 条件关键字：是指云产品自身定义的条件关键字。
  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
操作访问级别资源类型条件关键字关联操作
resourcesharing:ListResourceShareInvitationslist
*全部资源
*
    无
无

请求参数

名称类型必填描述示例值
MaxResultsinteger否

单次请求返回结果的最大条数。

取值范围：1~100。默认值：20。

20
NextTokenstring否

当请求的返回结果被截断时，您可以使用NextToken再次发起请求，获取从当前截断位置之后的内容。

TGlzdFJlc291cm****
ResourceShareIdsarray否

共享单元 ID。

string否

共享单元 ID。

rs-ysGRci9z****
ResourceShareInvitationIdsarray否

资源共享邀请 ID。

string否

资源共享邀请 ID。

i-p6eRytrkjVvM****

关于公共请求参数的详情，请参见公共参数。

返回参数

名称类型描述示例值
object

返回结果。

NextTokenstring

当请求的返回结果被截断时，您可以使用NextToken再次发起请求，获取从当前截断位置之后的内容。

TGlzdFJlc291cm****
RequestIdstring

请求 ID。

30EC8328-1BDE-51D5-BFAB-039508BD91A1
ResourceShareInvitationsarray<object>

资源共享邀请信息。

ResourceShareInvitationobject

资源共享邀请信息。

Statusstring

邀请状态。取值：

  • Pending：等待确认。
  • Accepted：接受邀请成功。
  • Cancelled：已取消。
  • Rejected：已拒绝。
  • Expired：已过期。
  • AcceptFailed：接受邀请失败。
Pending
CreateTimestring

邀请创建时间（UTC 时间）。

2022-08-18T05:36:45.024Z
ResourceShareIdstring

共享单元 ID。

rs-ysGRci9z****
ResourceShareNamestring

共享单元名称。

example
SenderAccountIdstring

邀请者的阿里云账号 ID。

151266687691****
ReceiverAccountIdstring

被邀请者的阿里云账号 ID。

134254031178****
ResourceShareInvitationIdstring

资源共享邀请 ID。

i-p6eRytrkjVvM****
InvitationFailedDetailsarray<object>

接受共享单元邀请或退出共享单元检查失败详细原因。

InvitationFailedDetailobject

接受共享单元邀请或退出共享单元检查失败详细原因。

Statusstring

已弃用。请使用 FailureReason。

无
StatusMessagestring

已弃用。请使用 FailureDescription。

无
AssociateTypestring

已弃用。请使用 OperationType。

无
ResourceIdstring

共享资源 ID。

s-7xvh46nx5oqlre0wv***
ResourceTypestring

共享资源类型。

支持共享的资源类型，请参见支持资源共享的云服务。

Snapshot
FailureReasonstring

接受或退出共享单元检查失败时的原因。取值：

  • Unavailable：资源不可以共享。
  • LimitExceeded：资源可共享账号配额超限。
  • ZonalResourceInaccessible： 资源在此地域不可用。
  • InternalError：检查过程服务器内部出现错误。
  • UnsupportedOperation：不支持执行操作。
Unavailable
FailureDescriptionstring

接受或退出共享单元检查失败时的详细原因描述。

You cannot access the specified resource at this time.
OperationTypestring

操作类型。取值：

  • Associate：关联。
  • Disassociate：解除关联。
Associate

示例

正常返回示例

JSON格式

{
  "NextToken": "TGlzdFJlc291cm****",
  "RequestId": "30EC8328-1BDE-51D5-BFAB-039508BD91A1",
  "ResourceShareInvitations": [
    {
      "Status": "Pending",
      "CreateTime": "2022-08-18T05:36:45.024Z",
      "ResourceShareId": "rs-ysGRci9z****",
      "ResourceShareName": "example",
      "SenderAccountId": "151266687691****",
      "ReceiverAccountId": "134254031178****",
      "ResourceShareInvitationId": "i-p6eRytrkjVvM****",
      "InvitationFailedDetails": [
        {
          "Status": "无",
          "StatusMessage": "无",
          "AssociateType": "无",
          "ResourceId": "s-7xvh46nx5oqlre0wv***",
          "ResourceType": "Snapshot",
          "FailureReason": "Unavailable",
          "FailureDescription": "You cannot access the specified resource at this time.",
          "OperationType": "Associate"
        }
      ]
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameter.MaxResultsThe MaxResults is invalid.MaxResults参数错误。
400InvalidParameter.NextTokenThe NextToken is invalid.NextToken参数错误。
400InvalidParameter.NextToken.LengthThe maximum length of NextToken exceeds 256 characters.NextToken长度超限（最大256个字符）。
400InvalidParameter.ResourceShareIdsThe ResourceShareIds is invalid.ResourceShareIds参数错误。
400InvalidParameter.ResourceShareIds.DuplicateThe ResourceShareIds contains duplicate values.ResourceShareIds有重复项。
400InvalidParameter.ResourceShareIds.LengthThe maximum length of ResourceShareIds exceeds 5 characters.ResourceShareIds长度超限（最大5个）。
400InvalidParameter.ResourceShareInvitationIdsThe ResourceShareInvitationIds is invalid.参数ResourceShareInvitationIds非法。
400InvalidParameter.ResourceShareInvitationIds.DuplicateThe ResourceShareInvitationIds duplicate values.参数ResourceShareInvitationIds重复。
400InvalidParameter.ResourceShareInvitationIds.LengthThe maximum length of ResourceShareInvitationIds exceeds quota limit.ResourceShareInvitationIds长度超限。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-02-04OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2023-12-25OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
上一篇：共享邀请下一篇：AcceptResourceShareInvitation - 接受资源共享邀请
文档推荐