Help Center/ ServiceStage/ API Reference/ Application Management V3 APIs/ Configuration Management/ Obtaining the Configuration File Record Information Based on the Record ID
Updated on 2024-12-16 GMT+08:00

Obtaining the Configuration File Record Information Based on the Record ID

Function

This API is used to obtain the configuration file record information based on the record ID.

URI

GET /v3/{project_id}/cas//configs/{config_id}/histories/{config_history_id}

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Tenant's project ID. See Obtaining a Project ID.

config_id

Yes

String

Configuration file ID. See Obtaining Configuration File Information.

config_history_id

Yes

String

Configuration file record ID. See Obtaining the Configuration File Record Based on the Configuration File ID.

Request

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Message body type (format). Default value: application/json;charset=utf8.

X-Auth-Token

Yes

String

API calling can be authenticated using a token or AK/SK. If you use a token, this parameter is mandatory and must be set to the token. For details about how to obtain the token, see Authentication.

Response

Table 3 Response parameters

Parameter

Type

Description

config_history_id

String

Configuration file record ID.

config_id

String

Configuration file ID.

content

String

Configuration file record content.

version

String

Configuration file record version.

type

String

Configuration file.

create_time

Integer

Creation time.

components

Array of objects

List of the components to which the configuration file is bound. See Table 4.

creator

String

Creator.

group_id

String

Configuration group ID.

config_name

String

Configuration file name.

description

String

Configuration file description.

sensitive

Boolean

Whether to encrypt the configuration file.

  • true: Encrypt.
  • false: Not encrypt.
Table 4 components

Parameter

Type

Description

application_id

String

Application ID.

component_id

String

Component ID.

component_name

String

Component name.

environment_id

String

Environment ID.

Example Request

None

Example Response

{
	"config_history_id": "139e2161-ddf3-4a90-832f-a3a5a5fa01c2",
	"config_id": "4b4cd418-3553-453a-bd2b-660bfcee7f5a",
	"content": "testkey = testValue",
	"version": "v1",
	"create_time": 1717498251010,
	"components": [],
	"creator": "ss-test",
	"group_id": "3db71eff-c08a-4da7-bd44-03791f33bbc7",
	"config_name": "test-config",
	"description": "",
	"sensitive": true, "type": "properties"
}

Status Code

Status Code

Description

204

OK

400

Bad Request

404

Not Found

500

Internal Server Error

Error Code

The error code format is SVCSTG.00100.[Error_ID], for example, SVCSTG.00100400. For details, see ServiceStage Error Codes.