历史记录
更新时间：2024-08-02
查询执行历史记录详情
查询某一命令执行记录或文件上传记录详情
请求参数
| 参数名称 | 类型 | 是否必选 | 描述 |
|---|---|---|---|
| id | String | 是 | 执行ID |
| pageNo | int | 否 | 返回子执行记录页码，默认值1 |
| pageSize | int | 否 | 返回子执行记录页大小，默认值10，最大值100 |
| childRunState | String | 否 | 根据子执行状态过滤子执行记录。枚举值：FAILED（执行失败），RUNNING（执行中），SUCCESS（执行完成） |
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| requestId | String | 执行详情 |
| code | String | 响应状态，成功为success |
| result | ActionRun | 执行详情 |
请求示例
Python
1from baidubce.auth.bce_credentials import BceCredentials
2from baidubce.bce_client_configuration import BceClientConfiguration
3from baidubce.services.ca import ca_client, ca_model
4if __name__ == '__main__':
5
6 HOST = b'http://ca.bj.baidubce.com'
7 AK = b''
8 SK = b''
9 config = BceClientConfiguration(credentials=BceCredentials(AK, SK),
10 endpoint=HOST)
11 ca_client = CaClient(config)
12 user_id = ''
13 id = 'r-raUPWwr933Liqe54'
14 response = ca_client.get_action_run(id, user_id)
15 print(response)响应示例
JSON
1{
2 "requestId": "8b051243-0760-4776-b8b5-024309******",
3 "code": "success",
4 "result": {
5 "id": "r-N0UrpENajU******",
6 "state": "SUCCESS",
7 "action": {
8 "type": "COMMAND",
9 "name": "auto_run_1711100283",
10 "description": "",
11 "timeoutSecond": 300,
12 "command": {
13 "type": "SHELL",
14 "content": "echo 'hello world'",
15 "scope": "INDIVIDUAL",
16 "enableParameter": false,
17 "workDir": "/",
18 "execParams": {
19 "name": "value"
20 },
21 "user": "root"
22 },
23 "createdTimestamp": 1711100284000,
24 "updatedTimestamp": 1711100316000
25 },
26 "createdTimestamp": 1711100286000,
27 "finishedTimestamp": 1711100286000,
28 "children": [
29 {
30 "id": "d-vVnBql******",
31 "state": "SUCCESS",
32 "target": {
33 "instanceId": "i-mfIg****",
34 "instanceType": "BCC",
35 },
36 "createdTimestamp": 1711100286503,
37 "finishedTimestamp": 1711100286576,
38 "output": {
39 "exitCode": 0,
40 "stderr": "",
41 "stdout": "hello world\n",
42 "isTruncated": false
43 }
44 }
45 ],
46 "totalCount": 1
47 }
48}查询执行记录列表
查询命令执行记录或文件上传记录列表
请求参数
| 参数名称 | 类型 | 是否必选 | 描述 |
|---|---|---|---|
| action | RunFilter | 是 | 执行记录过滤器 |
| pageNo | int | 是 | 页码 |
| pageSize | int | 是 | 页大小 |
| ascending | bool | 否 | 是否根据执行开始时间升序排列，默认为false |
| state | string | 否 | 根据执行状态过滤。枚举值：FAILED（执行失败），RUNNING（执行中），SUCCESS（执行完成） |
| runId | string | 否 | 根据执行ID过滤 |
| startTime | long | 否 | 时间筛选，Unix时间戳（毫秒）。执行开始时间 >= endTime,Unix时间戳（毫秒） |
| endTime | long | 否 | 时间筛选，Unix时间戳（毫秒）。执行开始时间 <= endTime，Unix时间戳（毫秒） |
RunFilter
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| type | string | 是 | RequestBody参数 | 执行记录类型。枚举值：COMMAND（命令执行记录），FILE_UPLOAD（文件上传记录） |
| id | string | 否 | RequestBody参数 | 通过命令ID筛选，仅对命令执行记录有效 |
| name | string | 否 | RequestBody参数 | 通过命令名称筛选，仅对命令执行记录有效 |
| fileUpload | FileUploadFilter | 否 | RequestBody参数 | 筛选命令上传记录 |
FileUploadFilter
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| filename | string | 是 | RequestBody参数 | 通过上传文件名称筛选 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| requestId | String | 执行详情 |
| code | String | 响应状态，成功为success |
| result | List<ActionRun> | 执行详情 |
请求示例
Python
1from baidubce.auth.bce_credentials import BceCredentials
2from baidubce.bce_client_configuration import BceClientConfiguration
3from baidubce.services.ca import ca_client, ca_model
4
5if __name__ == '__main__':
6
7 HOST = b'http://ca.bj.baidubce.com'
8 AK = b''
9 SK = b''
10 config = BceClientConfiguration(credentials=BceCredentials(AK, SK),
11 endpoint=HOST)
12 ca_client = CaClient(config)
13 action = ca_model.Action(
14 "", "", "COMMAND"
15 )
16 ascending = False
17 page_no = 1
18 page_size = 10
19 sort = "createTime"
20 user_id = ""
21 response = ca_client.action_run_list(action, page_no, page_size, sort, ascending, user_id)
22 self.assertEqual(type(response), baidubce.bce_response.BceResponse)
23 print(response)响应示例
JSON
1{
2 "requestId": "f5c8cbf2-b66b-4894-b98d-dae6cb******",
3 "code": "success",
4 "result": {
5 "pageNo": 1,
6 "pageSize": 10,
7 "totalCount": 2,
8 "data": [
9 {
10 "id": "r-QWR6CCMVj0******",
11 "state": "SUCCESS",
12 "action": {
13 "type": "COMMAND",
14 "timeoutSecond": 60,
15 "command": {
16 "type": "SHELL",
17 "content": "ls",
18 "scope": "INDIVIDUAL",
19 "enableParameter": false,
20 "workDir": "/home",
21 "user": "root"
22 }
23 },
24 "createdTimestamp": 1710837417000,
25 "finishedTimestamp": 1710837419000,
26 "statistics": {
27 "totalTargetCount": 1,
28 "failedTargetCount": 0
29 }
30 },
31 {
32 "id": "r-vufYpbTTyd******",
33 "state": "SUCCESS",
34 "action": {
35 "id": "c-5iEoMgGqXL******",
36 "type": "COMMAND",
37 "name": "auto_test_1709896691",
38 "description": "",
39 "timeoutSecond": 300,
40 "command": {
41 "type": "SHELL",
42 "content": "echo 'hello world'",
43 "scope": "INDIVIDUAL",
44 "enableParameter": false,
45 "workDir": "/",
46 "user": "root"
47 }
48 },
49 "createdTimestamp": 1709896693000,
50 "finishedTimestamp": 1709896697000,
51 "statistics": {
52 "totalTargetCount": 1,
53 "failedTargetCount": 0
54 }
55 }
56 ]
57 }
58}附录
ActionRun
| 参数名称 | 类型 | 描述 |
|---|---|---|
| id | String | 执行ID |
| action | Action | 所执行动作详情 |
| state | String | 执行状态。枚举值：FAILED（执行失败），RUNNING（执行中），SUCCESS（执行完成），PARTIAL_FAILED（部分失败） |
| createdTimestamp | long | 执行开始时间。unix时间戳，单位：毫秒 |
| finishedTimestamp | long | 执行结束时间，仅执行结束时返回。unix时间戳，单位：毫秒。 |
| statistics | Statistics | 子执行执行情况，仅查询执行记录列表时返回 |
ChildRun
| 参数名称 | 类型 | 描述 |
|---|---|---|
| id | String | 子执行ID |
| state | String | 执行状态。枚举值：FAILED（执行失败），RUNNING（执行中），SUCCESS（执行完成） |
| createdTimestamp | long | 子执行开始时间。unix时间戳，单位：毫秒 |
| finishedTimestamp | long | 子执行结束时间，仅执行结束时返回。unix时间戳，单位：毫秒。 |
| failReason | String | 子执行失败原因 |
| output | Output | 命令输出结果 |
| Target | Target | 子执行对应的实例信息 |
Output
| 参数名称 | 类型 | 描述 |
|---|---|---|
| exitCode | int | 退出码 |
| stdout | String | 标准输出 |
| stderr | String | 标准错误 |
| isTruncated | bool | 标准输出或标准错误是否由于过长（超过4KB）而被截断 |
Statistics
| 参数名称 | 类型 | 描述 |
|---|---|---|
| totalTargetCount | int | 执行的实例总数 |
| failedTargetCount | int | 已失败的执行实例总数 |