Tencent Cloud

Prev Next

请输入关键字

Recent Pages

文档

Download PDF

Data Types

最后更新时间：2023-03-24 10:18:14

下载PDF

Autoscaler

Scaling rule

Used by actions: CreateApplicationAutoscaler, DescribeApplicationAutoscalerList, DescribeApplicationInfo, ModifyApplicationAutoscaler.

Name	Type	Required	Description
MinReplicas	Integer	Yes	Minimum number of instances in a scaling group
MaxReplicas	Integer	Yes	Maximum number of instances in a scaling group
HorizontalAutoscaler	Array of HorizontalAutoscaler	No	Policy of the scaling rule Note: This field may return `null`, indicating that no valid values can be obtained.
CronHorizontalAutoscaler	Array of CronHorizontalAutoscaler	No	Scheduled auto-scaler policy Note: This field may return `null`, indicating that no valid values can be obtained.
AutoscalerId	String	No	Scaling rule ID Note: This field may return `null`, indicating that no valid values can be obtained.
AutoscalerName	String	No	Scaling rule name Note: This field may return `null`, indicating that no valid values can be obtained.
Description	String	No	Description of the scaling rule Note: This field may return `null`, indicating that no valid values can be obtained.
CreateDate	String	No	Creation time Note: This field may return `null`, indicating that no valid values can be obtained.
ModifyDate	String	No	Modification time Note: This field may return `null`, indicating that no valid values can be obtained.
EnableDate	String	No	Start Time Note: This field may return `null`, indicating that no valid values can be obtained.
Enabled	Boolean	No	Whether it is enabled Note: This field may return `null`, indicating that no valid values can be obtained.

ConfigData

Configuration

Used by actions: DescribeConfigData, DescribeConfigDataList.

Name	Type	Description
Name	String	Configuration name
CreateTime	String	Creation time.
RelatedApplications	Array of TemService	List of associated applications
Data	Array of Pair	Configuration item

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: CreateApplicationAutoscaler, DeployApplication, DescribeApplicationAutoscalerList, DescribeApplicationInfo, ModifyApplicationAutoscaler.

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: CreateApplicationAutoscaler, DeployApplication, DescribeApplicationAutoscalerList, DescribeApplicationInfo, ModifyApplicationAutoscaler.

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, DescribeApplicationInfo.

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

DescribeConfigDataListPage

Query the list of configurations

Used by actions: DescribeConfigDataList.

Name	Type	Description
Records	Array of ConfigData	Record
ContinueToken	String	Paging cursor Note: This field may return `null`, indicating that no valid values can be obtained.
RemainingCount	Integer	Remaining number Note: This field may return `null`, indicating that no valid values can be obtained.

DescribeRunPodPage

Version pod list

Used by actions: DescribeApplicationInfo, DescribeApplicationPods, DescribeApplicationsStatus.

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, DescribeApplicationInfo, DescribeApplicationServiceList, ModifyApplicationService.

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.
ServicePortMappingList	Array of ServicePortMapping	No	Details of each type of access configuration Note: This field may return `null`, indicating that no valid values can be obtained.
FlushAll	Boolean	No	Flush all types Note: This field may return `null`, indicating that no valid values can be obtained.
EnableRegistryNextDeploy	Integer	No	`0`: Do not inject. `1`: Inject registry information automatically for the next deployment Note: This field may return `null`, indicating that no valid values can be obtained.
ApplicationId	String	No	The application ID returned. Note: This field may return `null`, indicating that no valid values can be obtained.
AllIpDone	Boolean	No	Whether all the application IPs are ready Note: This field may return `null`, indicating that no valid values can be obtained.
ExternalDomain	String	No	CLB domain name Note: This field may return `null`, indicating that no valid values can be obtained.

EnablePrometheusConf

Enable Prometheus monitoring

Used by actions: DeployApplication, DescribeApplicationInfo.

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, DescribeApplicationInfo.

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, DescribeApplicationInfo.

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: CreateApplicationAutoscaler, DeployApplication, DescribeApplicationAutoscalerList, DescribeApplicationInfo, ModifyApplicationAutoscaler.

