- Release Notes
- Product Introduction
- Purchase Guide
- Getting Started
- Operation Guide
- Best Practice
- API Documentation
- FAQs
- Contact Us
- Glossary
- TEM Policy
- Release Notes
- Product Introduction
- Purchase Guide
- Getting Started
- Operation Guide
- Best Practice
- API Documentation
- FAQs
- Contact Us
- Glossary
- TEM Policy
CosToken
Cos token
Used by actions: CreateCosToken.
| Name | Type | Description |
|---|---|---|
| RequestId | String | Unique request ID |
| Bucket | String | Bucket name |
| Region | String | Bucket region |
| TmpSecretId | String | Temporary key SecretId |
| TmpSecretKey | String | Temporary key SecretKey |
| SessionToken | String | sessionToken of temporary key |
| StartTime | String | Start time of temporary key acquisition |
| ExpiredTime | String | ExpiredTime of temporary key |
| FullPath | String | Full package path |
CronHorizontalAutoscaler
Scheduled Scaling Policy
Used by actions: DeployApplication.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | Yes | Name of a scheduled scaling policy |
| Period | String | Yes | Policy period "* * " indicates three ranges. The first is day, the second month, and the third week. The three parts are separated by spaces. Examples: * * (every day) * * 0-3 (every Sunday through Wednesday) 1,11,21 * * (1st, 11th, and 21st of every month) |
| Schedules | Array of CronHorizontalAutoscalerSchedule | Yes | Details of a scheduled scaling policy |
| Enabled | Boolean | Yes | Enabled or not |
| Priority | Integer | No | Policy priority. The higher the value, the higher the priority. The minimum value is 0. |
CronHorizontalAutoscalerSchedule
Details of a scheduled scaling policy
Used by actions: DeployApplication.
| Name | Type | Required | Description |
|---|---|---|---|
| StartAt | String | Yes | Triggering time, in the format of HH:MM Example: 00:00 (Trigger at midnight) |
| TargetReplicas | Integer | No | Number of target pods (less than 50) Note: this field may return null, indicating that no valid values can be obtained. |
DeployStrategyConf
Configuration of batch release policies
Used by actions: DeployApplication.
| Name | Type | Required | Description |
|---|---|---|---|
| TotalBatchCount | Integer | No | Total batches |
| BetaBatchNum | Integer | No | Number of pods for the beta batch |
| DeployStrategyType | Integer | No | Batch deployment policy. 0: automatically; 1: manually; 2: beta batch (manual), 3: initial release |
| BatchInterval | Integer | No | Interval between batches |
| MinAvailable | Integer | No | The minimum number of available pods |
| Force | Boolean | No | Whether to enable force release |
DescribeRunPodPage
Version pod list
Used by actions: DescribeApplicationPods.
| Name | Type | Description |
|---|---|---|
| Offset | Integer | Page offset |
| Limit | Integer | Number of records per page |
| TotalCount | Integer | Total number of returned records |
| RequestId | String | Request ID |
| PodList | Array of RunVersionPod | List of pods |
EksService
EKS service information
Used by actions: DeployApplication.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | No | Service name |
| Ports | Array of Integer | No | Available ports |
| Yaml | String | No | Yaml contents |
| ApplicationName | String | No | Service name Note: this field may return null, indicating that no valid values can be obtained. |
| VersionName | String | No | Version name Note: this field may return null, indicating that no valid values can be obtained. |
| ClusterIp | Array of String | No | Private IP Note: this field may return null, indicating that no valid values can be obtained. |
| ExternalIp | String | No | Public IP Note: this field may return null, indicating that no valid values can be obtained. |
| Type | String | No | The access type. Valid values: - EXTERNAL (internet access) - VPC (Intra-VPC access) - CLUSTER (Intra-cluster access) Note: this field may return null, indicating that no valid values can be obtained. |
| SubnetId | String | No | Subnet ID. It is filled when the access type is VPC.Note: this field may return null, indicating that no valid values can be obtained. |
| LoadBalanceId | String | No | Load balancer ID. It is filled when the access type is EXTERNAL or CLUSTER. It’s created automatically by default.Note: this field may return null, indicating that no valid values can be obtained. |
| PortMappings | Array of PortMapping | No | Port mapping Note: this field may return null, indicating that no valid values can be obtained. |
EnablePrometheusConf
Enable Prometheus monitoring
Used by actions: DeployApplication.
| Name | Type | Required | Description |
|---|---|---|---|
| Port | Integer | No | The listening port of the applicaiton |
| Path | String | No | URL path for monitoring |
EsInfo
Auto scaling configuration
Used by actions: DeployApplication.
| Name | Type | Required | Description |
|---|---|---|---|
| MinAliveInstances | Integer | Yes | Minimum number of instances |
| MaxAliveInstances | Integer | Yes | Maximum number of instances |
| EsStrategy | Integer | Yes | Auto scaling policy. 1: CPU; 2: memory |
| Threshold | Integer | Yes | Auto scaling condition value |
| VersionId | String | No | Version ID |
HealthCheckConfig
Health check configuration
Used by actions: DeployApplication.
| Name | Type | Required | Description |
|---|---|---|---|
| Type | String | Yes | Health check type. Valid values: HttpGet, TcpSocket, Exec |
| Protocol | String | No | The protocol type. It’s only valid when the health check type is HttpGet. |
| Path | String | No | The request path. It’s only valid when the health check type is HttpGet. |
| Exec | String | No | The script to be executed. It’s only valid when the health check type is Exec. |
| Port | Integer | No | The request port. It’s only valid when the health check type is HttpGet or TcpSocket . |
| InitialDelaySeconds | Integer | No | The initial delay for health check in seconds. Default: 0 |
| TimeoutSeconds | Integer | No | Timeout period in seconds. Default: 1 |
| PeriodSeconds | Integer | No | Interval period in seconds. Default: 10 |
HorizontalAutoscaler
Auto scaling policy
Used by actions: DeployApplication.
| Name | Type | Required | Description |
|---|---|---|---|
| MinReplicas | Integer | Yes | Minimum number of instances |
| MaxReplicas | Integer | Yes | Maximum number of instances |
| Metrics | String | Yes | Metrics (CPU or memory) |
| Threshold | Integer | Yes | Threshold (percentage) |
IngressInfo
Ingress configuration
Used by actions: DescribeIngress, DescribeIngresses, DescribeRelatedIngresses, ModifyIngress.
| Name | Type | Required | Description |
|---|---|---|---|
| EnvironmentId | String | Yes | Environment ID Note: this field may return null, indicating that no valid values can be obtained. |
| ClusterNamespace | String | Yes | Environment namespace |
| AddressIPVersion | String | Yes | ip version |
| IngressName | String | Yes | ingress name |
| Rules | Array of IngressRule | Yes | Rules configuration |
| ClbId | String | No | clb ID Note: this field may return null, indicating that no valid values can be obtained. |
| Tls | Array of IngressTls | No | TLS configuration Note: this field may return null, indicating that no valid values can be obtained. |
| ClusterId | String | No | Environment cluster ID Note: this field may return null, indicating that no valid values can be obtained. |
| Vip | String | No | clb ip Note: this field may return null, indicating that no valid values can be obtained. |
| CreateTime | String | No | Creation time Note: this field may return null, indicating that no valid values can be obtained. |
| Mixed | Boolean | No | Whether to listen on both the HTTP 80 port and HTTPS 443 port. The default value is false. The optional value true means listening on both the HTTP 80 port and HTTPS 443 port. |
| RewriteType | String | No | Redirection mode. Values: - AUTO (automatically redirect HTTP to HTTPS)- NONE (no redirection)Note: This field may return null, indicating that no valid value can be obtained. |
IngressRule
Ingress rule configuration
Used by actions: DescribeIngress, DescribeIngresses, DescribeRelatedIngresses, ModifyIngress.
| Name | Type | Required | Description |
|---|---|---|---|
| Http | IngressRuleValue | Yes | ingress rule value |
| Host | String | No | Host address Note: this field may return null, indicating that no valid values can be obtained. |
| Protocol | String | No | Protocol. Options include HTTP and HTTPS. The default option is HTTP. |
IngressRuleBackend
Ingress rule backend configuration
Used by actions: DescribeIngress, DescribeIngresses, DescribeRelatedIngresses, ModifyIngress.
| Name | Type | Required | Description |
|---|---|---|---|
| ServiceName | String | Yes | EKS service name |
| ServicePort | Integer | Yes | EKS service port |
IngressRulePath
Ingress rule path configuration
Used by actions: DescribeIngress, DescribeIngresses, DescribeRelatedIngresses, ModifyIngress.
| Name | Type | Required | Description |
|---|---|---|---|
| Path | String | Yes | Path information |
| Backend | IngressRuleBackend | Yes | Backend configuration |
IngressRuleValue
Ingress rule value configuration
Used by actions: DescribeIngress, DescribeIngresses, DescribeRelatedIngresses, ModifyIngress.
| Name | Type | Required | Description |
|---|---|---|---|
| Paths | Array of IngressRulePath | Yes | Overall rule configuration |
IngressTls
Ingress TLS configuration
Used by actions: DescribeIngress, DescribeIngresses, DescribeRelatedIngresses, ModifyIngress.
| Name | Type | Required | Description |
|---|---|---|---|
| Hosts | Array of String | Yes | Host array. An empty array indicates the default certificate for all domain names. |
| SecretName | String | Yes | Secret name. If a certificate is used, this field is left empty. |
| CertificateId | String | No | SSL Certificate Id |
LogOutputConf
Log output configuration
Used by actions: DeployApplication.
| Name | Type | Required | Description |
|---|---|---|---|
| OutputType | String | Yes | Log consumer type |
| ClsLogsetName | String | No | CLS logset |
| ClsLogTopicId | String | No | CLS log topic |
| ClsLogsetId | String | No | CLS logset ID |
| ClsLogTopicName | String | No | CLS log topic name |
MountedSettingConf
Mounting configurations
Used by actions: DeployApplication.
| Name | Type | Required | Description |
|---|---|---|---|
| ConfigDataName | String | Yes | Configuration name |
| MountedPath | String | Yes | Mount point path |
| Data | Array of Pair | No | Configuration content |
| SecretDataName | String | No | Encrypt configuration name |
NamespacePage
Namespace query result pagination
Used by actions: DescribeEnvironments.
| Name | Type | Description |
|---|---|---|
| Records | Array of TemNamespaceInfo | Details of the returned records |
| Total | Integer | Total number of returned records |
| Size | Integer | Number of records per page |
| Pages | Integer | Total number of pages |
Pair
Key value pair
Used by actions: DeployApplication.
| Name | Type | Required | Description |
|---|---|---|---|
| Key | String | Yes | Key |
| Value | String | Yes | Value |
| Type | String | No | default``: Custom. reserved: System variable. referenced: Referenced configuration item.<br/>Note: This field may return null`, indicating that no valid value can be found. |
| Config | String | No | Configuration name Note: This field may return null, indicating that no valid value can be found. |
| Secret | String | No | Encrypt configuration name Note: This field may return null, indicating that no valid value was found. |
PortMapping
Service port mapping
Used by actions: DeployApplication.
| Name | Type | Required | Description |
|---|---|---|---|
| Port | Integer | Yes | Port. |
| TargetPort | Integer | Yes | Mapped port |
| Protocol | String | Yes | TCP/UDP protocol stack. |
RunVersionPod
Application pod
Used by actions: DescribeApplicationPods.
| Name | Type | Description |
|---|---|---|
| Webshell | String | Shell address |
| PodId | String | Pod ID |
| Status | String | Status |
| CreateTime | String | Creation time |
| PodIp | String | Pod IP |
| Zone | String | Availability zone Note: this field may return null, indicating that no valid values can be obtained. |
| DeployVersion | String | Deployed version Note: this field may return null, indicating that no valid values can be obtained. |
| RestartCount | Integer | Number of restarts Note: this field may return null, indicating that no valid values can be obtained. |
| Ready | Boolean | Whether the pod is ready Note: this field may return null, indicating that no valid values can be obtained. |
| ContainerState | String | Container status Note: this field may return null, indicating that no valid values can be obtained. |
StorageConf
Storage volume configuration
Used by actions: DeployApplication.
| Name | Type | Required | Description |
|---|---|---|---|
| StorageVolName | String | Yes | Storage volume name |
| StorageVolPath | String | Yes | Storage volume path |
| StorageVolIp | String | No | Storage volume IP Note: this field may return null, indicating that no valid values can be obtained. |
StorageMountConf
Data volume mount information
Used by actions: DeployApplication.
| Name | Type | Required | Description |
|---|---|---|---|
| VolumeName | String | Yes | Data volume name |
| MountPath | String | Yes | Data volume binding path |
TemNamespaceInfo
Namespace object
Used by actions: DescribeEnvironments.
| Name | Type | Description |
|---|---|---|
| EnvironmentId | String | Environment ID |
| Channel | String | Channel |
| EnvironmentName | String | Environment name |
| Region | String | Region name |
| Description | String | Environment description Note: this field may return null, indicating that no valid values can be obtained. |
| Status | Integer | Status. 1: terminated; 0: normal |
| Vpc | String | VPC network |
| CreateDate | String | Creation time |
| ModifyDate | String | Modification time |
| Modifier | String | Modifier |
| Creator | String | Creator |
| ApplicationNum | Integer | Number of applications |
| RunInstancesNum | Integer | Number of running instances |
| SubnetId | String | Subnet |
| ClusterStatus | String | Environment cluster status |
| EnableTswTraceService | Boolean | Whether to enable TSW |
| Locked | Integer | Whether the environment is locked. 1: locked; 0: not locked |
Yes
No
Was this page helpful?