Help Center/ ServiceStage/ API Reference/ Application Management V3 APIs/ Configuration Management/ Obtaining the Configuration File Record Based on the Configuration File ID
Updated on 2026-04-10 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.

Authorization Information

Each account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned.

  • If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
  • If you are using identity policy-based authorization, the permission listed below is required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    servicestage:config:listHistories

    list

    config *

    g:EnterpriseProjectId

    -

    -

URI

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

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

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

Constraints

N/A

Range

N/A

Default Value

N/A

config_id

Yes

String

Definition

Configuration file ID. See Obtaining Configuration File Information.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 2 Query parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Definition

Number of records.

Constraints

N/A

Range

1~100

Default Value

10

offset

No

Integer

Definition

Offset.

Constraints

N/A

Range

N/A

Default Value

0

order_by

No

String

Definition

Sorting field.

Constraints

N/A

Range

Enumerated values:

  • create_time
  • name
  • update_time

Default Value

create_time

order

No

String

Definition

Sorting order.

Constraints

N/A

Range

  • desc: descending order
  • asc: ascending order

Default Value

desc

Request

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Definition

Message body type (or format).

Constraints

N/A

Range

application/json;charset=utf8

Default Value

N/A

X-Auth-Token

Yes

String

Definition

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.

Constraints

N/A

Range

N/A

Default Value

N/A

Response

Table 4 Response parameters

Parameter

Type

Description

count

Integer

Definition

Total number of configuration file records.

Range

N/A

histories

Array of objects

Definition

Configuration file record list. See Table 5.

Table 5 histories

Parameter

Type

Description

config_history_id

String

Definition

Configuration file record ID.

Range

N/A

config_id

String

Definition

Configuration file ID.

Range

N/A

content

String

Definition

Configuration file record content.

Range

N/A

version

String

Definition

Configuration file record version.

Range

N/A

create_time

Integer

Definition

Creation time.

Range

N/A

components

Array of objects

Definition

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

creator

String

Definition

Creator.

Range

N/A

group_id

String

Definition

Configuration group ID.

Range

N/A

type

String

Definition

Configuration file type.

Range

N/A

config_name

String

Definition

Configuration file name.

Range

N/A

description

String

Definition

Configuration file description.

Range

N/A

sensitive

Boolean

Definition

Whether to encrypt the configuration file.

Range

  • true: yes
  • false: no
Table 6 components

Parameter

Type

Description

application_id

String

Definition

Application ID.

Range

N/A

component_id

String

Definition

Component ID.

Range

N/A

component_name

String

Definition

Component name.

Range

N/A

environment_id

String

Definition

Environment ID.

Range

N/A

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

See ServiceStage Error Codes.