Name	Type	Required	Description
MinReplicas	Integer	No	(Optional) Minimum number of instances
MaxReplicas	Integer	No	(Optional) Maximum number of instances
Metrics	String	No	Metric measurement `CPU`: CPU utilization (%) `MEMORY`: Memory utilization (%) `CPU_CORE_USED`: CPU usage (core) `MEMORY_SIZE_USED`: Memory usage (MiB) `NETWORK_BANDWIDTH_RECEIVE`: Network bandwidth in (Mbps) `NETWORK_BANDWIDTH_TRANSMIT`: Network bandwidth out (Mbps) `NETWORK_TRAFFIC_RECEIVE`: Network traffic in (MiB/s) `NETWORK_TRAFFIC_TRANSMIT`: Network traffic out (MiB/s) `NETWORK_PACKETS_RECEIVE`: Network packets in (packets/sec) `NETWORK_PACKETS_TRANSMIT`: Network packets out (packets/sec) `FS_IOPS_WRITE`: Disk writes (count/sec) `FS_IOPS_READ`: Disk reads (count/sec) `FS_SIZE_WRITE`: Disk write size (MiB/s) `FS_SIZE_READ`: Disk read size (MiB/s)
Threshold	Integer	No	The value of threshold (integer)
Enabled	Boolean	No	Whether it is enabled
DoubleThreshold	Float	No	The value of threshold (demical) Note: This field may return null, indicating that no valid values can be obtained.

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.
Domain	String	No	CLB domain name 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

LogConfig

Log collection configuration

Used by actions: DescribeLogConfig, DescribePagedLogConfigList, ModifyLogConfig.

Name	Type	Description
Name	String	Name.
InputType	String	Collection type. Values: `container_stdout` (standard); `container_file` (file)
LogsetId	String	Logset ID Note: This field may return `null`, indicating that no valid values can be obtained.
TopicId	String	Log topic ID Note: This field may return `null`, indicating that no valid values can be obtained.
LogType	String	Log withdrawal mode. Values: `minimalist_log` (full text in a single line); `multiline_log` (full text in multiple lines); `fullregex_log` (regex in a single line); `multiline_fullregex_log` (regex in multiple lines), `json_log` (JSON);
BeginningRegex	String	First line regex. It’s valid when `LogType` is `multiline_log` or `multiline_fullregex_log`. Note: This field may return `null`, indicating that no valid value was found.
LogPath	String	Directory of files to collect. It’s valid when `InputType` is `container_file`. Note: This field may return `null`, indicating that no valid values can be obtained.
FilePattern	String	Name pattern of files to collect. It’s valid when `InputType` is `container_file`. Note: This field may return `null`, indicating that no valid values can be obtained.
CreateDate	String	Creation time. Note: This field may return `null`, indicating that no valid values can be obtained.
ModifyDate	String	Update time Note: This field may return `null`, indicating that no valid values can be obtained.
ApplicationId	String	Application ID Note: This field may return `null`, indicating that no valid values can be obtained.
ApplicationName	String	Application name Note: This field may return `null`, indicating that no valid values can be obtained.
ExtractRule	LogConfigExtractRule	Export rules Note: This field may return `null`, indicating that no valid value was found.

LogConfigExtractRule

Configuration of log exporting rule

Used by actions: CreateLogConfig, DescribeLogConfig, DescribePagedLogConfigList, ModifyLogConfig.

Name	Type	Required	Description
BeginningRegex	String	No	First line regex Note: This field may return `null`, indicating that no valid value was found.
Keys	Array of String	No	Withdrawl result Note: This field may return `null`, indicating that no valid value was found.
FilterKeys	Array of String	No	Filter keys Note: This field may return `null`, indicating that no valid value was found.
FilterRegex	Array of String	No	Filter values Note: This field may return `null`, indicating that no valid value was found.
LogRegex	String	No	Log regex Note: This field may return `null`, indicating that no valid value was found.
TimeKey	String	No	Time field Note: This field may return `null`, indicating that no valid value was found.
TimeFormat	String	No	Time Format Note: This field may return `null`, indicating that no valid value was found.
UnMatchUpload	String	No	- Enable the upload of the log that failed to parse Note: This field may return `null`, indicating that no valid value was found.
UnMatchedKey	String	No	Key of log failed to be parsed Note: This field may return `null`, indicating that no valid value was found.
Backtracking	String	No	tracking Note: This field may return null, indicating that no valid values can be obtained.
Delimiter	String	No	Separator Note: This field may return null, indicating that no valid values can be obtained.

