获取组件配置列表 - ListComponentConfigurations
功能介绍
获取组件配置列表。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v1/{project_id}/cae/applications/{application_id}/components/{component_id}/configurations
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 项目ID,获取项目ID请参见获取项目ID。 |
application_id | 是 | String | 应用ID。 |
component_id | 是 | String | 组件ID。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
displayMode | 否 | String | 参数解释: 显示模式。 约束限制: 当前只支持“latestEffective”,即只显示最后一次已生效配置。 默认取值: 此字段为非必选项,不传递时,会显示全部历史配置信息。 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 是 | String | 用户Token。
|
X-Enterprise-Project-ID | 否 | String | 企业项目ID。
说明: 关于企业项目ID的获取及企业项目特性的详细信息,请参见《企业管理服务用户指南》。 |
X-Environment-ID | 是 | String | 环境ID。
|
响应参数
状态码:200
参数 | 参数类型 | 描述 |
|---|---|---|
api_version | String | API版本,固定值“v1”,该值不可修改。 |
kind | String | API类型,固定值“ComponentConfiguration”,该值不可修改。 |
items | Array of Configuration objects | 组件配置列表。 |
参数 | 参数类型 | 描述 |
|---|---|---|
data | 组件配置数据。 | |
operated_at | String | 操作时间。 |
operation_id | String | 操作ID。 |
type | String | 参数解释: 组件配置类型。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
is_activated | Boolean | 配置是否生效过。 |
is_using | Boolean | 配置是否正在使用。 |
参数 | 参数类型 | 描述 |
|---|---|---|
spec | 组件配置数据规格详情。 | |
metadata | ConfigurationDataMetadata object | 组件配置元数据。 |
参数 | 参数类型 | 描述 |
|---|---|---|
rds_id | String | RDS数据库实例ID。 Configuration.type为"rds"时,返回此参数。 |
rds_db_name | String | RDS数据库名称。 Configuration.type为"rds"时,返回此参数。 |
rds_address | String | RDS数据库地址。 Configuration.type为"rds"时,返回此参数。 |
rds_username | String | RDS数据库用户名称。 Configuration.type为"rds"时,返回此参数。 |
rds_password | String | RDS数据库密码。 Configuration.type为"rds"时,返回此参数。 |
rds_port | String | RDS数据库端口。 Configuration.type为"rds"时,返回此参数。 |
config_center_addr | String | CSE配置中心地址。 Configuration.type为"cse"时,返回此参数。 |
service_center_addr | String | CSE服务注册发现地址。 Configuration.type为"cse"时,返回此参数。 |
cse_id | String | CSE引擎ID。 Configuration.type为"cse"时,返回此参数。 |
envs | Map<String,String> | 手动添加环境变量配置。 常用环境变量如下:
|
env_references | env_references object | 凭据导入环境变量 |
ip | String | 弹性公网IP,响应体参数,未配置域名时返回此参数。 |
items | Array of AccessConfigurationDataItems objects | 访问方式配置列表。 Configuration.type为"access"时,返回此参数。 |
scale_strategy | String | 伸缩策略配置策略类型。 Configuration.type为"scaling"时,返回此参数。 |
max_replica_count | Integer | 伸缩策略配置最大伸缩个数。 Configuration.type为"scaling"时,返回此参数。 |
min_replica_count | Integer | 伸缩策略配置最小伸缩个数。 Configuration.type为"scaling"时,返回此参数。 |
advanced | 伸缩策略高级配置。 Configuration.type为"scaling"时,返回此参数。 | |
triggers | Array of ScaleConfigurationDataTrigger objects | 伸缩策略配置触发器列表。 Configuration.type为"scaling"时,返回此参数。 |
volumes | Array of VolumeConfigurationDataVolume objects | 云存储配置列表。 Configuration.type为"volume"时,返回此参数。 |
livenessProbe | 组件健康检查配置的存活探针配置。 Configuration.type为"healthCheck"时,返回此参数。 | |
startupProbe | 组件健康检查配置的启动探针配置。 Configuration.type为"healthCheck"时,返回此参数。 | |
readinessProbe | 组件健康检查配置的就绪探针配置。 Configuration.type为"healthCheck"时,返回此参数。 | |
postStart | postStart object | 生命周期管理组件配置启动后处理。 Configuration.type为"lifecycle"时,返回此参数。 |
preStop | preStop object | 生命周期管理组件配置停止前处理。 Configuration.type为"lifecycle"时,返回此参数。 |
log_paths | Array of strings | 自定义本地磁盘日志路径数组。 Configuration.type为"log"时,返回此参数。 |
cloud_storage_log_paths | Array of CloudStorageLogPathInfo objects | 自定义云存储日志路径数组。 Configuration.type为"log"时,返回此参数。 |
instrumentation | String | 探针注入方式。 Configuration.type为"apm2"时,返回此参数。 |
apm_application | String | apm2应用。 Configuration.type为"apm2"时,返回此参数。 |
type | String | 参数解释: 监控系统类别,包括apm2和opentelemetry。 Configuration.type为"apm2"时,返回此参数。 取值范围:
默认取值: 不涉及。 |
app_name | String | apm2组件。 Configuration.type为"apm2"时,返回此参数。 |
instance_name | String | apm2实例。 Configuration.type为"apm2"时,返回此参数。 |
env_name | String | apm2环境。 Configuration.type为"apm2"时,返回此参数。 |
image_pull_policy | String | 探针镜像更新策略,已废弃,迁移到监控系统。
Configuration.type为"apm2"时,返回此参数。 |
version | String | 增强型探针/opentelemetry探针版本,已废弃,迁移到监控系统。 Configuration.type为"apm2"时,返回此参数。 |
access_key | String | apm2访问密钥Key,已废弃,迁移到监控系统。 Configuration.type为"apm2"时,返回此参数。 |
access_value | String | apm2访问密钥value,已废弃,迁移到监控系统。 Configuration.type为"apm2"时,返回此参数。 |
business | String | apm2应用,同apm_application,已废弃。 Configuration.type为"apm2"时,返回此参数。 |
path | String | 自定义监控指标配置采集路径。 Configuration.type为"customMetric"时,返回此参数。 |
port | Integer | 自定义监控指标配置采集端口。 Configuration.type为"customMetric"时,返回此参数。 |
metrics | Array of strings | 自定义监控指标配置指标名称。 Configuration.type为"customMetric"时,返回此参数。 |
参数 | 参数类型 | 描述 |
|---|---|---|
operator | String | 配置模式。
|
uid | String | 访问方式的uid。 |
metadata | AccessConfigurationMetadata object | 访问方式配置元数据。 |
type | String | 参数解释: 访问方式类型。 取值范围:
默认取值: 不涉及。 |
sub_type | String | 访问方式子类型。 |
ingress_config_id | String | 访问关联域名后缀ID,多个域名后缀逗号隔开。 |
domain_names | Array of strings | 内网访问方式域名。 |
access_control | AccessControl object | 访问控制配置,允许配置黑名单、白名单。 |
ports | Array of AccessConfigurationPort objects | 访问方式配置端口、协议、证书、URL路径等信息列表。 |
elb_id | String | 用户选择的elb的ID。 |
public_ip | String | 响应体参数,用户选择的elb的公网ip。 |
private_ip | String | 响应体参数,用户选择的elb的私网ip。 |
参数 | 参数类型 | 描述 |
|---|---|---|
annotations | Map<String,String> | 附加参数。 举例:负载均衡分配策略使用加权轮询算法,不启用健康检查。配置如下:
|
参数 | 参数类型 | 描述 |
|---|---|---|
black | Array of strings | 黑名单数组。
|
white | Array of strings | 白名单数组。
|
参数 | 参数类型 | 描述 |
|---|---|---|
operator | String | 配置模式。
|
uid | String | 端口配置的uid。 |
target_port | Integer | 监听端口。 |
port | Integer | 访问端口。 |
protocol | String | 协议,负载均衡支持TCP,负载均衡与路由配置支持HTTP、HTTPS。 |
default_certificate | String | 默认证书,访问方式配置为转发策略且协议为HTTPS时配置,未配置域名证书对时使用默认证书。 |
certificate | String | 证书。 |
policy | String | 安全策略。 |
paths | Array of AccessConfigurationHttpPath objects | 匹配路径和域名信息。 |
elb_id | String | 用户选择的elb的ID。 |
参数 | 参数类型 | 描述 |
|---|---|---|
hostname | String | 域名/不填,不填时表示使用IP。 |
path | String | URL路径。 |
url_match_mode | String | URL路径匹配模式,支持前缀匹配、正则匹配、精准匹配。 |
参数 | 参数类型 | 描述 |
|---|---|---|
scaledown_stabilization_seconds | Integer | 缩容冷却时间窗。 |
scaledown_rate | Integer | 缩容步长。 |
scaleup_stabilization_seconds | Integer | 扩容冷却时间窗。 |
scaleup_rate | Integer | 扩容步长。 |
disable_scaledown | Boolean | 是否禁用自动缩容。 |
参数 | 参数类型 | 描述 |
|---|---|---|
type | String | 参数解释: 指标类型。 取值范围:
|
metadata | ScalingTriggerMeta object | trigger元数据。 |
参数 | 参数类型 | 描述 |
|---|---|---|
type | String | 数据类型,当前只支持利用率,默认值为Utilization。 ScaleConfigurationDataTrigger.type为"cpu、memory"时,配置此参数。 |
value | String | 触发指标的阈值。 ScaleConfigurationDataTrigger.type为"cpu、memory"时,配置此参数。 |
period_type | String | 参数解释: 生效周期。 ScaleConfigurationDataTrigger.type为"cron"时,配置此参数。 取值范围:
默认取值: 不涉及。 |
schedulers | Array of CronTriggerScheduler objects | 每个周期内触发的时间点和实例数。 ScaleConfigurationDataTrigger.type为"cron"时,配置此参数。 |
参数 | 参数类型 | 描述 |
|---|---|---|
volume_id | String | 云存储ID。 |
resource_name | String | 云存储名称。 |
resource_type | String | 参数解释: 云存储类型。 取值范围:
|
resource_sub_type | String | 参数解释: 云存储子类型。 取值范围:
|
umask | String | 设置目录或文件缺省权限,默认值0027,sfs3.0类型的云存储不支持配置此参数。 |
mount_info | Array of VolumeConfigurationMountInfo objects | 云存储配置挂载信息。 |
参数 | 参数类型 | 描述 |
|---|---|---|
periodSeconds | Integer | 检测周期,单位为s。 |
initialDelaySeconds | Integer | 延迟时间,单位为s。 |
timeoutSeconds | Integer | 超时时间,单位为s。 |
successThreshold | Integer | 成功阈值。 |
failureThreshold | Integer | 最大失败次数。 |
httpGet | 健康检查配置中HTTP请求检查信息。 | |
tcpSocket | 健康检查配置中TCP端口检查信息。 | |
exec | HealthCheckConfigurationExec object | 健康检查配置中执行命令检查。 |
参数 | 参数类型 | 描述 |
|---|---|---|
periodSeconds | Integer | 检测周期,单位为s。 |
initialDelaySeconds | Integer | 延迟时间,单位为s。 |
timeoutSeconds | Integer | 超时时间,单位为s。 |
successThreshold | Integer | 成功阈值。 |
failureThreshold | Integer | 最大失败次数。 |
httpGet | 健康检查配置中HTTP请求检查信息。 | |
tcpSocket | 健康检查配置中TCP端口检查信息。 | |
exec | HealthCheckConfigurationExec object | 健康检查配置中执行命令检查。 |
参数 | 参数类型 | 描述 |
|---|---|---|
periodSeconds | Integer | 检测周期,单位为s。 |
initialDelaySeconds | Integer | 延迟时间,单位为s。 |
timeoutSeconds | Integer | 超时时间,单位为s。 |
successThreshold | Integer | 成功阈值。 |
failureThreshold | Integer | 最大失败次数。 |
httpGet | 健康检查配置中HTTP请求检查信息。 | |
tcpSocket | 健康检查配置中TCP端口检查信息。 | |
exec | HealthCheckConfigurationExec object | 健康检查配置中执行命令检查。 |
请求示例
获取组件配置列表。
GET https://{endpoint}/v1/{project_id}/cae/applications/{application_id}/components/{component_id}/configurations 响应示例
状态码:200
请求成功。
{
"api_version" : "v1",
"kind" : "ComponentConfiguration",
"items" : [ {
"type" : "env",
"data" : {
"spec" : {
"envs" : {
"TZ" : "Asia/Shanghai"
},
"env_references" : [ {
"env_name" : "test",
"value_from" : {
"name" : "test",
"reference_type" : "dewSecret"
}
} ]
}
},
"operation_id" : "68e82e30-190d-40b2-9680-98a66ccb2f8f",
"operated_at" : "2023-02-16T06:35:46.23126Z",
"is_activated" : true,
"is_using" : false
}, {
"type" : "volume",
"data" : {
"spec" : {
"volumes" : [ {
"volume_id" : "bef119d0-c7d1-4b58-9794-8b74faf80a59",
"resource_name" : "test-nacos",
"resource_type" : "",
"resource_sub_type" : "object_bucket",
"mount_info" : [ {
"path" : "/tmp",
"access_mode" : "ReadWriteMany",
"create_time" : "2023-02-16T03:22:59.599Z"
} ]
}, {
"volume_id" : "a061934d-52e3-4b36-aea7-6c51879f84c9",
"resource_name" : "test",
"resource_type" : "",
"resource_sub_type" : "parallel_file_system",
"mount_info" : [ {
"path" : "/temp",
"access_mode" : "ReadWriteMany",
"create_time" : "2023-02-16T03:25:08.841Z"
} ]
} ]
}
},
"operation_id" : "68e82e30-190d-40b2-9680-98a66ccb2f8f",
"operated_at" : "2023-02-16T06:35:46.23126Z",
"is_activated" : true,
"is_using" : false
}, {
"type" : "rds",
"data" : {
"spec" : {
"rds_id" : "a5fdee4cf88c4277a68688a014f444bdin01",
"rds_port" : "",
"rds_address" : "100.xx.xx.xxx",
"rds_db_name" : "cae",
"rds_password" : "xxx",
"rds_username" : "cae"
}
},
"operation_id" : "b4ce410c-3ac3-40ae-9f11-0c8b98c2df19",
"operated_at" : "2023-02-16T02:14:03.416282Z",
"is_activated" : true,
"is_using" : false
}, {
"type" : "scaling",
"data" : {
"spec" : {
"scale_strategy" : "mix",
"max_replica_count" : 2,
"min_replica_count" : 1,
"advanced" : {
"scaledown_stabilization_seconds" : 300,
"scaledown_rate" : 99,
"scaleup_stabilization_seconds" : 0,
"scaleup_rate" : 4,
"disable_scaledown" : false
},
"triggers" : [ {
"metadata" : {
"period_type" : "day",
"schedulers" : [ {
"cron" : "00 01 * * *",
"target_replica" : 2
}, {
"cron" : "00 02 * * *",
"target_replica" : 1
} ]
},
"type" : "cron"
}, {
"metadata" : {
"type" : "Utilization",
"value" : "10"
},
"type" : "cpu"
}, {
"metadata" : {
"type" : "Utilization",
"value" : "20"
},
"type" : "memory"
} ]
}
},
"operation_id" : "02c81e5a-251b-4921-878e-a8f78efbadd1",
"operated_at" : "2023-02-16T07:03:07.711734Z",
"is_activated" : true,
"is_using" : false
}, {
"type" : "access",
"data" : {
"metadata" : {
"annotations" : {
"deployBackend" : "k8s",
"kubernetes.io/elb.health-check-flag" : "off",
"kubernetes.io/elb.lb-algorithm" : "ROUND_ROBIN"
}
},
"spec" : {
"ip" : "100.xx.xx.xxx",
"items" : [ {
"type" : "ClusterIP",
"domain_names" : [ "test-test-config" ],
"ports" : [ {
"ip" : "",
"name" : "loadBalancer-5x095cix5deo",
"target_port" : 80,
"port" : 8080,
"protocol" : "TCP"
} ]
}, {
"type" : "LoadBalancer",
"access_control" : {
"type" : "white",
"ip_list" : [ "1.1.1.1" ]
},
"elb_id" : "f5de88cc-64be-4f70-ac17-db745eb12345",
"ports" : [ {
"ip" : "",
"name" : "loadBalancer-0yzp5ud3w2pa",
"target_port" : 80,
"port" : 8080,
"protocol" : "TCP"
} ]
} ]
},
"ref" : {
"id" : "f5de88cc-64be-4f70-ac17-db745eb76e67"
}
},
"operation_id" : "68e82e30-190d-40b2-9680-98a66ccb2f8f",
"operated_at" : "2023-02-16T06:35:46.23126Z",
"is_activated" : true,
"is_using" : true
}, {
"type" : "lifecycle",
"data" : {
"api_version" : "v1",
"kind" : "lifecycle",
"spec" : {
"postStart" : {
"exec" : {
"command" : [ "/bin/sh", "-c", "echo service start" ]
}
},
"preStop" : {
"exec" : {
"command" : [ "/bin/sh", "-c", "echo service end" ]
}
}
}
},
"operation_id" : "69bcf986-6f83-4f43-9ca1-595684ba0748",
"operated_at" : "2023-02-16T07:05:05.610439Z",
"is_activated" : true,
"is_using" : false
}, {
"type" : "cse",
"data" : {
"spec" : {
"cse_id" : "25779525-1aac-44be-abda-f9164f1b41b8",
"config_center_addr" : "https://192.168.1.xxx:30103,https://192.168.1.xxx:30103",
"service_center_addr" : "https://192.168.1.xxx:30100,https://192.168.1.xxx:30100"
}
},
"operation_id" : "945305ee-8be5-4826-9215-45a0b545ed13",
"operated_at" : "2023-02-16T07:10:38.937075Z",
"is_activated" : true,
"is_using" : false
}, {
"type" : "healthCheck",
"data" : {
"spec" : {
"livenessProbe" : {
"httpGet" : {
"path" : "",
"port" : 80,
"scheme" : "HTTP"
},
"initialDelaySeconds" : 0,
"timeoutSeconds" : 1,
"periodSeconds" : 10,
"successThreshold" : 1,
"failureThreshold" : 3
},
"readinessProbe" : {
"httpGet" : {
"path" : "",
"port" : 80,
"scheme" : "HTTP"
},
"initialDelaySeconds" : 0,
"timeoutSeconds" : 1,
"periodSeconds" : 10,
"successThreshold" : 1,
"failureThreshold" : 3
},
"startupProbe" : {
"httpGet" : {
"path" : "",
"port" : 80,
"scheme" : "HTTP",
"httpHeaders" : [ {
"name" : "x-auth-token",
"value" : "xxx"
} ]
},
"initialDelaySeconds" : 0,
"timeoutSeconds" : 1,
"periodSeconds" : 10,
"successThreshold" : 1,
"failureThreshold" : 3
}
}
},
"operation_id" : "2361fba9-ee7e-405d-8b05-afc945a43e65",
"operated_at" : "2023-02-16T07:07:23.193231Z",
"is_activated" : true,
"is_using" : false
}, {
"type" : "customMetric",
"data" : {
"metadata" : {
"annotations" : {
"deployBackend" : "k8s"
},
"created_at" : "0001-01-01T00:00:00Z",
"updated_at" : "0001-01-01T00:00:00Z"
},
"spec" : {
"port" : 2112,
"path" : "/metrics",
"metrics" : [ "myapp_processed_ops_total" ]
},
"ref" : {
"id" : "17b7f411-5a34-4319-abfc-34f6cf774a44"
}
},
"operation_id" : "a79a7c8d-6d5e-41ec-892b-973d11f5e835",
"operated_at" : "2023-08-30T11:21:22.222476Z",
"is_activated" : false,
"is_using" : false
} ]
} 状态码
状态码 | 描述 |
|---|---|
200 | 请求成功。 |
错误码
请参见错误码。

