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

Obtaining the Configuration File Record Based on the Configuration File ID

Function

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

URI

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

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.

Table 2 Query parameters

Parameter

Mandatory

Type

Description

limit

No

integer

Number of records to be queried. Value range: 0–100.

offset

No

integer

Offset.

order_by

No

String

Sorting field. By default, query results are sorted by creation time.

Enumerated values:

  • create_time
  • name
  • update_time

order

No

String

Sorting order.

  • desc (default)
  • asc

Request

Table 3 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 4 Response parameters

Parameter

Type

Description

count

Integer

Total number of configuration file records.

histories

Array of objects

Configuration file record list. See Table 5.

Table 5 histories

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.

create_time

Integer

Creation time.

components

Array of objects

Component to which the configuration file is bound. See Table 6.

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 6 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

{
	"count": 2,
	"histories": [{
		"config_history_id": "e9c52a5f-0f7c-48a2-b89c-29dd349d1a35",
		"config_id": "f5a52d93-1587-45cf-b8fe-5c7f204b98d1",
		"content": "testKey = valueModify",
		"type": "properties",
		"version": "v2",
		"create_time": 1717491574202,
		"components": [{
			"application_id": "8a3be48a-6401-4e8c-bbce-033745252227",
			"component_id": "4b611997-4acd-4538-a06b-32fd2475e057",
			"component_name": "component-test",
			"environment_id": "d2d7180c-7739-4cbb-bd8e-0911ba31cf51"
		}],
		"creator": "ss-test",
		"group_id": "4808b50d-d7f3-401b-9175-968cb4f9892b",
		"config_name": "test-config1",
		"description": "",
		"sensitive": false
	},
	{
		"config_history_id": "adacc5dc-a497-4023-b292-3b3cf37347f8",
		"config_id": "f5a52d93-1587-45cf-b8fe-5c7f204b98d1",
		"content": "testKey = testValue",
		"type": "properties",
		"version": "v1",
		"create_time": 1717491445668,
		"components": [{
			"application_id": "8a3be48a-6401-4e8c-bbce-033745252227",
			"component_id": "4b611997-4acd-4538-a06b-32fd2475e057",
			"component_name": "component-test",
			"environment_id": "d2d7180c-7739-4cbb-bd8e-0911ba31cf51"
		}],
		"creator": "ss-test",
		"group_id": "4808b50d-d7f3-401b-9175-968cb4f9892b",
		"config_name": "test-config1",
		"description": "",
		"sensitive": false
	}]
}

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.