LogConfigListPage

List of LogConfig

Used by actions: DescribePagedLogConfigList.

Name	Type	Description
Records	Array of LogConfig	Record Note: This field may return `null`, indicating that no valid values can be obtained.
ContinueToken	String	Paging cursor Note: This field may return `null`, indicating that no valid values can be obtained.

LogOutputConf

Log output configuration

Used by actions: DeployApplication, DescribeApplicationInfo, DescribeApplicationsStatus.

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, DescribeApplicationInfo.

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

NamespaceInfo

Basic information of the namespace

Used by actions: DescribeEnvironment.

Name	Type	Description
EnvironmentId	String	ID
NamespaceName	String	(Disused) Name
Region	String	Region
VpcId	String	vpc id
SubnetIds	Array of String	Array of subnet IDs
Description	String	Description
CreatedDate	String	Creation time
EnvironmentName	String	Environment name Note: This field may return null, indicating that no valid values can be obtained.
ApmInstanceId	String	APM instance ID Note: This field may return null, indicating that no valid values can be obtained.
Locked	Integer	Whether the environment is locked. `1`: Locked, `0`: Not locked Note: This field may return null, indicating that no valid values can be obtained.
Tags	Array of Tag	Tag Note: This field may return `null`, indicating that no valid value was found.
EnvType	String	Environment type. Values: `test`, `pre`, `prod` Note: This field may return `null`, indicating that no valid value was found.

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
Current	Integer	Current entry Note: This field may return null, indicating that no valid values can be obtained.

NamespaceStatusInfo

Environment status

Used by actions: DescribeEnvironmentStatus.

Name	Type	Required	Description
EnvironmentId	String	Yes	ID of the environment
EnvironmentName	String	Yes	Environment name
ClusterId	String	No	TCB envId \| EKS clusterId
ClusterStatus	String	No	Environment status
EnvironmentStartingStatus	TemEnvironmentStartingStatus	No	Whether the environment is being started. `null` is returned if it’s not being started. Note: This field may return `null`, indicating that no valid values can be obtained.
EnvironmentStoppingStatus	TemEnvironmentStoppingStatus	No	Whether the environment is being stopped. `null` is returned if it’s not being stopped. Note: This field may return `null`, indicating that no valid values can be obtained.

NodeInfo

Node information

Used by actions: DescribeApplicationInfo, DescribeApplicationPods, DescribeApplicationsStatus.

Name	Type	Description
Name	String	Node name
Zone	String	Availability zone of the node Note: This field may return `null`, indicating that no valid values can be obtained.
SubnetId	String	Node subnet ID Note: This field may return `null`, indicating that no valid values can be obtained.
AvailableIpCount	String	Number of available IPs Note: This field may return `null`, indicating that no valid values can be obtained.
Cidr	String	CIDR block Note: This field may return `null`, indicating that no valid values can be obtained.

Pair

Key value pair

Used by actions: CreateConfigData, DeployApplication, DescribeApplicationInfo, DescribeConfigData, ModifyConfigData.

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, DescribeApplicationServiceList, ModifyApplicationService.

Name	Type	Required	Description
Port	Integer	Yes	Port.
TargetPort	Integer	Yes	Mapped port
Protocol	String	Yes	TCP/UDP protocol stack.
ServiceName	String	No	K8s service name

QueryFilter

Filters for query

Used by actions: DescribeApplications, DescribeEnvironments.

Name	Type	Required	Description
Name	String	No	Name of the field to query
Value	Array of String	No	Value of the field to query

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.
NodeInfo	NodeInfo	Information of the node whether the instance locates Note: This field may return `null`, indicating that no valid value was found.
StartTime	String	Start time Note: this field may return `null`, indicating that no valid value can be obtained.
Unhealthy	Boolean	Whether the status is unhealthy or healthy Note: this field may return `null`, indicating that no valid value can be obtained.
UnhealthyWarningMsg	String	Warning message when the result is unhealthy Note: This field may return `null`, indicating that no valid value was found.
VersionId	String	Version ID Note: This field may return `null`, indicating that no valid value was found.
ApplicationName	String	Application name Note: this field may return `null`, indicating that no valid values can be obtained.

ServicePage

List of returned applications

Used by actions: DescribeApplications.

Name	Type	Required	Description
Records	Array of TemService	Yes	List of applications
Total	Integer	Yes	Total number of applications
Size	Integer	Yes	Number of applications per page
Pages	Integer	Yes	Total number of pages
Current	Integer	No	Number of current entries Note: This field may return `null`, indicating that no valid value was found.

ServicePortMapping

Port mapping details

Used by actions: CreateApplicationService, DeployApplication, DescribeApplicationServiceList, ModifyApplicationService.

Name	Type	Required	Description
Type	String	No	Specifies how a layer-4 proxy is created. Note: This field may return `null`, indicating that no valid values can be obtained.
ServiceName	String	No	Application name Note: This field may return `null`, indicating that no valid values can be obtained.
ClusterIp	String	No	VIP for access within the environment Note: This field may return `null`, indicating that no valid values can be obtained.
ExternalIp	String	No	Cluster external IP Note: This field may return `null`, indicating that no valid values can be obtained.
SubnetId	String	No	Subnet ID Note: This field may return `null`, indicating that no valid values can be obtained.
VpcId	String	No	VPC ID Note: This field may return `null`, indicating that no valid values can be obtained.
LoadBalanceId	String	No	Load balancer ID Note: This field may return `null`, indicating that no valid values can be obtained.
Yaml	String	No	YAML contents Note: This field may return `null`, indicating that no valid values can be obtained.
Ports	Array of Integer	No	List of exposed ports Note: This field may return `null`, indicating that no valid values can be obtained.
PortMappingItemList	Array of ServicePortMappingItem	No	Port mapping array Note: This field may return `null`, indicating that no valid values can be obtained.
ExternalDomain	String	No	CLB domain name Note: This field may return `null`, indicating that no valid values can be obtained.

ServicePortMappingItem

Application port mapping

Used by actions: CreateApplicationService, DeployApplication, DescribeApplicationServiceList, ModifyApplicationService.

Name	Type	Required	Description
Port	Integer	No	Application access port Note: This field may return `null`, indicating that no valid values can be obtained.
TargetPort	Integer	No	Application listening port Note: This field may return `null`, indicating that no valid values can be obtained.
Protocol	String	No	Protocol type Note: This field may return `null`, indicating that no valid values can be obtained.

ServiceVersionBrief

List of application versions

Used by actions: DescribeApplications, DescribeApplicationsStatus, DescribeConfigData.

Name	Type	Description
VersionName	String	Version name
Status	String	Status of version
EnableEs	Integer	(Disused) Whether to enable elastic scaling
CurrentInstances	Integer	Number of current instances
VersionId	String	Version ID
LogOutputConf	LogOutputConf	(Disused) Log output configuration Note: This field may return null, indicating that no valid values can be obtained.
ExpectedInstances	Integer	Expected number of instances Note: This field may return null, indicating that no valid values can be obtained.
DeployMode	String	Deployment mode Note: This field may return null, indicating that no valid values can be obtained.
BuildTaskId	String	Task ID Note: This field may return null, indicating that no valid values can be obtained.
EnvironmentId	String	Environment ID Note: This field may return null, indicating that no valid values can be obtained.
EnvironmentName	String	Environment name Note: This field may return null, indicating that no valid values can be obtained.
ApplicationId	String	Application ID. Note: This field may return null, indicating that no valid values can be obtained.
ApplicationName	String	Application name Note: This field may return null, indicating that no valid values can be obtained.
UnderDeploying	Boolean	Whether the application is being deployed Note: This field may return null, indicating that no valid values can be obtained.
BatchDeployStatus	String	Status of batch deployment Note: This field may return `null`, indicating that no valid value was found.
Zones	Array of String	Availability zones Note: This field may return `null`, indicating that no valid value was found.
NodeInfos	Array of NodeInfo	Node information Note: This field may return `null`, indicating that no valid value was found.
PodList	DescribeRunPodPage	Pod information Note: This field may return `null`, indicating that no valid value was found.
WorkloadInfo	WorkloadInfo	Workload information Note: This field may return `null`, indicating that no valid value was found.
CreateDate	String	Creation time Note: This field may return `null`, indicating that no valid value was found.
RegionId	String	Region ID Note: This field may return null, indicating that no valid values can be obtained.

SortType

Query filter

