Help Center/ ServiceStage/ API Reference/ Application Management V3 APIs/ Configuration Management/ Obtaining Configuration File Information Based on the Configuration File ID
Updated on 2026-04-10 GMT+08:00

Obtaining Configuration File Information Based on the Configuration File ID

Function

This API is used to obtain the details about a configuration file 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:get

    read

    config *

    g:EnterpriseProjectId

    -

    -

URI

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

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

Request

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

Parameter

Type

Description

config_group_id

String

Definition

Configuration group ID.

Range

N/A

id

String

Definition

Configuration file ID.

Range

N/A

name

String

Definition

Configuration file name.

Range

N/A

description

String

Definition

Configuration file description.

Range

N/A

creator

String

Definition

Creator.

Range

N/A

type

String

Definition

Configuration file type.

Range

  • yaml
  • properties

content

String

Definition

Configuration file content.

Range

N/A

version

String

Definition

Configuration file version.

Range

N/A

project_id

String

Definition

Project ID.

Range

N/A

sensitive

Boolean

Definition

Whether to encrypt the configuration file.

Range

  • true: yes
  • false: no

components

Array of objects

Definition

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

create_time

Integer

Definition

Creation time.

Range

N/A

update_time

Integer

Definition

Update time.

Range

N/A

enterprise_project_id

String

Definition

Enterprise project ID.

Range

N/A

config_encryption

Object

Definition

Key information. Set the encryption key in the configuration file. See Table 5.

Table 4 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

Table 5 config_encryption

Parameter

Type

Description

key_id

String

Definition

User key ID in DEW.

Range

N/A

Example Request

None

Example Response

{
	"id": "f5a52d93-1587-45cf-b8fe-5c7f204b98d1",
	"config_group_id": "4808b50d-d7f3-401b-9175-968cb4f9892b",
	"name": "test-config1",
	"description": "",
	"type": "properties",
	"content": "testKey = testValue",
	"version": "v1",
	"project_id": "2cfeefc3e4c54a5aa7548b8350e638d7",
	"sensitive": false,
	"create_time": 1717486892611,
	"update_time": 1717486892611,
	"components": [{
		"application_id": "8a3be48a-6401-4e8c-bbce-033745252227",
		"component_id": "4b611997-4acd-4538-a06b-32fd2475e057",
		"component_name": "component-test1",
		"environment_id": "d2d7180c-7739-4cbb-bd8e-0911ba31cf51"
	}],
	"creator": "ss-test"
}

Status Code

Status Code

Description

200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

Error Code

See ServiceStage Error Codes.