全部产品
Search

搜索本产品

    资源管理：ListSharedResources - 查询共享或其他账号共享的资源列表

    文档中心

    资源管理：ListSharedResources - 查询共享或其他账号共享的资源列表

    更新时间：Apr 25, 2024

    查询共享的资源列表或者其他账号共享的资源列表。

    接口说明

    本文将提供一个示例，查询您在cn-hangzhou地域共享的资源列表。返回结果显示，您只共享过 1 个资源，即在共享单元rs-6GRmdD3X****内共享过VSwitch类型的资源vsw-bp1upw03qyz8n7us9****。

    调试

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

    授权信息

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

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

    请求参数

    名称类型必填描述示例值
    ResourceOwnerstring是

    共享单元归属者。取值：

    • Self：查询您创建的共享单元中，共享给其他账号的资源列表。
    • OtherAccounts：查询其他账号创建的共享单元中，共享给您的资源列表。
    		Self
    ResourceTypestring否

    共享资源类型。

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

    		VSwitch
    Targetstring否

    资源使用者 ID 或资源所有者 ID。取值：

    • 当ResourceOwner为Self时，该参数为资源使用者 ID。
    • 当ResourceOwner是OtherAccounts时，该参数为资源所有者 ID。
    		172050525300****
    MaxResultsinteger否

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

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

    		20
    NextTokenstring否

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

    		TGlzdFJlc291cm****
    ResourceShareIdsarray否

    共享单元 ID。

    N 的取值范围：1~5，即每次最多指定 5 个共享单元。

    string否

    共享单元 ID。

    		rs-6GRmdD3X****
    ResourceIdsarray否

    共享资源 ID。

    N 的取值范围：1~5，即每次最多指定 5 个共享资源。

    string否

    共享资源 ID。

    		vsw-bp1upw03qyz8n7us9****

    返回参数

    名称类型描述示例值
    object

    返回参数。

    NextTokenstring

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

    		TGlzdFJlc291cm****
    RequestIdstring

    请求 ID。

    		04677DCA-7C33-464B-8811-1B1DA3C3D197
    SharedResourcesobject []

    共享资源信息。

    UpdateTimestring

    更新关联资源的时间。

    		2020-12-07T07:39:02.921Z
    ResourceTypestring

    共享资源类型。

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

    		VSwitch
    CreateTimestring

    关联资源的时间。

    		2020-12-07T07:39:02.921Z
    ResourceShareIdstring

    共享单元 ID。

    		rs-6GRmdD3X****
    ResourceIdstring

    共享资源 ID。

    		vsw-bp1upw03qyz8n7us9****
    ResourceStatusstring

    共享资源状态。查询您共享的资源时不返回该参数，查询共享给您的资源时返回该参数。

    取值：

    • Available：资源可用。
    • ZonalResourceInaccessible：在当前可用区，资源不可用。
    • LimitExceeded：配额超限，资源不可用。
    • Unavailable：资源不可用。
    		Available
    ResourceStatusMessagestring

    关联失败的原因。

    		The reason for the association failure.

    示例

    正常返回示例

    JSON格式

    {
  "NextToken": "TGlzdFJlc291cm****",
  "RequestId": "04677DCA-7C33-464B-8811-1B1DA3C3D197",
  "SharedResources": [
    {
      "UpdateTime": "2020-12-07T07:39:02.921Z",
      "ResourceType": "VSwitch",
      "CreateTime": "2020-12-07T07:39:02.921Z",
      "ResourceShareId": "rs-6GRmdD3X****",
      "ResourceId": "vsw-bp1upw03qyz8n7us9****",
      "ResourceStatus": "Available",
      "ResourceStatusMessage": "The reason for the association failure. "
    }
  ]
}

    错误码

    HTTP status code错误码错误信息描述
    400MissingParameter.ResourceOwnerYou must specify ResourceOwner.ResourceOwner参数缺失。
    400InvalidParameter.ResourceOwnerThe ResourceOwner is invalid.ResourceOwner参数错误。
    400InvalidParameter.ResourceTypeThe ResourceType is invalid.传入的资源类型错误。
    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.ResourceIdsThe ResourceIds is invalid.传入的资源ID错误。
    400InvalidParameter.ResourceIds.DuplicateThe specified ResourceId contains duplicate values.传入的资源ID有重复项。
    400InvalidParameter.ResourceIds.LengthThe maximum number of ResourceIds (5) is exceeded.传入的资源ID数量超限（最大5个）。
    400InvalidParameter.TargetThe Target is invalid.资源所有者传参错误。
    400InvalidParameterThe specified parameter is invalid.参数无效。

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

    变更历史

    变更时间变更内容概要操作
    2024-01-24OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更。
      删除错误码：400
    2023-10-23OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更。
      删除错误码：400
    出参OpenAPI 返回结构发生变更。
    2023-10-23OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更。
      删除错误码：400
    出参OpenAPI 返回结构发生变更。