Help Center/ Cloud Application Engine/ API Reference/ CAE API/ Component configuration./ Comparison Information of the Queried Historical Version
Updated on 2025-10-22 GMT+08:00

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

Table 1 Path Parameters

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.

Table 2 Query Parameters

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

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

  • Obtain the token. For details, see "Obtaining a User Token" in Identity and Access Management API Reference (https://support.huaweicloud.com/intl/en-us/api-iam/iam_30_0001.html).

  • The value of X-Subject-Token in the response header is the token value.

X-Enterprise-Project-ID

No

String

Enterprise project ID.

  • When an environment is created, it will be bound with an enterprise project ID.

  • Enter 0 or up to 36 characters in UUID format with hyphens (-).

  • If this parameter is not specified or set to 0, resources in the default enterprise project are queried.

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

Table 4 Response body parameters

Parameter

Type

Description

before_configurations

Array of Configuration objects

Source configuration.

after_configurations

Array of Configuration objects

Target configuration.

Table 5 Configuration

Parameter

Type

Description

data

ListComponentConfigurationsResponseData object

Component configuration data.

operated_at

String

Operation time.

operation_id

String

Operation ID.

type

String

Definition

Component configuration type.

Constraints

N/A

Value Range

  • rds

  • cse

  • env: environment variable

  • access: access mode

  • scaling: scaling policy

  • volume: cloud storage configuration

  • healthCheck

  • lifecycle: lifecycle management

  • apm2: performance management

  • log: log collection

  • customMetric: custom monitoring metric

Default Value

N/A

is_activated

Boolean

Whether the configuration has taken effect.

is_using

Boolean

Whether the configuration is in use.

Table 6 ListComponentConfigurationsResponseData

Parameter

Type

Description

spec

ConfigurationResponseDataSpec object

Component configuration data specifications.

metadata

ConfigurationDataMetadata object

Component configuration metadata.

Table 7 ConfigurationResponseDataSpec

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

EnvConfigurationDataAnnotations object

Environment variable.

This parameter is returned when type under Configuration is set to env.

Common environment variables:

  • TZ: time zone. For example, set Asia/Shanghai for GMT+08:00.

  • LANG: language.

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

ScaleConfigurationDataAdvanced object

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

HealthCheckConfigurationLivenessProbe object

Liveness probe configuration for health check.

This parameter is returned when type under Configuration is set to healthCheck.

startupProbe

HealthCheckConfigurationStartupProbe object

Startup probe configuration for health check.

This parameter is returned when type under Configuration is set to healthCheck.

readinessProbe

HealthCheckConfigurationReadinessProbe object

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.

  • Always: automatic upgrade upon restart. The system downloads the image upon each restart.

  • IfNotPresent: manual upgrade. Download an image only when no local image is available.

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.

Table 8 envs

Parameter

Type

Description

{User defined key}

Map<String,String>

Environment variable.

Common environment variables:

  • TZ: time zone. For example, set Asia/Shanghai for GMT+08:00.

  • LANG: language.

Table 9 env_references

Parameter

Type

Description

env_name

String

Environment variable name.

value_from

value_from object

Variable source information.

Table 10 value_from

Parameter

Type

Description

name

String

Source resource name.

reference_type

String

Definition

Source kind.

Range

  • dewSecret: DEW secret

Table 11 AccessConfigurationDataItems

Parameter

Type

Description

operator

String

Configuration mode.

  • If the value of operator is empty, the full overwrite mode is used. Otherwise, the addition, deletion, and modification mode is used.

  • When the addition, deletion, and modification mode is used, the value of operator can be add, copy, modify, or delete, indicating to add, copy an element with a specified UID and add, modify, or delete an element, respectively.

  • When operator is set to copy, modify, or delete, the uid must not be empty and must exist in the configuration that takes effect last time.

  • When operator is set to copy or modify, if all fields except uid in the fields of the same level as operator are not set or left empty, or the list is empty, the value of the same field of the element specified by uid in the last effective configuration is retained. In addition, the operator values of all elements in the list, parent list, and child list must be empty or not empty.

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.

Table 12 AccessConfigurationMetadata

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:

  • "kubernetes.io/elb.health-check-flag": "off"

  • "kubernetes.io/elb.lb-algorithm": "ROUND_ROBIN"

Table 13 AccessControl

Parameter

Type

Description

black

Array of strings

Blacklist array.

  • Each line must contain an IP address or a CIDR block and end with a line break.

  • You can add a maximum of 300 IP addresses or CIDR blocks to each IP address group.

white

Array of strings

Whitelist array.

  • Each line must contain an IP address or a CIDR block and end with a line break.

  • You can add a maximum of 300 IP addresses or CIDR blocks to each IP address group.

Table 14 AccessConfigurationPort

Parameter

Type

Description

operator

String

Configuration mode.

  • If the value of operator is empty, the full overwrite mode is used. Otherwise, the addition, deletion, and modification mode is used.

  • When the addition, deletion, and modification mode is used, the value of operator can be add, copy, modify, or delete, indicating to add, copy an element with a specified UID and add, modify, or delete an element, respectively.

  • When operator is set to copy, modify, or delete, the uid must not be empty and must exist in the configuration that takes effect last time.

  • When operator is set to copy or modify, if all fields except uid in the fields of the same level as operator are not set or left empty, or the list is empty, the value of the same field of the element specified by uid in the last effective configuration is retained. In addition, the operator values of all elements in the list, parent list, and child list must be empty or not empty.

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.

Table 15 AccessConfigurationHttpPath

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.

Table 16 ScaleConfigurationDataAdvanced

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.

Table 17 ScaleConfigurationDataTrigger

Parameter

Type

Description

type

String

Definition

Metric type.

Range

  • cpu

  • memory

  • cron: scheduled metric

  • prometheus

metadata

ScalingTriggerMeta object

Metadata.

Table 18 ScalingTriggerMeta

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.

Table 19 CronTriggerScheduler

Parameter

Type

Description

cron

String

Trigger time, which is a cron expression consisting of five fields.

target_replica

Integer

Number of required instances.

Table 20 VolumeConfigurationDataVolume

Parameter

Type

Description

volume_id

String

Cloud storage ID.

resource_name

String

Cloud storage name.

resource_type

String

Definition

Resource type.

Range

  • obs: for object_bucket and parallel_file_system.

  • sfs: for sfs3.0 and sfs_turbo.

resource_sub_type

String

Definition

Resource sub-type.

Range

  • object_bucket

  • parallel_file_system

  • sfs3.0

  • sfs_turbo

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.

Table 21 VolumeConfigurationMountInfo

Parameter

Type

Description

path

String

Container mount path.

sub_path

String

Subpath.

access_mode

String

Read or write permission.

Table 22 HealthCheckConfigurationLivenessProbe

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

HealthCheckConfigurationHttpGet object

HTTP request check information in the health check configuration.

tcpSocket

HealthCheckConfigurationTcpSocket object

TCP port check information in the health check configuration.

exec

HealthCheckConfigurationExec object

Command check information in the health check configuration.

Table 23 HealthCheckConfigurationStartupProbe

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

HealthCheckConfigurationHttpGet object

HTTP request check information in the health check configuration.

tcpSocket

HealthCheckConfigurationTcpSocket object

TCP port check information in the health check configuration.

exec

HealthCheckConfigurationExec object

Command check information in the health check configuration.

Table 24 HealthCheckConfigurationReadinessProbe

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

HealthCheckConfigurationHttpGet object

HTTP request check information in the health check configuration.

tcpSocket

HealthCheckConfigurationTcpSocket object

TCP port check information in the health check configuration.

exec

HealthCheckConfigurationExec object

Command check information in the health check configuration.

Table 25 HealthCheckConfigurationHttpGet

Parameter

Type

Description

path

String

URL.

port

Integer

Port.

scheme

String

Protocol.

Table 26 HealthCheckConfigurationTcpSocket

Parameter

Type

Description

port

Integer

Port.

Table 27 HealthCheckConfigurationExec

Parameter

Type

Description

command

Array of strings

Shell statement.

Table 28 postStart

Parameter

Type

Description

exec

LifeCycleConfigurationExec object

Command.

Table 29 preStop

Parameter

Type

Description

exec

LifeCycleConfigurationExec object

Command.

Table 30 LifeCycleConfigurationExec

Parameter

Type

Description

command

Array of strings

Shell statement.

Table 31 CloudStorageLogPathInfo

Parameter

Type

Description

dir_path

String

Container mount path.

file_name_pattern

String

Log file name matching mode.

Table 32 ConfigurationDataMetadata

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:

  • "kubernetes.io/elb.health-check-flag": "off"

  • "kubernetes.io/elb.lb-algorithm": "ROUND_ROBIN"

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.