文档首页/ 应用管理与运维平台 ServiceStage/ API参考/ 应用管理API（v3版本）/ 配置管理/ 获取配置文件信息 - ObtainConfigurationFileInformation
更新时间：2026-02-28 GMT+08:00
查看PDF
分享

获取配置文件信息 - ObtainConfigurationFileInformation

功能介绍

此API用于获取配置文件信息。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    servicestage:config:list

    list

    -

    -

    -

    -

URI

GET /v3/{project_id}/cas/configs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户项目ID。获取方法，请参考获取项目ID。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表2 查询参数

参数

是否必选

参数类型

描述

name

否

String

参数解释：

配置文件名称。

取值范围：

不涉及

默认取值：

不涉及

config_group_id

否

String

参数解释：

配置分组ID。

取值范围：

不涉及

默认取值：

不涉及

component_id

否

String

参数解释：

组件ID。

取值范围：

不涉及

默认取值：

不涉及

limit

否

Integer

参数解释：

指定个数。

约束限制：

不涉及

取值范围：

1~100

默认取值：

10

offset

否

Integer

参数解释：

指定偏移量。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

0

order_by

否

String

参数解释：

排序字段。

约束限制：

不涉及

取值范围：

  • create_time：配置文件创建时间。
  • name：配置文件名称。
  • update_time：配置文件修改时间。

默认取值：

create_time

order

否

String

参数解释：

排序方式。

约束限制：

不涉及

取值范围：

  • desc：降序排序。
  • asc：升序排序。

默认取值：

desc

请求消息

表3 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

参数解释：

消息体的类型（格式）。

约束限制：

不涉及

取值范围：

application/json;charset=utf8

默认取值：

不涉及

X-Auth-Token

是

String

参数解释：

调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考认证鉴权。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

响应消息

表4 响应参数

参数

参数类型

描述

count

Integer

参数解释：

配置文件总数。

取值范围：

不涉及

configs

Array of objects

参数解释：

配置文件列表，请参考表5。
表5 configs

参数

参数类型

描述

config_group_id

String

参数解释：

配置分组ID。

取值范围：

不涉及

id

String

参数解释：

配置文件ID。

取值范围：

不涉及

name

String

参数解释：

配置文件名称。

取值范围：

不涉及

description

String

参数解释：

配置文件描述。

取值范围：

不涉及

creator

String

参数解释：

创建人。

取值范围：

不涉及

type

String

参数解释：

配置文件类型。

取值范围：

  • yaml
  • properties

content

String

参数解释：

配置文件内容。

取值范围：

不涉及

version

String

参数解释：

配置文件版本号。

取值范围：

不涉及

project_id

String

参数解释：

项目ID。

取值范围：

不涉及

sensitive

Boolean

参数解释：

配置文件内容是否加密。

取值范围：

  • true：加密。
  • false：不加密。

components

Array of objects

参数解释：

配置文件绑定的组件列表，请参考表6。

create_time

Integer

参数解释：

创建时间。

取值范围：

不涉及

update_time

Integer

参数解释：

修改时间。

取值范围：

不涉及
表6 components

参数

参数类型

描述

application_id

String

参数解释：

应用ID。

取值范围：

不涉及

component_id

String

参数解释：

组件ID。

取值范围：

不涉及

component_name

String

参数解释：

组件名称。

取值范围：

不涉及

environment_id

String

参数解释：

环境ID。

取值范围：

不涉及

请求示例

无

响应示例

{
	"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
}

状态码

状态码

描述

200

操作成功。

400

错误的请求。

404

请求对象不存在。

500

内部错误。

错误码

请参考ServiceStage错误码。

父主题： 配置管理

相关文档