Help Center> ROMA Connect> API Reference> Service Integration APIs> Application Configuration Management> Creating an Application Configuration
Updated on 2023-06-29 GMT+08:00
View PDF

Creating an Application Configuration

Function

Creating an Application Configuration

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Appendix > Obtaining a Project ID in the ROMA Connect API Reference.

instance_id

Yes

String

Instance ID.

app_id

Yes

String

Application ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header).
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

config_type

Yes

String

Application configuration type.

  • variable: template variable

  • password: password

  • certificate: certificate

config_value

No

String

Application configuration value.

  • If config_type is set to variable, config_value is the value of the template variable.

  • If config_type is set to password, config_value indicates the password.

  • If config_type is set to certificate, config_value must contain public_key (mandatory), private_key (mandatory), and passphrase (optional), in the format of "{\"public_key\": ",\"private_key\":\"\",\"passphrase\":\"\"}".

description

No

String

Description of an application configuration.

config_name

Yes

String

Application configuration name.

Must start with a letter and can include letters, digits, underscores (_), hyphens (-), periods (.), and at signs (@).

Minimum: 1

Maximum: 512

Response Parameters

Status code: 201

Table 4 Response body parameters

Parameter

Type

Description

id

String

Application configuration ID.

app_id

String

Application ID

config_type

String

Application configuration type.

config_name

String

Application configuration name.

config_value

String

Application configuration value.

update_time

String

Time when the application configuration was updated.

description

String

Description of an application configuration.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

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

Example Responses

Status code: 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"
}

Status code: 400

Bad Request

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

Status code: 401

Unauthorized

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

Status code: 403

Forbidden

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

Status code: 404

Not Found

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

Status code: 500

Internal Server Error

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

Status Codes

Status Code

Description

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.