Used by actions: DescribeApplications, DescribeEnvironments.

Name	Type	Required	Description
Key	String	No	Name of the sorting field
Type	Integer	No	`0`: Ascending; `1`: Descending

StorageConf

Storage volume configuration

Used by actions: DeployApplication, DescribeApplicationInfo.

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, DescribeApplicationInfo.

Name	Type	Required	Description
VolumeName	String	Yes	Data volume name
MountPath	String	Yes	Data volume binding path

Tag

Information of tags

Used by actions: CreateApplication, CreateEnvironment, DescribeApplicationInfo, DescribeApplications, DescribeConfigData, DescribeEnvironment, DescribeEnvironments.

Name	Type	Required	Description
TagKey	String	No	The tag key. Note: This field may return null, indicating that no valid values can be obtained.
TagValue	String	No	The tag value. Note: This field may return null, indicating that no valid values can be obtained.

TemEnvironmentStartingStatus

Environment startup processes (Only applications started by the environment startup)

Used by actions: DescribeEnvironmentStatus.

Name	Type	Required	Description
ApplicationNumNeedToStart	Integer	No	Number of applications to start Note: This field may return `null`, indicating that no valid values can be obtained.
StartedApplicationNum	Integer	No	Number of started applictions Note: This field may return `null`, indicating that no valid values can be obtained.
StartFailedApplicationNum	Integer	No	Number of applications failed to be started Note: This field may return `null`, indicating that no valid values can be obtained.

TemEnvironmentStoppingStatus

Processes stopped by the environment (Only applications stopped by the action of stopping the environment)

Used by actions: DescribeEnvironmentStatus.

Name	Type	Required	Description
ApplicationNumNeedToStop	Integer	No	Number of applications to stop Note: This field may return `null`, indicating that no valid values can be obtained.
StoppedApplicationNum	Integer	No	Number of stopped applications Note: This field may return `null`, indicating that no valid values can be obtained.
StopFailedApplicationNum	Integer	No	Number of applications failed to be stopped Note: This field may return `null`, indicating that no valid values can be obtained.

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
AppId	String	User AppId Note: This field may return null, indicating that no valid values can be obtained.
Uin	String	User UIN Note: This field may return null, indicating that no valid values can be obtained.
SubAccountUin	String	The UIN of sub-account Note: This field may return null, indicating that no valid values can be obtained.
ClusterId	String	Application ID Note: This field may return null, indicating that no valid values can be obtained.
Tags	Array of Tag	Tag. Note: this field may return `null`, indicating that no valid values can be obtained.
HasAuthority	Boolean	Whether it’s authorized to access the resource Note: This field may return null, indicating that no valid values can be obtained.
EnvType	String	Environment type. Values: `test`, `pre`, `prod` Note: This field may return `null`, indicating that no valid value was found.
RegionId	String	Region code Note: This field may return `null`, indicating that no valid value was found.

TemService

Application details

Used by actions: DescribeApplications, DescribeConfigData.

Name	Type	Description
ApplicationId	String	Version ID Note: This field may return `null`, indicating that no valid values can be obtained.
ApplicationName	String	Application name Note: This field may return `null`, indicating that no valid values can be obtained.
Description	String	Description Note: This field may return `null`, indicating that no valid values can be obtained.
EnvironmentId	String	ID of the environment Note: This field may return `null`, indicating that no valid values can be obtained.
CreateDate	Timestamp	Creation time. Note: This field may return `null`, indicating that no valid values can be obtained.
ModifyDate	Timestamp	Modification time Note: This field may return `null`, indicating that no valid values can be obtained.
Modifier	String	Modifier Note: This field may return `null`, indicating that no valid values can be obtained.
Creator	String	Creator account Note: This field may return `null`, indicating that no valid values can be obtained.
RepoType	Integer	TCR Individual or TCR Enterprise Note: This field may return `null`, indicating that no valid values can be obtained.
InstanceId	String	ID of the TCR Enterprise instance Note: This field may return `null`, indicating that no valid values can be obtained.
RepoName	String	Name of the TCR instance Note: This field may return `null`, indicating that no valid values can be obtained.
CodingLanguage	String	Programming Language Note: This field may return `null`, indicating that no valid values can be obtained.
DeployMode	String	Deployment mode Note: This field may return `null`, indicating that no valid values can be obtained.
EnvironmentName	String	Environment name Note: This field may return `null`, indicating that no valid values can be obtained.
ActiveVersions	Array of ServiceVersionBrief	The instance information where the application is running Note: This field may return `null`, indicating that no valid values can be obtained.
EnableTracing	Integer	Whether to enable link tracing Note: This field may return `null`, indicating that no valid values can be obtained.
Tags	Array of Tag	Tag Note: This field may return `null`, indicating that no valid value was found.
HasAuthority	Boolean	Whether it’s authorized to access the resource Note: This field may return null, indicating that no valid values can be obtained.

