查询实例命令执行结果
接口说明
查询通过 RunCompShareInstanceCommand 的 Type=async 提交的任务状态及执行结果。
POST
https://api.compshare.cnActionGetCompShareInstanceCommandResult使用与提交任务相同组织的云 API 签名凭据。任务不存在或不属于当前组织时,返回公共资源不存在错误。
查询流程
- 调用
RunCompShareInstanceCommand,设置Type=async,提交成功后保存TaskId。 - 使用
TaskId调用本接口;Status=Running时可间隔 3~5 秒再次查询,此时Result=null。 Status=Finished表示执行已结束,使用Result.RetCode判断命令是否成功,并读取Result.Output。
外层 RetCode=0 仅表示查询成功。即使 Status=Finished,命令也可能执行失败。
使用说明
- 本接口只查询异步任务;同步执行不会生成可查询的任务 ID。
- 执行期间不返回实时输出,执行结束后一次性返回结果。
- 建议为轮询设置超时。服务异常退出等情况下,任务可能持续显示
Running;超时后应保留TaskId排查,不要据此重新提交命令。 - 执行预算、输出上限和后台进程清理规则与 执行命令接口 一致。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Action | String | 是 | 接口名称 | GetCompShareInstanceCommandResult |
| TaskId | String | 是 | 异步提交成功时返回的任务 ID,不能为空 | 673000000000000000000001 |
无需传入 InstanceId、Region 或 Zone。
响应参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| RetCode | Integer | 查询返回码,0 表示查询成功 | 0 |
| Status | String | 任务状态:Running 表示执行中;Finished 表示执行结束,包含执行成功和失败 | Finished |
| Result | Object / Null | 执行结果;Running 时为 null,Finished 时为下表所示对象 | {"RetCode":0,"Output":"hello\n"} |
Result
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| RetCode | Integer | 命令执行结果码:0 为成功,226656 为执行相关失败;不是 Bash 进程退出码 | 0 |
| Output | String | 标准输出与标准错误的合并文本,最多 1 MiB;失败时可能有部分输出,无输出时为空字符串 | hello\n |
查询失败时沿用公共错误格式,根据外层 RetCode、Message 排查,不保证包含 Status 或 Result。
请求示例
请求参数
以下 JSON 展示业务参数,实际请求还需签名:
{
"Action": "GetCompShareInstanceCommandResult",
"TaskId": "673000000000000000000001"
}Python(使用 UCloud SDK)
安装 SDK,并配置与提交任务相同组织的 API 密钥及任务 ID:
python -m pip install "ucloud-sdk-python3==0.11.153"
export COMPSHARE_ACCESS_KEY_ID='<AccessKey ID>'
export COMPSHARE_ACCESS_KEY_SECRET='<AccessKey Secret>'
export COMPSHARE_COMMAND_TASK_ID='<异步提交返回的 TaskId>'以下示例查询一次。执行中可间隔 3~5 秒再次运行,或在业务代码中进行有超时限制的轮询:
import json
import os
from ucloud.client import Client
from ucloud.core import exc
def main():
client = Client({
"public_key": os.environ["COMPSHARE_ACCESS_KEY_ID"],
"private_key": os.environ["COMPSHARE_ACCESS_KEY_SECRET"],
"base_url": "https://api.compshare.cn",
"timeout": 30,
"max_retries": 0,
}).ucompshare()
try:
response = client.invoke(
"GetCompShareInstanceCommandResult",
{"TaskId": os.environ["COMPSHARE_COMMAND_TASK_ID"]},
)
except exc.RetCodeException as error:
print("查询失败:", error)
return
if response["Status"] == "Running":
print("执行中,请稍后使用同一 TaskId 查询")
return
result = response["Result"]
print("执行成功" if result["RetCode"] == 0 else "执行失败")
print(json.dumps(result, ensure_ascii=False, indent=2))
if __name__ == "__main__":
main()命令失败时外层 RetCode 仍可为 0,SDK 不会因此抛出 RetCodeException,需要检查 Result.RetCode。网络错误、HTTP 错误和超时仍会抛出异常。
响应示例
执行中
{
"RetCode": 0,
"Status": "Running",
"Result": null
}执行结束且成功
{
"RetCode": 0,
"Status": "Finished",
"Result": {
"RetCode": 0,
"Output": "hello\n"
}
}执行结束但失败
{
"RetCode": 0,
"Status": "Finished",
"Result": {
"RetCode": 226656,
"Output": "before-error\n"
}
}Last updated on