# 检索资源共享实例 - SearchResourceShares #### 功能介绍 检索您创建的或者共享给您的资源共享实例详情。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/RAM/doc?api=SearchResourceShares)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-ram/ram_04_0013.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | ram:resourceShares:search | Read | - | g:TagKeys | - | - | #### URI POST /v1/resource-shares/search #### 请求参数 表1请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Security-Token | 否 | String | **参数解释**： 如果正在使用临时安全凭据，则此header是必需的，该值是临时安全凭据的安全令牌（会话令牌）。 **约束限制**： 不涉及 **取值范围**： 只能由英文字母、数字、加号、斜杠、等号及连字符组成，长度为1\~16384个字符。 **默认取值**： 不涉及 | 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | Integer | **参数解释**： 分页查询时每页返回的最大记录数量。 **约束限制**： 不涉及 **取值范围**： 1\~2000 **默认取值**： 2000 | | name | 否 | String | **参数解释**： 资源共享实例名称。 **约束限制**： 不涉及 **取值范围**： 只能由中文、英文字母、数字、下划线、点号、连字符组成，长度为0\~64个字符。 **默认取值**： 不涉及 | | marker | 否 | String | **参数解释**： 分页标记，用于指定查询的起始位置。传入上一次查询返回的next_marker值可获取下一页数据。未传入此参数时查询第一页。 **约束限制**： 不涉及 **取值范围**： 只能由数字组成，长度为1\~64个字符。 **默认取值**： 不涉及 | | permission_id | 否 | String | **参数解释**： 权限ID。获取方式：通过查询共享资源权限列表接口获取。 **约束限制**： 不涉及 **取值范围**： 只能由英文字母、数字及"_"、"-"组成，且长度为0\~36个字符。 **默认取值**： 不涉及 | | resource_owner | 是 | String | **参数解释**： 检索您创建的或共享给您的（self或者other-accounts）资源共享实例。 **约束限制**： 不涉及 **取值范围**： - self: 检索您创建的共享资源实例 - other-accounts: 检索共享给您的共享资源实例 **默认取值**： 不涉及 | | resource_share_ids | 否 | Array of strings | **参数解释**： 资源共享实例的ID列表。获取方式：通过创建资源共享实例或查询资源共享实例列表接口获取。 **约束限制**： 不涉及 | | resource_share_status | 否 | String | **参数解释**： 资源共享实例的状态。 **约束限制**： 不涉及 **取值范围**： - active：资源共享实例处于活跃状态。 - deleting：资源共享实例正在删除中。 - deleted：资源共享实例已删除。 - failed：资源共享实例创建失败。 **默认取值**： 不涉及 | | tag_filters | 否 | Array of [TagFilter] objects | **参数解释**： 资源共享实例的标签。 **约束限制**： 不涉及 | 表3TagFilter | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | key | 是 | String | **参数解释**： 标签"键"的标识符或名称。 **约束限制**： 不涉及 **取值范围**： 只能由字母、数字、中文、下划线、点号、冒号、等号、加号、连字符、@符号及空格组成，不能以空格或"sys"开头，也不能以空格结尾。且长度为1\~128个字符。 **默认取值**： 不涉及 | | values | 否 | Array of strings | **参数解释**： 标签"键"对应的"值"。您可以将标签的值设置为空字符串，但不能设置为null。每个标签值只能由字母、数字、中文、下划线、点号、冒号、斜杠、等号、加号、连字符、@符号及空格组成，长度为0\~255个字符。 **约束限制**： 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | resource_shares | Array of [ResourceShare] objects | **参数解释**： 资源共享实例的详细信息列表。 | | page_info | [PageInfo] object | **参数解释**： 分页详细信息。包含 previous_marker，next_marker 与 current_count 字段 | 表5ResourceShare | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： 资源共享实例的ID **取值范围**： 只能由英文字母、数字及"-"组成，长度为1\~36个字符。 | | name | String | **参数解释**： 资源共享实例的名称。 **取值范围**： 只能由中文字符、英文字母、数字及"_"、"-"、"."组成，长度为1\~64个字符。 | | description | String | **参数解释**： 资源共享实例的描述。 **取值范围**： 不涉及。 | | allow_external_principals | Boolean | **参数解释**： 资源共享实例是否支持共享给组织外账号。 **取值范围**： - false: 资源共享实例不支持共享给组织外账号。 - true: 资源共享实例支持共享给组织外账号。 | | owning_account_id | String | **参数解释**： 资源共享实例的所有者ID。 **取值范围**： 只能由英文字母、数字及"-"组成，长度为1\~36个字符。 | | status | String | **参数解释**： 资源共享实例的状态。 **取值范围**： - active：资源共享实例处于活跃状态。 - deleting：资源共享实例正在删除中。 - deleted：资源共享实例已删除。 - failed：资源共享实例创建失败。 | | tags | Array of [Tag] objects | **参数解释**： 资源共享实例的标签列表。 | | created_at | String | **参数解释**： 创建资源共享实例的时间。UTC时间格式，格式为yyyy-MM-ddTHH:mm:ssZ，例如2020-09-25T12:05:00Z。 **取值范围**： 不涉及 | | updated_at | String | **参数解释**： 最后一次更新资源共享实例的时间。UTC时间格式，格式为yyyy-MM-ddTHH:mm:ssZ，例如2020-09-25T12:05:00Z。 **取值范围**： 不涉及 | 表6Tag | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释**： 标签"键"的标识符或名称。 **取值范围**： 只能由字母、数字、中文、下划线、点号、冒号、等号、加号、连字符、@符号及空格组成，不能以空格或"sys"开头，也不能以空格结尾。且长度为1\~128个字符。 | | value | String | **参数解释**： 标签"键"对应的"值"。您可以将标签的值设置为空字符串，但不能设置为null。 **取值范围**： 只能由字母、数字、中文、下划线、点号、冒号、斜杠、等号、加号、连字符、@符号及空格组成。且长度为0\~255个字符。 | 表7PageInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | previous_marker | String | **参数解释**： 上一页的页面标识。 **取值范围**： 只能由数字组成，且长度为1\~64个字符 | | next_marker | String | **参数解释**： 下一页的页面标识。 **取值范围**： 只能由数字组成，且长度为1\~64个字符 | | current_count | Integer | **参数解释**： 当前页面的记录数量。 **取值范围**： 1\~2000 | #### 请求示例 检索您创建的资源共享实例详情。 ``` POST /v1/resource-shares/search { "limit" : 2000, "name" : "string", "marker" : "0", "permission_id" : "string", "resource_owner" : "self", "resource_share_ids" : [ "string" ], "resource_share_status" : "active", "tag_filters" : [ { "key" : "string", "values" : [ "string" ] } ] } ``` #### 响应示例 **状态码：200** 请求成功。 ``` { "resource_shares" : [ { "id" : "string", "name" : "string", "description" : "string", "allow_external_principals" : true, "owning_account_id" : "string", "status" : "active", "tags" : [ { "key" : "string", "value" : "string" } ], "created_at" : "2023-01-06T08:24:55Z", "updated_at" : "2023-01-06T08:24:55Z" } ], "page_info" : { "previous_marker" : "0", "next_marker" : "2000", "current_count" : 2000 } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求成功。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-ram/ErrorCode.html)。