查询operation列表-ListOperations
功能介绍
查询operation列表接口,用于获取指定项目下所有操作记录的列表,支持按批量ID、操作类型、操作状态、资源ID等条件过滤。
查询完成后,将返回满足条件的操作记录分页列表,每条记录包含操作类型、状态、时间及关联资源等信息。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| aics::listOperations | List | - | - | - | - |
URI
GET /v2/{project_id}/operations
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| batch_id | 否 | String | 参数解释: 批量操作任务的ID,用于筛选同一批次提交的操作记录。 约束限制: 不涉及。 取值范围: UUID格式,[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}。 默认取值: 不涉及。 |
| operation_ids | 否 | Array of strings | 参数解释: 操作记录ID列表。可从查询操作记录列表接口获取。 约束限制: 最多100个ID,多个ID以逗号分隔。 取值范围: UUID格式,[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}。 默认取值: 不涉及。 |
| types | 否 | Array of strings | 参数解释: 操作类型列表,用于筛选指定类型的操作记录。 约束限制: 最多20个类型,多个类型以逗号分隔。 取值范围: 默认取值: 不涉及。 |
| status | 否 | Array of strings | 参数解释: 操作状态列表,用于筛选指定状态的操作记录。 约束限制: 最多10个状态,多个状态以逗号分隔。 取值范围: 默认取值: 不涉及。 |
| hypernode_ids | 否 | Array of strings | 参数解释: 超节点ID列表,用于筛选指定超节点的操作记录。可从查询超节点列表接口获取。 约束限制: 最多100个ID,多个ID以逗号分隔。 取值范围: UUID格式,[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}。 默认取值: 不涉及。 |
| node_ids | 否 | Array of strings | 参数解释: 节点ID列表,用于筛选指定节点的操作记录。可从查询节点列表接口获取。 约束限制: 最多100个ID,多个ID以逗号分隔。 取值范围: 长度1-64,只能由英文字母、数字及"_"、"-"、"."组成。 默认取值: 不涉及。 |
| cluster_id | 否 | String | 参数解释: 集群ID,用于筛选指定集群的操作记录。可从查询集群列表接口获取。 约束限制: 不涉及。 取值范围: UUID格式,[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}。 默认取值: 不涉及。 |
| limit | 否 | Integer | 参数解释: 分页查询单页记录数量。 约束限制: 不涉及。 取值范围: 1~100。 默认取值: 20。 |
| marker | 否 | String | 参数解释: 分页标记,本次请求获取该标记后的资源,base64编码。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 否 | String | 参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| operations | Array of Operation objects | 参数解释: 操作返回信息。 取值范围: 不涉及。 |
| page_info | PageInfo object | 参数解释: 分页信息。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| batch_id | String | 参数解释: 批量操作任务的ID,同一批次提交的操作共享此ID。 取值范围: UUID格式,[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}。 |
| id | String | 参数解释: 操作记录唯一标识。 取值范围: UUID格式,[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}。 |
| status | String | 参数解释: 操作状态。 取值范围: |
| type | String | 参数解释: 操作类型。 取值范围: |
| created_at | String | 参数解释: 操作记录创建时间。 取值范围: 不涉及。 |
| updated_at | String | 参数解释: 操作记录更新时间,操作成功或失败时更新。 取值范围: 不涉及。 |
| hypernode_id | String | 参数解释: 操作所属超节点ID。可从查询超节点列表接口获取。 取值范围: UUID格式,[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}。 |
| node_id | String | 参数解释: 操作所属节点ID。可从查询节点列表接口获取。超节点级别操作时该值为"all_nodes"。 取值范围: 不涉及。 |
| cluster_id | String | 参数解释: 操作所属集群ID。可从查询集群列表接口获取。 取值范围: UUID格式,[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}。 |
| error | OperationError object | 参数解释: 操作错误信息,操作失败时相关的报错信息。 取值范围: 不涉及。 |
请求示例
查询operation列表请求示例。使用场景:用户需要查询操作记录列表时,通过指定过滤条件查询。
GET https://{endpoint}/v2/{project_id}/operations?types=hypernode_create,node_stop&status=success 响应示例
状态码:200
OK
{
"operations" : [ {
"batch_id" : "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"id" : "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"status" : "success",
"type" : "hypernode_create",
"created_at" : "2024-01-01T00:00:00.000+08:00",
"updated_at" : "2024-01-01T00:00:00.000+08:00",
"hypernode_id" : "c3d4e5f6-a7b8-9012-cdef-123456789012",
"cluster_id" : "d4e5f6a7-b8c9-0123-defa-234567890123"
} ],
"page_info" : {
"next_marker" : null,
"current_count" : 1
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
错误码
请参见错误码。