链接复制成功!
检索共享邀请 - SearchResourceShareInvitation
功能介绍
通过条件检索资源共享邀请。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
ram:resourceShareInvitations:search
Read
-
-
-
-
URI
POST /v1/resource-share-invitations/search
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Security-Token | 否 | String | 参数解释: 如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 约束限制: 不涉及 取值范围: 只能由英文字母、数字、加号、斜杠、等号及连字符组成,长度为1~16384个字符。 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| resource_share_ids | 否 | Array of strings | 参数解释: 资源共享实例的ID列表。获取方式:通过创建资源共享实例或查询资源共享实例列表接口获取。 约束限制: 不涉及 |
| resource_share_invitation_ids | 否 | Array of strings | 参数解释: 资源共享邀请的ID列表。获取方式:通过查询共享邀请列表接口获取。 约束限制: 不涉及 |
| status | 否 | String | 参数解释: 资源共享邀请的当前状态。 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| limit | 否 | Integer | 参数解释: 页面中最大结果数量。 约束限制: 不涉及 取值范围: 1~2000。 默认取值: 1000 |
| marker | 否 | String | 参数解释: 分页位置标识。从marker指定索引的下一条数据开始查询。查询第一页数据时,不需要传入此参数,查询后续页码数据时,将查询前一页数据响应体中marker值配入此参数。 约束限制: 不涉及 取值范围: 只能由数字组成,长度为1~64个字符。 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| resource_share_invitations | Array of ResourceShareInvitation objects | 资源共享邀请的详细信息。 |
| page_info | PageInfo object | 参数解释: 分页详细信息。包含 previous_marker,next_marker 与 current_count 字段 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| resource_share_name | String | 资源共享实例的名称。取值范围:只能由中文字符、英文字母、数字及“_”、“-”、“.”组成,长度为0~64个字符。 |
| resource_share_invitation_id | String | 资源共享邀请的ID。取值范围:只能由英文字母、数字及“_”、“-”组成,长度为1~36个字符。 |
| sender_account_id | String | 发送资源共享邀请的账号ID。取值范围:只能由英文字母、数字及“-”组成,长度为0~36个字符。 |
| receiver_account_id | String | 接收资源共享邀请的账号ID。取值范围:只能由英文字母、数字及“-”组成,长度为0~36个字符。 |
| resource_share_id | String | 资源共享实例的ID。取值范围:只能由英文字母、数字及“-”组成,长度为0~36个字符。 |
| status | String | 参数解释: 资源共享邀请的当前状态。 取值范围: |
| 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。 |
请求示例
通过条件检索资源共享邀请。
POST /v1/resource-share-invitations/search
{
"resource_share_ids" : [ "string" ],
"resource_share_invitation_ids" : [ "string" ],
"status" : "string",
"limit" : 2000,
"marker" : "0"
} 响应示例
状态码:200
请求成功。
{
"resource_share_invitations" : [ {
"receiver_account_id" : "string",
"resource_share_id" : "string",
"resource_share_name" : "string",
"resource_share_invitation_id" : "string",
"sender_account_id" : "string",
"status" : "string",
"created_at" : "2022-09-23T06:43:43.999Z",
"updated_at" : "2022-09-23T06:43:43.999Z"
} ],
"page_info" : {
"previous_marker" : "0",
"next_marker" : "2000",
"current_count" : 2000
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功。 |
错误码
请参见错误码。