功能介绍
检索您添加到资源共享或被共享给您的不同资源。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
| ram:sharedResources:searchDistinctResource | List | - | - | - | - |
URI
POST /v1/shared-resources/search-distinct-resource
请求参数
表2 请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 |
| limit | 否 | Integer | 参数解释: 页面中最大结果的数量。 约束限制: 不涉及 取值范围: 1~2000。 默认取值: 2000 |
| marker | 否 | String | 参数解释: 页面标记。 约束限制: 不涉及 取值范围: 只能由数字组成,长度为 1~64 个字符。 默认取值: 不涉及 |
| resource_ids | 否 | Array of strings | 参数解释: 指定资源ID。获取方式:通过查询资源列表接口获取。 约束限制: 不涉及 |
| principal | 否 | String | 参数解释: 指定资源使用者,支持账号ID或URN格式。 约束限制: 不涉及 取值范围: 只能由字母、数字、下划线、连字符、斜杠、星号、点号、冒号、圆括号、井号、@符号、问号、等号及百分号组成,长度为0~1500个字符。 默认取值: 不涉及 |
| resource_region | 否 | String | 参数解释: 资源所在的区域。 约束限制: 不涉及 取值范围: 区域 ID 标识符,如 cn-north-4、cn-east-3 等。由小写字母、数字及连字符组成,且长度为 0~255 个字符。 默认取值: 不涉及 |
| resource_urns | 否 | Array of strings | 参数解释: 指定资源URN的列表。 约束限制: 不涉及 |
| resource_owner | 是 | String | 参数解释: 指定查询的资源共享实例所有者类型。 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
响应参数
状态码:200
表3 响应Body参数 | 参数 | 参数类型 | 描述 |
| distinct_shared_resources | Array of DistinctSharedResource objects | 不同资源的信息列表。 |
| page_info | PageInfo object | 参数解释: 分页详细信息。包含 previous_marker,next_marker 与 current_count 字段 |
表4 DistinctSharedResource | 参数 | 参数类型 | 描述 |
| resource_urn | String | 参数解释: 资源的统一资源名称。 取值范围: 长度为0~1500个字符 |
| resource_type | String | 参数解释: 资源的类型。 取值范围: 长度为0~1500个字符 |
| updated_at | String | 参数解释: 最后一次更新资源共享实例的时间。UTC时间格式,格式为yyyy-MM-ddTHH:mm:ssZ,例如2020-09-25T12:05:00Z。 取值范围: 不涉及 |
表5 PageInfo | 参数 | 参数类型 | 描述 |
| previous_marker | String | 参数解释: 上一页的页面标识。 取值范围: 只能由数字组成,且长度为1~64个字符 |
| next_marker | String | 参数解释: 下一页的页面标识。 取值范围: 只能由数字组成,且长度为1~64个字符 |
| current_count | Integer | 参数解释: 当前页面的记录数量。 取值范围: 1~2000 |
请求示例
检索您添加到资源共享或被共享给您的不同资源。
POST /v1/shared-resources/search-distinct-resource
{
"limit" : 2000,
"marker" : "0",
"resource_ids" : [ "string" ],
"principal" : "string",
"resource_region" : "string",
"resource_urns" : [ "dns::123abc:zone:123abc" ],
"resource_owner" : "self"
} 响应示例
状态码:200
请求成功。
{
"distinct_shared_resources" : [ {
"resource_urn" : "string",
"resource_type" : "string",
"updated_at" : "2022-09-19T02:32:48.943Z"
} ],
"page_info" : {
"previous_marker" : "0",
"next_marker" : "2000",
"current_count" : 2000
}
}