检索不同的资源使用者或者资源所有者 - SearchDistinctPrincipals
功能介绍
检索您正在共享资源的不同使用者或共享给您的不同资源所有者。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
ram:sharedPrincipals:searchDistinctPrincipal
List
-
-
-
-
URI
POST /v1/shared-principals/search-distinct-principal
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Security-Token | 否 | String | 参数解释: 如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 约束限制: 不涉及 取值范围: 只能由英文字母、数字、加号、斜杠、等号及连字符组成,长度为1~16384个字符。 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| limit | 否 | Integer | 参数解释: 页面中最大结果的数量。 约束限制: 不涉及 取值范围: 1~2000。 默认取值: 2000 |
| marker | 否 | String | 参数解释: 页面标记。 约束限制: 不涉及 取值范围: 只能由数字组成,长度为 1~64 个字符。 默认取值: 不涉及 |
| principals | 否 | Array of strings | 参数解释: 指定资源使用者列表。数组元素为账号ID或URN格式的字符串。账号ID可通过IAM查询账号信息接口获取,URN可通过调用查询共享资源列表接口获取。 约束限制: 不涉及 |
| resource_urn | 否 | String | 参数解释: 指定资源的URN。可通过调用查询共享资源列表接口获取,或在校验资源详情页查看。 约束限制: 不涉及 取值范围: 只能由字母、数字、加号、斜杠、等号、连字符及下划线组成,采用冒号分隔的5段格式,其中第1段长度至少1个字符、第2段长度不超过255个字符、第3和第4段长度分别为1~64个字符、第5段长度至少1个字符。且总长度为0~1500个字符。 默认取值: 不涉及 |
| resource_owner | 是 | String | 参数解释: 指定查询的资源共享实例所有者类型。 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| distinct_shared_principals | Array of DistinctSharedPrincipal objects | 不同角色的信息列表。数组元素为DistinctSharedPrincipal对象,包含资源使用者标识、资源所有者标识、资源共享实例ID等信息。 |
| page_info | PageInfo object | 参数解释: 分页详细信息。包含 previous_marker,next_marker 与 current_count 字段 |
请求示例
检索您正在共享资源的不同使用者或共享给您的不同资源所有者。
POST /v1/shared-principals/search-distinct-principal
{
"limit" : 2000,
"marker" : "0",
"principals" : [ "string" ],
"resource_urn" : "string",
"resource_owner" : "self"
} 响应示例
状态码:200
请求成功。
{
"distinct_shared_principals" : [ {
"id" : "string",
"updated_at" : "2022-09-19T02:33:45Z"
} ],
"page_info" : {
"previous_marker" : "0",
"next_marker" : "2000",
"current_count" : 2000
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功。 |
错误码
请参见错误码。