AI 助理
备案控制台
文档
输入文档关键字查找
首页 资源管理 资源共享 开发参考 API参考 API目录 共享单元 ListResourceShares - 查询共享单元列表

ListResourceShares - 查询共享单元列表

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

查询共享单元列表。

接口说明

本文将提供一个示例，查询当前账号在cn-hangzhou地域创建的共享单元列表。返回结果显示，当前账号151266687691****创建过以下 2 个共享单元：

  • 共享单元rs-hX9wC5jO****，处于已删除Deleted状态。
  • 共享单元rs-PqysnzIj****，处于已启用Active状态。

调试

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

授权信息

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

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

请求参数

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

共享单元归属者。取值：

  • Self：查询当前账号的共享单元列表。
  • OtherAccounts：查询其他账号共享给当前账号的共享单元列表。
Self
ResourceShareNamestring否

共享单元名称。

test
ResourceShareStatusstring否

共享单元状态。取值：

  • Active：已启用。
  • Pending：待确认。
  • Deleting：删除中。
  • Deleted：已删除。
说明 Deleted 状态的共享单元记录，会在 48~96 小时内被系统自动删除。
Active
MaxResultsinteger否

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

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

20
NextTokenstring否

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

TGlzdFJlc291cm****
ResourceShareIdsarray否

共享单元 ID。

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

string否

共享单元 ID。

rs-PqysnzIj****
PermissionNamestring否

共享权限名称。具体信息，请参见权限库。

AliyunRSDefaultPermissionVSwitch

返回参数

名称类型描述示例值
object

返回参数。

NextTokenstring

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

TGlzdFJlc291cm****
RequestIdstring

请求 ID。

2F23CFB6-A721-4E90-AC1E-0E30FA8B45DA
ResourceSharesobject []

共享单元信息。

UpdateTimestring

共享单元更新时间。

2020-12-03T08:01:43.638Z
ResourceShareNamestring

共享单元名称。

test
ResourceShareOwnerstring

共享单元归属者。

151266687691****
CreateTimestring

共享单元创建时间。

2020-12-03T02:20:31.292Z
ResourceShareIdstring

共享单元 ID。

rs-PqysnzIj****
ResourceShareStatusstring

共享单元状态。取值：

  • Active：已启用。
  • Pending：待确认。
  • Deleting：删除中。
  • Deleted：已删除。
说明 Deleted 状态的共享单元记录，会在 48~96 小时内被系统自动删除。
Active
AllowExternalTargetsboolean

是否允许共享给资源目录外的账号。取值：

  • false：仅允许资源目录内共享。
  • true：允许共享给任意账号。
false

示例

正常返回示例

JSON格式

{
  "NextToken": "TGlzdFJlc291cm****",
  "RequestId": "2F23CFB6-A721-4E90-AC1E-0E30FA8B45DA",
  "ResourceShares": [
    {
      "UpdateTime": "2020-12-03T08:01:43.638Z",
      "ResourceShareName": "test",
      "ResourceShareOwner": "151266687691****",
      "CreateTime": "2020-12-03T02:20:31.292Z",
      "ResourceShareId": "rs-PqysnzIj****",
      "ResourceShareStatus": "Active",
      "AllowExternalTargets": false
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400MissingParameter.ResourceOwnerYou must specify ResourceOwner.ResourceOwner参数缺失。
400InvalidParameter.ResourceOwnerThe ResourceOwner is invalid.ResourceOwner参数错误。
400InvalidParameter.ResourceShareNameThe ResourceShareName is invalid.共享单元名称无效。
400InvalidParameter.ResourceShareName.LengthThe maximum length of ResourceShareName exceeds 50 characters.共享单元名称字数超长（最大50字符）。
400InvalidParameter.ResourceShareStatusThe ResourceShareStatus is invalid.ResourceShareStatus参数错误。
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个）。
400InvalidParameterThe specified parameter is invalid.参数无效。

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

变更历史

变更时间变更内容概要操作
2023-04-03OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更。
    删除错误码：400
入参OpenAPI 入参发生变更。
    删除入参：ResourceGroupId
出参OpenAPI 返回结构发生变更。
2023-03-02OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更。
    删除错误码：400
入参OpenAPI 入参发生变更。
    新增入参：ResourceGroupId
出参OpenAPI 返回结构发生变更。
上一篇：CreateResourceShare - 创建共享单元下一篇：UpdateResourceShare - 修改共享单元名称
文档推荐