Comparison Information of the Queried Historical Version
Function
Comparison information of the queried historical version.
URI
GET /v1/{project_id}/cae/applications/{application_id}/components/{component_id}/configuration-history
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
application_id |
Yes |
String |
Application ID. |
component_id |
Yes |
String |
Component ID. |
project_id |
Yes |
String |
Project ID. See Obtaining a Project ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
operation_id |
Yes |
String |
Enter the configuration_operation_id of the snapshot version to be rolled back. |
last_operation_id |
No |
String |
configuration_operation_id of the current version. If this parameter is left blank, the obtained before_configurations is the last configuration information of each configuration type. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token.
|
X-Enterprise-Project-ID |
No |
String |
Enterprise project ID.
NOTE:
For details about how to obtain enterprise project IDs and enterprise project features, see Enterprise Management User Guide.
|
X-Environment-ID |
Yes |
String |
Environment ID.
|
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
before_configurations |
Array of Configuration objects |
Source configuration. |
after_configurations |
Array of Configuration objects |
Target configuration. |
Parameter |
Type |
Description |
---|---|---|
data |
Component configuration data. |
|
operated_at |
String |
Operation time. |
operation_id |
String |
Operation ID. |
type |
String |
Definition Component configuration type. Constraints N/A Value Range
Default Value N/A |
is_activated |
Boolean |
Whether the configuration has taken effect. |
is_using |
Boolean |
Whether the configuration is in use. |
Parameter |
Type |
Description |
---|---|---|
spec |
Component configuration data specifications. |
|
metadata |
ConfigurationDataMetadata object |
Component configuration metadata. |
Parameter |
Type |
Description |
---|---|---|
rds_id |
String |
RDS instance ID. This parameter is returned when type under Configuration is set to rds. |
rds_db_name |
String |
RDS database name. This parameter is returned when type under Configuration is set to rds. |
rds_address |
String |
RDS database address. This parameter is returned when type under Configuration is set to rds. |
rds_username |
String |
RDS database username. This parameter is returned when type under Configuration is set to rds. |
rds_password |
String |
RDS database password. This parameter is returned when type under Configuration is set to rds. |
rds_port |
String |
RDS database port. This parameter is returned when type under Configuration is set to rds. |
config_center_addr |
String |
Address of the CSE configuration center. This parameter is returned when type under Configuration is set to cse. |
service_center_addr |
String |
Address for service registry and discovery. This parameter is returned when type under Configuration is set to cse. |
cse_id |
String |
CSE engine ID. This parameter is returned when type under Configuration is set to cse. |
envs |
Environment variable. This parameter is returned when type under Configuration is set to env. Common environment variables:
|
|
env_references |
env_references object |
Environment variable to be imported using a secret. |
ip |
String |
EIP, which is returned when no domain name is configured. |
items |
Array of AccessConfigurationDataItems objects |
Access configuration list. This parameter is returned when type under Configuration is set to access. |
scale_strategy |
String |
AS policy type. This parameter is returned when type under Configuration is set to scaling. |
max_replica_count |
Integer |
Maximum number of instances that can be scaled in an AS policy. This parameter is returned when type under Configuration is set to scaling. |
min_replica_count |
Integer |
Minimum number of instances that can be scaled in an AS policy. This parameter is returned when type under Configuration is set to scaling. |
advanced |
Advanced settings of an AS policy. This parameter is returned when type under Configuration is set to scaling. |
|
triggers |
Array of ScaleConfigurationDataTrigger objects |
Trigger list of an AS policy. This parameter is returned when type under Configuration is set to scaling. |
volumes |
Array of VolumeConfigurationDataVolume objects |
Cloud storage configuration list. This parameter is returned when type under Configuration is set to volume. |
livenessProbe |
Liveness probe configuration for health check. This parameter is returned when type under Configuration is set to healthCheck. |
|
startupProbe |
Startup probe configuration for health check. This parameter is returned when type under Configuration is set to healthCheck. |
|
readinessProbe |
Readiness probe configuration for health check. This parameter is returned when type under Configuration is set to healthCheck. |
|
postStart |
postStart object |
Post-startup processing configured for lifecycle management. This parameter is returned when type under Configuration is set to lifecycle. |
preStop |
preStop object |
Pre-stop processing configured for lifecycle management. This parameter is returned when type under Configuration is set to lifecycle. |
log_paths |
Array of strings |
Custom local disk log path array. This parameter is returned when type under Configuration is set to log. |
cloud_storage_log_paths |
Array of CloudStorageLogPathInfo objects |
Custom cloud storage log path array. This parameter is returned when type under Configuration is set to log. |
instrumentation |
String |
Agent injection mode. This parameter is returned when type under Configuration is set to apm2. |
apm_application |
String |
APM 2.0 application. This parameter is returned when type under Configuration is set to apm2. |
type |
String |
Monitoring system type, including apm2 and opentelemetry. This parameter is returned when type under Configuration is set to apm2. |
app_name |
String |
APM 2.0 component. This parameter is returned when type under Configuration is set to apm2. |
instance_name |
String |
APM 2.0 instance. This parameter is returned when type under Configuration is set to apm2. |
env_name |
String |
APM 2.0 environment. This parameter is returned when type under Configuration is set to apm2. |
image_pull_policy |
String |
Agent image update policy, which has been discarded and migrated to the monitoring system.
This parameter is returned when type under Configuration is set to apm2. |
version |
String |
Enhanced/OpenTelemetry probe version, which has been discarded and migrated to the monitoring system. This parameter is returned when type under Configuration is set to apm2. |
access_key |
String |
APM 2.0 access key, which has been discarded and migrated to the monitoring system. This parameter is returned when type under Configuration is set to apm2. |
access_value |
String |
APM 2.0 access key value, which has been discarded and migrated to the monitoring system. This parameter is returned when type under Configuration is set to apm2. |
business |
String |
APM 2.0 application, which is the same as apm_application and has been discarded. This parameter is returned when type under Configuration is set to apm2. |
path |
String |
Collection path for custom metric monitoring. This parameter is returned when type under Configuration is set to customMetric. |
port |
Integer |
Collection port for custom metric monitoring. This parameter is returned when type under Configuration is set to customMetric. |
metrics |
Array of strings |
Metric for custom monitoring. This parameter is returned when type under Configuration is set to customMetric. |
Parameter |
Type |
Description |
---|---|---|
{User defined key} |
Map<String,String> |
Environment variable. Common environment variables:
|
Parameter |
Type |
Description |
---|---|---|
env_name |
String |
Environment variable name. |
value_from |
value_from object |
Variable source information. |
Parameter |
Type |
Description |
---|---|---|
name |
String |
Source resource name. |
reference_type |
String |
Definition Source kind. Range
|
Parameter |
Type |
Description |
---|---|---|
operator |
String |
Configuration mode.
|
uid |
String |
UID of the access mode. |
metadata |
AccessConfigurationMetadata object |
Access mode configuration metadata. |
type |
String |
Access mode type. |
sub_type |
String |
Access mode subtype. |
ingress_config_id |
String |
ID of the associated domain name suffix. Use commas (,) to separate multiple domain name suffixes. |
domain_names |
Array of strings |
Domain name for private network access. |
access_control |
AccessControl object |
Access control configuration. Blacklists and whitelists can be configured. |
ports |
Array of AccessConfigurationPort objects |
Access information, such as the port, protocol, certificate, and URL. |
elb_id |
String |
Selected ELB ID. |
public_ip |
String |
Response body parameter, which indicates the public IP address of the selected ELB. |
private_ip |
String |
Response body parameter, which indicates the private IP address of the selected ELB. |
Parameter |
Type |
Description |
---|---|---|
annotations |
Map<String,String> |
Additional parameters. Assume that you need to use the weighted round robin algorithm for load balancing and disable health check. The configuration is as follows:
|
Parameter |
Type |
Description |
---|---|---|
black |
Array of strings |
Blacklist array.
|
white |
Array of strings |
Whitelist array.
|
Parameter |
Type |
Description |
---|---|---|
operator |
String |
Configuration mode.
|
uid |
String |
UID of the port. |
target_port |
Integer |
Listening port. |
port |
Integer |
Access port. |
protocol |
String |
Protocol. Load balancing supports TCP, HTTP, and HTTPS while route configuration supports HTTP and HTTPS. |
default_certificate |
String |
Default certificate, which is configured when the access mode is set to Ingress and protocol is set to HTTPS. It will be used if SNI is not configured. |
certificate |
String |
Certificate. |
policy |
String |
Security policy. |
paths |
Array of AccessConfigurationHttpPath objects |
Path and domain name for matching. |
elb_id |
String |
Selected ELB ID. |
Parameter |
Type |
Description |
---|---|---|
hostname |
String |
Domain name. If it is left blank, the IP address is used. |
path |
String |
URL. |
url_match_mode |
String |
URL path matching mode. Options: STARTS_WITH, REGEX, and EQUAL_TO. |
Parameter |
Type |
Description |
---|---|---|
scaledown_stabilization_seconds |
Integer |
Cooling time window for scale-in. |
scaledown_rate |
Integer |
Scale-in step. |
scaleup_stabilization_seconds |
Integer |
Cooling time window for scale-out. |
scaleup_rate |
Integer |
Scale-out step. |
disable_scaledown |
Boolean |
Whether to disable automatic scale-in. |
Parameter |
Type |
Description |
---|---|---|
type |
String |
Definition Metric type. Range
|
metadata |
ScalingTriggerMeta object |
Metadata. |
Parameter |
Type |
Description |
---|---|---|
type |
String |
Data type, which can only be Utilization. This parameter is mandatory when type under ScaleConfigurationDataTrigger is set to cpu or memory. |
value |
String |
Threshold for triggering scaling. This parameter is mandatory when type under ScaleConfigurationDataTrigger is set to cpu or memory. |
period_type |
String |
Validity period. This parameter is mandatory when type under ScaleConfigurationDataTrigger is set to cron. |
schedulers |
Array of CronTriggerScheduler objects |
Time when the scaling is triggered and number of instances triggered in each period. This parameter is mandatory when type under ScaleConfigurationDataTrigger is set to cron. |
Parameter |
Type |
Description |
---|---|---|
cron |
String |
Trigger time, which is a cron expression consisting of five fields. |
target_replica |
Integer |
Number of required instances. |
Parameter |
Type |
Description |
---|---|---|
volume_id |
String |
Cloud storage ID. |
resource_name |
String |
Cloud storage name. |
resource_type |
String |
Definition Resource type. Range
|
resource_sub_type |
String |
Definition Resource sub-type. Range
|
umask |
String |
Default permission on a directory or file. SFS 3.0 cloud storage does not support this parameter. Default value: 0027. |
mount_info |
Array of VolumeConfigurationMountInfo objects |
Cloud storage mounting information. |
Parameter |
Type |
Description |
---|---|---|
path |
String |
Container mount path. |
sub_path |
String |
Subpath. |
access_mode |
String |
Read or write permission. |
Parameter |
Type |
Description |
---|---|---|
periodSeconds |
Integer |
Detection period. Unit: second. |
initialDelaySeconds |
Integer |
Latency. Unit: second. |
timeoutSeconds |
Integer |
Timeout. Unit: second. |
successThreshold |
Integer |
Success threshold. |
failureThreshold |
Integer |
Failure threshold. |
httpGet |
HTTP request check information in the health check configuration. |
|
tcpSocket |
TCP port check information in the health check configuration. |
|
exec |
HealthCheckConfigurationExec object |
Command check information in the health check configuration. |
Parameter |
Type |
Description |
---|---|---|
periodSeconds |
Integer |
Detection period. Unit: second. |
initialDelaySeconds |
Integer |
Latency. Unit: second. |
timeoutSeconds |
Integer |
Timeout. Unit: second. |
successThreshold |
Integer |
Success threshold. |
failureThreshold |
Integer |
Failure threshold. |
httpGet |
HTTP request check information in the health check configuration. |
|
tcpSocket |
TCP port check information in the health check configuration. |
|
exec |
HealthCheckConfigurationExec object |
Command check information in the health check configuration. |
Parameter |
Type |
Description |
---|---|---|
periodSeconds |
Integer |
Detection period. Unit: second. |
initialDelaySeconds |
Integer |
Latency. Unit: second. |
timeoutSeconds |
Integer |
Timeout. Unit: second. |
successThreshold |
Integer |
Success threshold. |
failureThreshold |
Integer |
Failure threshold. |
httpGet |
HTTP request check information in the health check configuration. |
|
tcpSocket |
TCP port check information in the health check configuration. |
|
exec |
HealthCheckConfigurationExec object |
Command check information in the health check configuration. |
Parameter |
Type |
Description |
---|---|---|
path |
String |
URL. |
port |
Integer |
Port. |
scheme |
String |
Protocol. |
Parameter |
Type |
Description |
---|---|---|
command |
Array of strings |
Shell statement. |
Parameter |
Type |
Description |
---|---|---|
command |
Array of strings |
Shell statement. |
Parameter |
Type |
Description |
---|---|---|
dir_path |
String |
Container mount path. |
file_name_pattern |
String |
Log file name matching mode. |
Parameter |
Type |
Description |
---|---|---|
annotations |
Map<String,String> |
Additional parameters. Assume that you need to use the weighted round robin algorithm for load balancing and disable health check. The configuration is as follows:
|
Example Requests
/v1/196e2e151e7946ff870a911a6204dc3e/cae/applications/b990e0f2-1f06-432b-8bee-5e8590404d5f/components/3b77ac1d-ba70-4839-9ff3-d6a62bb3e098/configuration-history?operation_id=0&last_operation_id=e466eb27-2f69-445c-893b-834dcdbf7665
Example Responses
Status code: 200
OK
{ "before_configurations" : [ { "type" : "env", "data" : { "spec" : { "envs" : { "env1" : "1" } } }, "operation_id" : "e466eb27-2f69-445c-893b-834dcdbf7665", "operated_at" : "2025-09-15T08:16:13.277378Z", "is_activated" : false, "is_using" : false } ], "after_configurations" : [ ] }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot