更新时间:2023-11-29 GMT+08:00

创建应用配置

功能介绍

创建应用配置

URI

POST /v2/{project_id}/apic/instances/{instance_id}/apps/{app_id}/configs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方式请参见API参考的“附录 > 获取项目ID”章节。

instance_id

String

实例ID

app_id

String

应用编号

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

表3 请求Body参数

参数

是否必选

参数类型

描述

config_type

String

应用配置类型:

  • variable:模板变量

  • password:密码

  • certificate:证书

config_value

String

应用配置值:

  • config_type = variable:config_value为模板变量的值

  • config_type = password:config_value为密码值

  • config_type = certificate:调用创建或修改应用配置接口,config_value值非必填,自定义后端函数使用config_value值需要包含证书public_key(必填),私钥private_key(必填)和密码passphrase(非必填),格式如:"{\"public_key\": ",\"private_key\":\"\",\"passphrase\":\"\"}"

description

String

应用配置描述

最大长度:1024

config_name

String

应用配置名称。

支持英文大小写字符、数字、下划线、中划线、点和@,且只能以英文字母开头。

最小长度:1

最大长度:512

响应参数

状态码: 201

表4 响应Body参数

参数

参数类型

描述

id

String

应用配置编号

app_id

String

应用编号

config_type

String

应用配置类型

config_name

String

应用配置名称

config_value

String

应用配置值

update_time

String

应用配置更新时间

description

String

应用配置描述

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 403

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 404

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

创建一个应用配置,配置类型为模板变量

{
  "config_name" : "app-config-demo",
  "config_type" : "variable"
}

响应示例

状态码: 201

Created

{
  "app_id" : "98df09fb-d459-4cbf-83a7-2b55ca6f3d5d",
  "config_name" : "app-config-demo",
  "config_type" : "variable",
  "config_value" : "",
  "description" : "",
  "id" : "a8bf4963c54544be81d5af4cc4630bde",
  "update_time" : "2020-09-07T07:05:41.96969041Z"
}

状态码: 400

Bad Request

{
  "error_code" : "APIG.2011",
  "error_msg" : "Invalid parameter value,parameterName:config_name. Please refer to the support documentation"
}

状态码: 401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

状态码: 403

Forbidden

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

状态码: 404

Not Found

{
  "error_code" : "APIG.3019",
  "error_msg" : "The app does not exist"
}

状态码: 500

Internal Server Error

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

状态码

状态码

描述

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码