TemServiceVersionInfo

Version information

Used by actions: DescribeApplicationInfo.

Name	Type	Required	Description
VersionId	String	Yes	Version ID
ApplicationId	String	Yes	Application ID
DeployMode	String	Yes	Deployment mode
JdkVersion	String	Yes	JDK version
Description	String	Yes	Description
DeployVersion	String	Yes	Deployed version
PublishMode	String	Yes	Publish mode
JvmOpts	String	Yes	Launch parameter
InitPodNum	Integer	Yes	Number of initial pods
CpuSpec	Float	Yes	CPU specification
MemorySpec	Float	Yes	Memory specification
ImgRepo	String	Yes	Image path
ImgName	String	Yes	Image name
ImgVersion	String	Yes	Image version
EsInfo	EsInfo	Yes	Scaling configuration Note: This field may return null, indicating that no valid values can be obtained.
EnvConf	Array of Pair	Yes	Environment configuration
StorageConfs	Array of StorageConf	Yes	Storage configuration
Status	String	Yes	Running status
Vpc	String	Yes	VPC
SubnetId	String	Yes	Subnets
CreateDate	String	Yes	Creation time
ModifyDate	String	Yes	Modification time
StorageMountConfs	Array of StorageMountConf	Yes	Mounting configuration Note: This field may return `null`, indicating that no valid values can be obtained.
VersionName	String	Yes	Version name Note: This field may return `null`, indicating that no valid values can be obtained.
LogOutputConf	LogOutputConf	No	Log output configuration Note: This field may return `null`, indicating that no valid values can be obtained.
ApplicationName	String	No	Application name Note: This field may return `null`, indicating that no valid values can be obtained.
ApplicationDescription	String	No	Application description Note: This field may return `null`, indicating that no valid values can be obtained.
EnvironmentName	String	No	Environment name Note: This field may return `null`, indicating that no valid values can be obtained.
EnvironmentId	String	No	Environment ID Note: This field may return `null`, indicating that no valid values can be obtained.
PublicDomain	String	No	Public network address Note: This field may return `null`, indicating that no valid values can be obtained.
EnablePublicAccess	Boolean	No	Whether to enable public network access Note: This field may return `null`, indicating that no valid values can be obtained.
CurrentInstances	Integer	No	Number of current instances Note: This field may return `null`, indicating that no valid values can be obtained.
ExpectedInstances	Integer	No	Number of expected instances Note: This field may return `null`, indicating that no valid values can be obtained.
CodingLanguage	String	No	Programming Language Note: This field may return `null`, indicating that no valid values can be obtained.
PkgName	String	No	Program package name Note: This field may return `null`, indicating that no valid values can be obtained.
EsEnable	Integer	No	Whether to enable auto scaling Note: This field may return `null`, indicating that no valid values can be obtained.
EsStrategy	Integer	No	Auto scaling policy Note: This field may return `null`, indicating that no valid values can be obtained.
ImageTag	String	No	Image tag Note: This field may return `null`, indicating that no valid values can be obtained.
LogEnable	Integer	No	Whether to enable logging Note: This field may return `null`, indicating that no valid values can be obtained.
MinAliveInstances	String	No	Minimum number of instances Note: This field may return `null`, indicating that no valid values can be obtained.
SecurityGroupIds	Array of String	No	Security group IDs Note: This field may return `null`, indicating that no valid values can be obtained.
ImageCommand	String	No	Image command Note: This field may return `null`, indicating that no valid values can be obtained.
ImageArgs	Array of String	No	Image command parameters Note: This field may return `null`, indicating that no valid values can be obtained.
UseRegistryDefaultConfig	Boolean	No	Whether to use the default registry configurations Note: This field may return `null`, indicating that no valid values can be obtained.
Service	EksService	No	EKS access configuration Note: This field may return `null`, indicating that no valid values can be obtained.
SettingConfs	Array of MountedSettingConf	No	Mounting configurations Note: This field may return `null`, indicating that no valid values can be obtained.
LogConfs	Array of String	No	Log path information Note: This field may return `null`, indicating that no valid values can be obtained.
PostStart	String	No	The script to execute right after the startup Note: This field may return `null`, indicating that no valid values can be obtained.
PreStop	String	No	The script to run before stop Note: This field may return `null`, indicating that no valid values can be obtained.
Liveness	HealthCheckConfig	No	Configuration of aliveness probe Note: This field may return `null`, indicating that no valid values can be obtained.
Readiness	HealthCheckConfig	No	Configuration of readiness probe Note: This field may return `null`, indicating that no valid values can be obtained.
HorizontalAutoscaler	Array of HorizontalAutoscaler	No	Auto scaling policy Note: This field may return `null`, indicating that no valid values can be obtained.
CronHorizontalAutoscaler	Array of CronHorizontalAutoscaler	No	Scheduled auto scaling policy Note: This field may return `null`, indicating that no valid values can be obtained.
Zones	Array of String	No	Availability zone of the application Note: This field may return `null`, indicating that no valid values can be obtained.
LastDeployDate	String	No	The latest deployment time Note: This field may return `null`, indicating that no valid values can be obtained.
LastDeploySuccessDate	String	No	The latest successful deployment time Note: This field may return `null`, indicating that no valid values can be obtained.
NodeInfos	Array of NodeInfo	No	Information of the node whether the application is deployed Note: This field may return `null`, indicating that no valid values can be obtained.
ImageType	Integer	No	Image type. Values: `0` (Demo image), `1` (Normal image) Note: This field may return `null`, indicating that no valid values can be obtained.
EnableTracing	Integer	No	Whether to Note: This field may return `null`, indicating that no valid values can be obtained.
EnableTracingReport	Integer	No	(Disused) Whether to enable linkage tracing and report. It only takes effect when EnableTracing = `1`. Note: This field may return null, indicating that no valid values can be obtained.
RepoType	Integer	No	Image type. `0`: Individual image; `1`: Enterprise image; `2`: Public image Note: This field may return `null`, indicating that no valid values can be obtained.
BatchDeployStatus	String	No	Status of batch deployment: `batch_updating`, `batch_updating_waiting_confirm` Note: This field may return `null`, indicating that no valid values can be obtained.
ApmInstanceId	String	No	APM instance ID Note: This field may return `null`, indicating that no valid values can be obtained.
WorkloadInfo	WorkloadInfo	No	Workload information Note: This field may return `null`, indicating that no valid values can be obtained.
SpeedUp	Boolean	No	Whether to enable application acceleration Note: This field may return `null`, indicating that no valid values can be obtained.
StartupProbe	HealthCheckConfig	No	Configuration of the startup probe Note: This field may return `null`, indicating that no valid values can be obtained.
OsFlavour	String	No	OS version. Values: - ALPINE - CENTOS Note: This field may return `null`, indicating that no valid values can be obtained.
RepoServer	String	No	Image repository server Note: This field may return `null`, indicating that no valid values can be obtained.
UnderDeploying	Boolean	No	Whether the application is being deployed Note: This field may return `null`, indicating that no valid values can be obtained.
EnablePrometheusConf	EnablePrometheusConf	No	Whether to enable application metric monitoring Note: This field may return null, indicating that no valid values can be obtained.
StoppedManually	Boolean	No	Whether it’s stopped manually Note: This field may return `null`, indicating that no valid values can be obtained.
TcrInstanceId	String	No	TCR instance ID Note: This field may return `null`, indicating that no valid values can be obtained.
EnableMetrics	Integer	No	`1`: Automatically enable metrics collection (open-telemetry) `0`: Disable metrics collection Note: This field may return null, indicating that no valid values can be obtained.
AppId	String	No	User AppId Note: This field may return `null`, indicating that no valid value was found.
SubAccountUin	String	No	Sub Account UIN Note: This field may return `null`, indicating that no valid value was found.
Uin	String	No	User UIN Note: This field may return `null`, indicating that no valid value was found.
Region	String	No	Region Note: This field may return `null`, indicating that no valid value was found.
GroupId	String	No	Application group ID Note: This field may return `null`, indicating that no valid value was found.
EnableRegistry	Integer	No	Whether to enable registry Note: This field may return `null`, indicating that no valid value was found.
AutoscalerList	Array of Autoscaler	No	Array of scaling rules Note: This field may return `null`, indicating that no valid value was found.
Modifier	String	No	Modifier Note: This field may return `null`, indicating that no valid value was found.
Creator	String	No	Creator Note: This field may return `null`, indicating that no valid value was found.
DeployStrategyConf	DeployStrategyConf	No	Deployment strategy Note: This field may return `null`, indicating that no valid value was found.
PodList	DescribeRunPodPage	No	List of pods Note: This field may return `null`, indicating that no valid value was found.
ConfEdited	Boolean	No	Whether the configuration has been changed during deployment Note: This field may return `null`, indicating that no valid value was found.
Tags	Array of Tag	No	Tag Note: This field may return `null`, indicating that no valid value was found.
PreStopEncoded	String	No	Whether to encode Note: This field may return null, indicating that no valid values can be obtained.
PostStartEncoded	String	No	Whether to encode Note: This field may return null, indicating that no valid values can be obtained.

