查询模板的部署参数 - ShowTemplateDeployParams
功能介绍
查询模板的部署参数。
授权信息
账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。
| 授权项 | 访问级别 | 资源类型（*为必须） | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| rgc:templateDeployParam:get | Read | - | - | - | - |
URI
GET /v1/rgc/templates/{template_name}/deploy-params
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| template_name | 是 | String | 模板名称。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| version | 是 | String | 模板版本。 |
| account_id | 否 | String | 纳管账号ID。 |
请求参数
无
响应参数
状态码：200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| variables | Array of TemplateParamVariable objects | 模板的部署参数。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| default | Object | 变量默认值。 |
| name | String | 变量名称。 |
| description | String | 变量描述。 |
| nullable | Boolean | 变量是否可以为空。 |
| sensitive | Boolean | 变量是否为敏感字段。 |
| type | String | 变量类型。 |
| validations | Array of TemplateParamVariableValidation objects | 模板的部署参数变量的校验规则。 |
| latest_param | String | 最近一次的部署参数。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| condition | String | 校验表达式。 |
| error_message | String | 校验失败后的错误信息。 |
状态码：403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误信息 |
| request_id | String | 请求唯一标识 |
| encoded_authorization_message | String | 加密的错误信息 |
| details | Array of ForbiddenErrorDetail objects | 跨服务调用无权限错误信息 |
请求示例
查询模板的部署参数。
GET https://{endpoint}/v1/rgc/templates/{template_name}/deploy-params?version=V1 响应示例
状态码：200
请求成功。
{
"variables" : [ {
"default" : "object",
"name" : "string",
"nullable" : "boolean",
"sensitive" : "boolean",
"description" : "string",
"type" : "string",
"validations" : [ {
"condition" : "string",
"error_message" : "string"
} ]
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功。 |
| 403 | 请求无权限。 |
错误码
请参见错误码。
