查询共享单元列表。
接口说明
本文将提供一个示例,查询当前账号在cn-hangzhou
地域创建的共享单元列表。返回结果显示,当前账号151266687691****
创建过以下 2 个共享单元:
- 共享单元
rs-hX9wC5jO****
,处于已删除Deleted
状态。 - 共享单元
rs-PqysnzIj****
,处于已启用Active
状态。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
*全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ResourceOwner | string | 是 | 共享单元归属者。取值:
| Self |
ResourceShareName | string | 否 | 共享单元名称。 | test |
ResourceShareStatus | string | 否 | 共享单元状态。取值:
说明
Deleted 状态的共享单元记录,会在 48~96 小时内被系统自动删除。
| Active |
MaxResults | integer | 否 | 单次请求返回结果的最大条数。 取值范围:1~100。默认值:20。 | 20 |
NextToken | string | 否 | 当请求的返回结果被截断时,您可以使用 | TGlzdFJlc291cm**** |
ResourceShareIds | array | 否 | 共享单元 ID。 N 的取值范围:1~5,即每次最多指定 5 个共享单元。 | |
string | 否 | 共享单元 ID。 | rs-PqysnzIj**** | |
PermissionName | string | 否 | 共享权限名称。具体信息,请参见权限库。 | AliyunRSDefaultPermissionVSwitch |
ResourceGroupId | string | 否 | 资源组 ID。 | rg-aekz5nlvlak**** |
Tag | array<object> | 否 | 标签列表。 | |
object | 否 | 标签列表。 | ||
Key | string | 否 | 标签键。 说明
最多支持 128 个字符,不能以 aliyun 和acs: 开头,不能包含http:// 或者https:// 。
| k1 |
Value | string | 否 | 标签值。 说明
最多支持 128 个字符,不能以 acs: 开头,不能包含http:// 或者https:// 。
| v1 |
返回参数
示例
正常返回示例
JSON
格式
{
"NextToken": "TGlzdFJlc291cm****",
"RequestId": "2F23CFB6-A721-4E90-AC1E-0E30FA8B45DA",
"ResourceShares": [
{
"AllowExternalTargets": false,
"CreateTime": "2020-12-03T02:20:31.292Z",
"ResourceGroupId": "rg-aekz5nlvlak****",
"ResourceShareId": "rs-PqysnzIj****",
"ResourceShareName": "test",
"ResourceShareOwner": "151266687691****",
"ResourceShareStatus": "Active",
"Tags": [
{
"Key": "k1",
"Value": "v1"
}
],
"UpdateTime": "2020-12-03T08:01:43.638Z"
}
]
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
ResourceOwner参数缺失。 | |||
ResourceOwner参数错误。 | |||
共享单元名称无效。 | |||
共享单元名称字数超长(最大50字符)。 | |||
ResourceShareStatus参数错误。 | |||
MaxResults参数错误。 | |||
NextToken参数错误。 | |||
NextToken长度超限(最大256个字符)。 | |||
ResourceShareIds参数错误。 | |||
ResourceShareIds有重复项。 | |||
ResourceShareIds长度超限(最大5个)。 | |||
参数无效。 | |||
当共享单元归属者设置为OtherAccounts时,不允许传入标签参数。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
查看变更详情 | ||
查看变更详情 |