UseDefaultRepoParameters

Repository parameters

Used by actions: CreateApplication.

Name	Type	Description
EnterpriseInstanceName	String	TCR Enterprise instance name Note: This field may return null, indicating that no valid values can be obtained.
EnterpriseInstanceChargeType	Integer	TCR Enterprise billing mode. `0`: Pay-as-you-go Note: This field may return null, indicating that no valid values can be obtained.
EnterpriseInstanceType	String	Edition of the TCR Enterprise. Values: `basic`, `standard`, `premium` (Advanced edition) Note: This field may return null, indicating that no valid values can be obtained.

WorkloadInfo

Workload details

Used by actions: DescribeApplicationInfo, DescribeApplicationsStatus.

Name	Type	Description
ClusterId	String	The resource ID. Note: This field may return `null`, indicating that no valid values can be obtained.
ApplicationName	String	Application name Note: This field may return `null`, indicating that no valid values can be obtained.
VersionName	String	Version name Note: This field may return `null`, indicating that no valid value was found.
ReadyReplicas	Integer	Number of ready replicas Note: This field may return `null`, indicating that no valid values can be obtained.
Replicas	Integer	Number of replicas Note: This field may return `null`, indicating that no valid value was found.
UpdatedReplicas	Integer	Number of updated replicas Note: This field may return `null`, indicating that no valid value was found.
UpdatedReadyReplicas	Integer	Number of replicas ready for update Note: This field may return `null`, indicating that no valid value was found.
UpdateRevision	String	## Version Updates Note: This field may return `null`, indicating that no valid value was found.
CurrentRevision	String	Current Version Note: This field may return `null`, indicating that no valid value was found.

