更新时间:2025-12-25 GMT+08:00

查询部署记录的执行参数

功能介绍

查询部署记录的执行参数。

调用方法

请参见如何调用API

URI

GET /v2/history/tasks/{task_id}/params

表1 路径参数

参数

是否必选

参数类型

描述

task_id

String

参数解释

部署任务id。

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

record_id

String

参数解释

执行记录id。

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token。 通过调用IAM服务接口获取(响应消息头中X-Subject-Token的值)。

约束限制

不涉及。

取值范围

字符串,长度不超过20000个字符。

默认取值

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

[数组元素]

Array of ConfigInfo objects

参数解释

查询部署记录执行参数返回体。

表5 ConfigInfo

参数

参数类型

描述

name

String

参数解释

参数名。

取值范围

不涉及。

type

String

参数解释

参数类型。

取值范围

  • text: 字符串

  • host_group: 环境

  • enum: 枚举

  • encrypt: 私密参数

value

String

参数解释

参数值。

取值范围

不涉及。

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:403

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

https://{endpoint}/v1/history/tasks/8e1eb7f010d4442ca150e3a1a5d96d94/params?record_id=8bcfde0419bf4d62b4676de99bcc7403

响应示例

状态码:200

OK 请求响应成功

[ {
  "name" : "service_port",
  "type" : "text",
  "value" : 8080
}, {
  "name" : "pwd",
  "type" : "encrypt",
  "value" : ""
}, {
  "name" : "env",
  "type" : "host_group",
  "value" : "4ed5be8d76f84f8bacdba9c8bd57ec92"
}, {
  "name" : "test_enum",
  "type" : "enum",
  "value" : "value1"
} ]

状态码:400

Bad Request

{
  "error_code" : "Deploy.00015002",
  "error_msg" : "Invalid request parameter."
}

状态码:403

Forbidden

{
  "error_code" : "Deploy.00011154",
  "error_msg" : "You do not have permissions to perform this operation."
}

状态码

状态码

描述

200

OK 请求响应成功

400

Bad Request

403

Forbidden

错误码

请参见错误码