# 检索共享的资源 - SearchSharedResources #### 功能介绍 检索您共享的或共享给您的资源。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/RAM/doc?api=SearchSharedResources)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-ram/ram_04_0013.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | ram:sharedResources:search | List | - | - | - | - | #### URI POST /v1/shared-resources/search #### 请求参数 表1请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Security-Token | 否 | String | **参数解释**： 如果正在使用临时安全凭据，则此header是必需的，该值是临时安全凭据的安全令牌（会话令牌）。 **约束限制**： 不涉及 **取值范围**： 只能由英文字母、数字、加号、斜杠、等号及连字符组成，长度为1\~16384个字符。 **默认取值**： 不涉及 | 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | Integer | **参数解释**： 分页查询时每页返回的最大记录数量。 **约束限制**： 不涉及 **取值范围**： 1\~2000 **默认取值**： 2000 | | marker | 否 | String | **参数解释**： 分页标记，用于指定查询的起始位置。传入上一次查询返回的next_marker值可获取下一页数据。未传入此参数时查询第一页。 **约束限制**： 不涉及 **取值范围**： 只能由数字组成，长度为1\~64个字符。 **默认取值**： 不涉及 | | principal | 否 | String | **参数解释**： 指定资源使用者，支持账号ID或URN格式。 **约束限制**： 不涉及 **取值范围**： 只能由字母、数字、下划线、连字符、斜杠、星号、点号、冒号、圆括号、井号、@符号、问号、等号及百分号组成，长度为1\~1500个字符。 **默认取值**： 不涉及 | | resource_ids | 否 | Array of strings | **参数解释**： 指定资源ID列表。获取方式：通过查询资源列表接口获取。 **约束限制**： 不涉及 | | resource_urns | 否 | Array of strings | **参数解释**： 资源共享实例关联的一个或多个共享资源URN（统一资源名称）的列表。URN采用冒号分隔的5段格式：\[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br\]:\[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br\]:\[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br\]:\[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br\]:\[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br\]。 获取方式：通过查询共享资源列表接口获取。 **约束限制**： 不涉及 | | resource_owner | 是 | String | **参数解释**： 检索您创建的或共享给您的（self或者other-accounts）资源共享实例。 **约束限制**： 不涉及 **取值范围**： - self: 检索您创建的共享资源实例 - other-accounts: 检索共享给您的共享资源实例 **默认取值**： 不涉及 | | resource_share_ids | 否 | Array of strings | **参数解释**： 资源共享实例的ID列表。获取方式：通过创建资源共享实例或查询资源共享实例列表接口获取。 **约束限制**： 不涉及 | | resource_region | 否 | String | **参数解释**： 资源所在的区域。 **约束限制**： 不涉及 **取值范围**： 区域ID标识符，如cn-north-4、cn-east-3等。由小写字母、数字及连字符组成，且长度为0\~255个字符。 **默认取值**： 不涉及 | | resource_type | 否 | String | **参数解释**： 资源类型的名称。 **约束限制**： 仅支持 RAM 支持共享的资源类型（vpc:subnet，dns:zone，dns:resolverRule，scm:cert，pca:ca，er:instances，functiongraph:function，anc:service，anc:anc，nat:transitSubnet，kms:KeyId） **取值范围**： 只能由小写字母、数字及冒号组成，长度为1\~64个字符。或使用以下固定取值： - vpc:subnet：虚拟私有云子网。 - dns:zone：DNS区域。 - dns:resolverRule：DNS解析器规则。 - scm:cert：SCM证书。 - pca:ca：PCA证书颁发机构。 - er:instances：企业路由器实例。 - functiongraph:function：FunctionGraph函数。 - anc:service：ANC服务。 - anc:anc：ANC资源。 - nat:transitSubnet：NAT网关中转子网。 - kms:KeyId：KMS密钥。 **默认取值**： 不涉及 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | shared_resources | Array of [SharedResource] objects | **参数解释**： 共享资源的信息列表。 | | page_info | [PageInfo] object | **参数解释**： 分页详细信息。包含 previous_marker，next_marker 与 current_count 字段 | 表4SharedResource | 参数 | 参数类型 | 描述 | |:---|:---|:---| | resource_urn | String | **参数解释**： 指定绑定的共享资源URN。 resource_urn 为一个共享资源的URN，它的格式为 \:\:\:\:\ RAM 共享的资源分为 Region 级资源与 Global 资源，Global 资源不需要填入 \ 字段，如 dns:zone 资源：dns::7a3574da74e14bfd9c36d5b04f16afc7:zone:ff8080829932b91c0199366e4af051ba Region 级资源：vpc:subnet，scm:cert，dns:resolverRule，pca:ca，er:instances，functiongraph:function，anc:service，anc:anc，nat:transitSubnet，kms:KeyId Global 级资源：dns:zone **取值范围**： 只能由字母、数字、加号、斜杠、等号、连字符及下划线组成，采用冒号分隔的5段格式，其中第1段长度至少1个字符、第2段长度不超过255个字符、第3和第4段长度分别为1\~64个字符、第5段长度至少1个字符。且长度为1\~1500个字符。 | | 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。 **取值范围**： 不涉及 | | resource_type | String | **参数解释**： 资源类型。 **取值范围**： 只能由小写字母、数字及冒号组成，长度为0\~100个字符。 | | resource_share_id | String | **参数解释**： 资源共享实例的ID。 **取值范围**： 只能由英文字母、数字及'-'、'_'组成，长度为0\~36个字符。 | | status | String | **参数解释**： 绑定的当前状态。 **取值范围**： - associating：关联中。 - associated：已关联。 - disassociated：已解除关联。 - failed：关联失败。 | 表5PageInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | previous_marker | String | **参数解释**： 上一页的页面标识。 **取值范围**： 只能由数字组成，且长度为1\~64个字符 | | next_marker | String | **参数解释**： 下一页的页面标识。 **取值范围**： 只能由数字组成，且长度为1\~64个字符 | | current_count | Integer | **参数解释**： 当前页面的记录数量。 **取值范围**： 1\~2000 | #### 请求示例 检索您共享的或共享给您的资源。 ``` POST /v1/shared-resources/search { "limit" : 2000, "marker" : "0", "principal" : "string", "resource_ids" : [ "string" ], "resource_urns" : [ "dns::123abc:zone:123abc" ], "resource_owner" : "self", "resource_share_ids" : [ "string" ], "resource_region" : "string", "resource_type" : "vpc:subnet" } ``` #### 响应示例 **状态码：200** 请求成功。 ``` { "shared_resources" : [ { "resource_urn" : "dns::123abc:zone:123abc", "created_at" : "2022-09-19T02:32:23Z", "updated_at" : "2022-09-19T02:32:23Z", "resource_type" : "string", "resource_share_id" : "string", "status" : "associated" } ], "page_info" : { "previous_marker" : "0", "next_marker" : "2000", "current_count" : 2000 } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求成功。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-ram/ErrorCode.html)。