Obtaining Configuration File Information

Function

This API is used to obtain the configuration file information.

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:list

list

-

-

-

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
servicestage:config:list	list	-	-	-	-

URI

GET /v3/{project_id}/cas/configs

**Table 1** Path parameter
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

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
name	No	String	Definition Configuration file name. Range N/A Default Value N/A
config_group_id	No	String	Definition Configuration group ID. Range N/A Default Value N/A
component_id	No	String	Definition Component ID. Range N/A Default Value N/A
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 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 files. Range N/A
configs	Array of objects	Definition Configuration file list. See Table 5.

**Table 5** configs
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 6.
create_time	Integer	Definition Creation time. Range N/A
update_time	Integer	Definition Update time. Range N/A

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

{
	"configs": [{
		"id": "f5a52d93-1587-45cf-b8fe-5c7f204b98d1",
		"config_group_id": "4808b50d-d7f3-401b-9175-968cb4f9892b",
		"name": "test-config1",
		"description": null,
		"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"
	},
	{
		"id": "2cb1897e-c23b-48a5-993c-dc7ad3c552a0",
		"config_group_id": "f3e6d5b4-4d7d-4009-b806-22cfed2ac6ea",
		"name": "test-config2",
		"description": null,
		"type": "properties",
		"content": "testKey = testValue",
		"version": "v1",
		"project_id": "2cfeefc3e4c54a5aa7548b8350e638d7",
		"sensitive": false,
		"create_time": 1717486590467,
		"update_time": 1717486590467,
		"components": [],
		"creator": "ss-test"
	}],
	"count": 2
}