联系我们

联系我们，为您的业务提供专属服务。

技术支持

如果你想寻求进一步的帮助，通过工单与我们进行联络。我们提供7x24的工单服务。

7x24 电话支持

tencent cloud

注册

登录

Recent Pages

Data Types

Autoscaler

ConfigData

CosToken

CronHorizontalAutoscaler

CronHorizontalAutoscalerSchedule

DeployStrategyConf

DescribeConfigDataListPage

DescribeRunPodPage

EksService

EnablePrometheusConf

EsInfo

HealthCheckConfig

HorizontalAutoscaler

IngressInfo

IngressRule

IngressRuleBackend

IngressRulePath

IngressRuleValue

IngressTls

LogConfig

LogConfigExtractRule

LogConfigListPage

LogOutputConf

MountedSettingConf

NamespaceInfo

NamespacePage

NamespaceStatusInfo

NodeInfo

Pair

PortMapping

QueryFilter

RunVersionPod

ServicePage

ServicePortMapping

ServicePortMappingItem

ServiceVersionBrief

SortType

StorageConf

StorageMountConf

Tag

TemEnvironmentStartingStatus

TemEnvironmentStoppingStatus

TemNamespaceInfo

TemService

TemServiceVersionInfo

UseDefaultRepoParameters

WorkloadInfo

本页内容是否解决了您的问题？

本页内容是否解决了您的问题？