链接复制成功!
检索绑定的资源使用者和共享资源 - SearchResourceShareAssociations
功能介绍
检索您拥有的资源共享实例中绑定的共享资源和资源使用者。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
ram:resourceShares:searchResourceShareAssociations
Read
-
-
-
-
URI
POST /v1/resource-share-associations/search
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Security-Token | 否 | String | 参数解释: 如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 约束限制: 不涉及 取值范围: 只能由英文字母、数字组成,且长度为至少 1 个字符 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| association_status | 否 | String | 参数解释: 绑定的当前状态。 约束限制: 不涉及 取值范围: 由[0-36]个字符组成 默认取值: 不涉及 |
| association_type | 是 | String | 参数解释: 指定绑定的类型(principal或resource)。 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| limit | 否 | Integer | 参数解释: 分页页面的大小。 约束限制: 不涉及 取值范围: 只支持数字,最小值为 1,最大值为 2000 默认取值: |
| marker | 否 | String | 参数解释: 页面标记,基于上一页页面标记取值,空字符串表明查询第一页。 约束限制: 不涉及 取值范围: 只支持数字,最小值为 1,最大值为 64 默认取值: 不涉及 |
| principal | 否 | String | 参数解释: 指定绑定的资源使用者。 约束限制: 不涉及 取值范围: 只能由字母、数字、下划线、连字符、斜杠、星号、点号、冒号、圆括号、井号、@符号、问号、等号及百分号组成,且长度为[0~1500]个字符。 默认取值: 不涉及 |
| resource_urn | 否 | String | 参数解释: 指定绑定的共享资源URN。 约束限制: resource_urn 为一个共享资源的URN,它的格式为 <service-name>:<region>:<account-id>:<type-name>:<resource-path> RAM 共享的资源分为 Region 级资源与 Global 资源,Global 资源不需要填入 <region> 字段,如 dns:zone 资源:dns::7a3574da74e14bfd9c36d5b04f16afc7:zone:ff8080829932b91c0199366e4af051ba Region 级资源:vpc:subnet,scm:cert,dns:resolverRule,scm:cert,pca:ca,er:instances,functiongraph:function,anc:service,anc:anc,nat:transitSubnet,kms:KeyId Global 级资源:dns:zone 取值范围: 只能由字母、数字、加号、斜杠、等号、连字符及下划线组成,采用冒号分隔的5段格式,其中第1、3、4段长度分别为至少1个字符、第2段长度不超过255个字符、第5段长度至少1个字符。且长度为[0~1500]个字符。 默认取值: 不涉及 |
| resource_share_ids | 否 | Array of strings | 参数解释: 资源共享实例的ID列表。 约束限制: 不涉及 |
| resource_ids | 否 | Array of strings | 参数解释: 指定资源ID列表。 约束限制: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| resource_share_associations | Array of ResourceShareAssociation objects | 参数解释: 绑定的详细信息列表。 约束限制: 不涉及 |
| page_info | PageInfo object | 参数解释: 分页详细信息。包含 previous_marker,next_marker 与 current_count 字段 约束限制: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| associated_entity | String | 参数解释: 绑定的实体。这可以是共享资源的URN、账号ID、共享资源目录的URN或文件夹的URN之一。 约束限制: 不涉及 取值范围: 由[0-1500]个字符组成 默认取值: 无默认值 |
| association_type | String | 参数解释: 绑定中包含的实体类型。 约束限制: 不涉及 取值范围: 由[0-1500]个字符组成 默认取值: 无默认值 |
| created_at | String | 参数解释: 绑定被创建的时间。 约束限制: 不涉及 取值范围: 对应 RFC 3339 规范的日期时间格式,yyyy-MM-ddTHH:mm:ss.SSSZ 默认取值: 不涉及 |
| updated_at | String | 参数解释: 最后一次更新绑定的时间。 约束限制: 不涉及 取值范围: 对应 RFC 3339 规范的日期时间格式,yyyy-MM-ddTHH:mm:ss.SSSZ 默认取值: 不涉及 |
| external | Boolean | 参数解释: 标识资源使用者是否和共享的拥有者属于同一个组织。 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| resource_share_id | String | 参数解释: 资源共享实例的ID。 约束限制: 不涉及 取值范围: 由[0-36]个字符组成 默认取值: 不涉及 |
| resource_share_name | String | 参数解释: 资源共享实例的名称。 约束限制: 不涉及 取值范围: 由[0-64]个字符组成 默认取值: 不涉及 |
| status | String | 参数解释: 绑定的当前状态。 约束限制: 不涉及 取值范围: 由[0-36]个字符组成 默认取值: 不涉及 |
| status_message | String | 参数解释: 绑定的当前状态的描述。 约束限制: 不涉及 取值范围: 由[0-36]个字符组成 默认取值: 不涉及 |
请求示例
检索您拥有的资源共享实例中绑定的共享资源和资源使用者。
POST /v1/resource-share-associations/search
{
"association_status" : "string",
"association_type" : "principal",
"limit" : 2000,
"marker" : "string",
"principal" : "string",
"resource_urn" : "string",
"resource_share_ids" : [ "string" ],
"resource_ids" : [ "string" ]
} 响应示例
状态码:200
请求成功。
{
"resource_share_associations" : [ {
"associated_entity" : "string",
"association_type" : "string",
"created_at" : "2022-09-19T02:10:16.960Z",
"updated_at" : "2022-09-19T02:10:16.960Z",
"external" : true,
"resource_share_id" : "string",
"resource_share_name" : "string",
"status" : "string",
"status_message" : "string"
} ],
"page_info" : {
"previous_marker" : "string",
"next_marker" : "string",
"current_count" : 2000
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功。 |
错误码
请参见错误码。