# 展示脚本工单基本信息 - ShowScriptOrderBasicInfo #### 功能介绍 查询脚本工单的基本执行信息。 #### 接口约束 返回信息：执行类型、执行名称、创建人、创建时间、结束时间、执行状态、标签（脚本id，脚本名，执行脚本参数，执行用户，超时时长、成功率阈值）。 不同的任务类型消费标签中的不同key。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/COC/doc?api=ShowScriptOrderBasicInfo)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-coc/coc_api_06.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | coc:job:get | Read | job \* | - | - | - | | coc:job:get | Read | - | coc:JobType | - | - | #### URI GET /v1/job/script/orders/{execute_uuid} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | execute_uuid | 是 | String | **参数解释：** 脚本工单的执行Id，取自executeJobScript和ListJobScriptOrders返回体中。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 租户token。 **约束限制：** 从IAM获取的租户token。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | X-Language | 否 | String | **参数解释：** 国际化标记，zh-cn表示中文，en-us或不传表示英文。 **约束限制：** zh-cn表示中文，en-us或不传表示英文。 **取值范围：** zh-cn/en-us。 **默认取值：** 不涉及。 | | x-project-id | 否 | String | **参数解释：** 项目ID。 **约束限制：** region对应的项目ID。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | x-user-profile | 否 | String | **参数解释：** IAM5.0用户信息。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | data | [JobScriptOrderInfoModel] object | **参数解释：** 返回结果。 **取值范围：** 不涉及。 | 表4JobScriptOrderInfoModel | 参数 | 参数类型 | 描述 | |:---|:---|:---| | execute_uuid | String | **参数解释：** 执行uuid。 **取值范围：** 不涉及。 | | gmt_created | Long | **参数解释：** 执行创建时间。 **取值范围：** 不涉及。 | | gmt_finished | Long | **参数解释：** 执行完成时间。 **取值范围：** 不涉及。 | | execute_costs | Long | **参数解释：** 执行耗时，单位：秒。 **取值范围：** 不涉及。 | | creator | String | **参数解释：** 创建人。 **取值范围：** 不涉及。 | | status | String | **参数解释：** 执行状态。 **取值范围：** - READY：准备。 - PROCESSING：处理。 - ABNORMAL：异常。 - PAUSED：中断。 - CANCELED：取消。 - FINISHED：完成。 | | properties | [JobScriptOrderInfoProp] object | **参数解释：** 属性：脚本id，脚本名，执行脚本参数，执行用户，超时时长、成功率阈值、当前执行批次index等。 **取值范围：** 不涉及。 | 表5JobScriptOrderInfoProp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | script_uuid | String | **参数解释：** 脚本uuid。 **取值范围：** 不涉及。 | | script_name | String | **参数解释：** 脚本名称。 **取值范围：** 不涉及。 | | script_version_uuid | Long | **参数解释：** 脚本版本uuid。 **取值范围：** 不涉及。 | | script_version_name | String | **参数解释：** 脚本版本名。 **取值范围：** 不涉及。 | | current_execute_batch_index | Integer | **参数解释：** 当前执行批次index。 **取值范围：** 不涉及。 | | execute_param | [ScriptExecuteParam] object | **参数解释：** 执行脚本参数，执行用户，超时时长、成功率阈值等。 **取值范围：** 不涉及。 | 表6ScriptExecuteParam | 参数 | 参数类型 | 描述 | |:---|:---|:---| | resourceful | Boolean | **参数解释：** 该参数已废弃，传入该参数不会生效。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | timeout | Integer | **参数解释：** 超时时间。 **约束限制：** 单位：秒，取值范围：5 \< timeout \< 1800。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | success_rate | Double | **参数解释：** 成功率， **约束限制：** 支持小数点后一位。 **取值范围：** 1-100。 **默认取值：** 不涉及。 | | execute_user | String | **参数解释：** 脚本执行用户，如：root。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | script_params | Array of [ScriptExecuteInputParam] objects | **参数解释：** 脚本入参列表。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表7ScriptExecuteInputParam | 参数 | 参数类型 | 描述 | |:---|:---|:---| | param_name | String | **参数解释：** 脚本入参的名称,同一个脚本，参数名不能重复。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | param_value | String | **参数解释：** 脚本入参的值，默认必填。有引用参数（param_refer不为空）时，允许为空。 **约束限制：** - 参数长度为1-4096位 - 可以包含大写字母、小写字母、数字及特殊字符(_-/.\* ?:",=+@#\[{\]}) - 禁止出现连续'.' **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | param_order | Integer | **参数解释：** 【已废弃】该参数已废弃，传入该参数不会生效。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | param_refer | [ScriptExecuteParamReference] object | **参数解释：** 参数引用。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表8ScriptExecuteParamReference | 参数 | 参数类型 | 描述 | |:---|:---|:---| | refer_type | String | **参数解释：** 参数引用类型：PARAM_STORE。 **约束限制：** 不涉及。 **取值范围：** - PARAM_STORE: 参数中心引用。 **默认取值：** 不涉及。 | | param_id | String | **参数解释：** 引用参数的唯一主键id。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | param_version | String | **参数解释：** 引用参数的版本号。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 请求示例 展示脚本工单基本信息。 ``` GET https://{Endpoint}/v1/job/script/orders/{execute_uuid} ``` #### 响应示例 **状态码：200** 执行基本信息。 更多状态码请参考[状态码](https://support.huaweicloud.com/api-coc/coc_api_05_03.html)。 ``` { "data" : { "execute_uuid" : "SCT2023102211473xxxxxxxxxx", "gmt_created" : 1697946452186, "gmt_finished" : 1697946763469, "execute_costs" : 311282, "creator" : "xxxxxxxxxxxcontainer1", "status" : "CANCELED", "properties" : { "script_uuid" : "SC2023101717xxxxxxxxxxxxx", "script_name" : "xjptxxxxxxxx", "current_execute_batch_index" : 1, "execute_param" : { "resourceful" : true, "timeout" : 300, "execute_user" : "root", "success_rate" : 100, "script_params" : [ ] } } } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 执行基本信息。 更多状态码请参考[状态码](https://support.huaweicloud.com/api-coc/coc_api_05_03.html)。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-coc/ErrorCode.html)。