public static final class DeployApplicationRequest.Builder extends Object
限定符和类型 | 方法和说明 |
---|---|
DeployApplicationRequest.Builder |
acrAssumeRoleArn(String acrAssumeRoleArn)
The Alibaba Cloud Resource Name (ARN) required for a RAM role to obtain images across accounts.
|
DeployApplicationRequest.Builder |
acrInstanceId(String acrInstanceId)
The ID of Container Registry Enterprise Edition instance N.
|
DeployApplicationRequest.Builder |
appId(String appId)
The ID of the application.
|
DeployApplicationRequest.Builder |
associateEip(Boolean associateEip)
Specifies whether to associate an EIP with the node pool.
|
DeployApplicationRequest.Builder |
autoEnableApplicationScalingRule(Boolean autoEnableApplicationScalingRule)
Specifies whether to automatically enable an auto scaling policy for the application.
|
DeployApplicationRequest.Builder |
batchWaitTime(Integer batchWaitTime)
The interval between batches during a batch release.
|
DeployApplicationRequest |
build() |
DeployApplicationRequest.Builder |
changeOrderDesc(String changeOrderDesc)
The description of the change order.
|
DeployApplicationRequest.Builder |
command(String command)
The command that is used to start the image.
|
DeployApplicationRequest.Builder |
commandArgs(String commandArgs)
The parameters of the image startup command.
|
DeployApplicationRequest.Builder |
configMapMountDesc(String configMapMountDesc)
The description of the **ConfigMap** instance mounted to the application.
|
DeployApplicationRequest.Builder |
cpu(Integer cpu)
Cpu.
|
DeployApplicationRequest.Builder |
customHostAlias(String customHostAlias)
The custom mappings between hostnames and IP addresses in the container.
|
DeployApplicationRequest.Builder |
deploy(String deploy)
This parameter takes effect only for applications that are in the Stopped state.
|
DeployApplicationRequest.Builder |
edasContainerVersion(String edasContainerVersion)
The version of the container, such as Ali-Tomcat, in which an application developed based on High-speed Service Framework (HSF) is deployed.
|
DeployApplicationRequest.Builder |
enableAhas(String enableAhas)
Indicates whether access to Application High Availability Service (AHAS) is enabled.
|
DeployApplicationRequest.Builder |
enableGreyTagRoute(Boolean enableGreyTagRoute)
Indicates whether canary release rules are enabled.
|
DeployApplicationRequest.Builder |
enableNewArms(Boolean enableNewArms)
EnableNewArms.
|
DeployApplicationRequest.Builder |
envs(String envs)
The environment variables.
|
DeployApplicationRequest.Builder |
imagePullSecrets(String imagePullSecrets)
The ID of the corresponding Secret.
|
DeployApplicationRequest.Builder |
imageUrl(String imageUrl)
The URL of the image.
|
DeployApplicationRequest.Builder |
jarStartArgs(String jarStartArgs)
The arguments in the JAR package.
|
DeployApplicationRequest.Builder |
jarStartOptions(String jarStartOptions)
The option settings in the JAR package.
|
DeployApplicationRequest.Builder |
jdk(String jdk)
The version of the Java development kit (JDK) on which the deployment package of the application depends.
|
DeployApplicationRequest.Builder |
kafkaConfigs(String kafkaConfigs)
The logging configurations of Message Queue for Apache Kafka.
|
DeployApplicationRequest.Builder |
liveness(String liveness)
The details of the availability check that was performed on the container.
|
DeployApplicationRequest.Builder |
memory(Integer memory)
Memory.
|
DeployApplicationRequest.Builder |
microRegistration(String microRegistration)
The Nacos registry.
|
DeployApplicationRequest.Builder |
microRegistrationConfig(String microRegistrationConfig)
MicroRegistrationConfig.
|
DeployApplicationRequest.Builder |
minReadyInstanceRatio(Integer minReadyInstanceRatio)
The percentage of the minimum number of available instances.
|
DeployApplicationRequest.Builder |
minReadyInstances(Integer minReadyInstances)
The minimum number of available instances.
|
DeployApplicationRequest.Builder |
mountDesc(String mountDesc)
The configurations for mounting the NAS file system.
|
DeployApplicationRequest.Builder |
mountHost(String mountHost)
The mount target of the NAS file system in the VPC where the application is deployed.
|
DeployApplicationRequest.Builder |
nasConfigs(String nasConfigs)
The configurations of mounting the NAS file system.
|
DeployApplicationRequest.Builder |
nasId(String nasId)
The ID of the Apsara File Storage NAS file system.
|
DeployApplicationRequest.Builder |
ossAkId(String ossAkId)
The AccessKey ID that is used to read data from and write data to Object Storage Service (OSS) buckets.
|
DeployApplicationRequest.Builder |
ossAkSecret(String ossAkSecret)
The AccessKey secret that is used to read data from and write data to OSS buckets.
|
DeployApplicationRequest.Builder |
ossMountDescs(String ossMountDescs)
Information of the Object Storage Service (OSS) bucket mounted to the application.
|
DeployApplicationRequest.Builder |
packageType(String packageType)
PackageType.
|
DeployApplicationRequest.Builder |
packageUrl(String packageUrl)
The address of the deployment package.
|
DeployApplicationRequest.Builder |
packageVersion(String packageVersion)
The version of the deployment package.
|
DeployApplicationRequest.Builder |
php(String php)
Php.
|
DeployApplicationRequest.Builder |
phpArmsConfigLocation(String phpArmsConfigLocation)
The path on which the PHP configuration file for application monitoring is mounted.
|
DeployApplicationRequest.Builder |
phpConfig(String phpConfig)
The details of the PHP configuration file.
|
DeployApplicationRequest.Builder |
phpConfigLocation(String phpConfigLocation)
The path on which the PHP configuration file for application startup is mounted.
|
DeployApplicationRequest.Builder |
postStart(String postStart)
The script that is run immediately after the container is started.
|
DeployApplicationRequest.Builder |
preStop(String preStop)
The script that is run before the container is stopped.
|
DeployApplicationRequest.Builder |
pvtzDiscoverySvc(String pvtzDiscoverySvc)
The configurations of Kubernetes Service-based service registration and discovery.
|
DeployApplicationRequest.Builder |
python(String python)
The Python environment.
|
DeployApplicationRequest.Builder |
pythonModules(String pythonModules)
The configurations for installing custom module dependencies.
|
DeployApplicationRequest.Builder |
readiness(String readiness)
The details of the health check that was performed on the container.
|
DeployApplicationRequest.Builder |
replicas(Integer replicas)
Replicas.
|
DeployApplicationRequest.Builder |
securityGroupId(String securityGroupId)
SecurityGroupId.
|
DeployApplicationRequest.Builder |
serviceTags(String serviceTags)
ServiceTags.
|
DeployApplicationRequest.Builder |
slsConfigs(String slsConfigs)
The logging configurations of Log Service.
|
DeployApplicationRequest.Builder |
terminationGracePeriodSeconds(Integer terminationGracePeriodSeconds)
The timeout period for a graceful shutdown.
|
DeployApplicationRequest.Builder |
timezone(String timezone)
The time zone.
|
DeployApplicationRequest.Builder |
tomcatConfig(String tomcatConfig)
The Tomcat configuration.
|
DeployApplicationRequest.Builder |
updateStrategy(String updateStrategy)
The deployment policy.
|
DeployApplicationRequest.Builder |
vSwitchId(String vSwitchId)
VSwitchId.
|
DeployApplicationRequest.Builder |
warStartOptions(String warStartOptions)
The startup command of the WAR package.
|
DeployApplicationRequest.Builder |
webContainer(String webContainer)
The version of the Tomcat container on which the deployment package depends.
|
public DeployApplicationRequest.Builder acrAssumeRoleArn(String acrAssumeRoleArn)
public DeployApplicationRequest.Builder acrInstanceId(String acrInstanceId)
public DeployApplicationRequest.Builder appId(String appId)
public DeployApplicationRequest.Builder associateEip(Boolean associateEip)
* **true**: The EIP is associated with the application instance. * **false**: The EIP is not associated with the application instance.
public DeployApplicationRequest.Builder autoEnableApplicationScalingRule(Boolean autoEnableApplicationScalingRule)
* **true**: turns on Logon-free Sharing * **false**: turns off Logon-free Sharing
public DeployApplicationRequest.Builder batchWaitTime(Integer batchWaitTime)
public DeployApplicationRequest.Builder changeOrderDesc(String changeOrderDesc)
public DeployApplicationRequest.Builder command(String command)
command: - echo - abc - > - file0 In this example, the Command parameter is set to `Command="echo", CommandArgs=["abc", ">", "file0"]`.
public DeployApplicationRequest.Builder commandArgs(String commandArgs)
`["a","b"]` In the preceding example, the CommandArgs parameter is set to `CommandArgs=["abc", ">", "file0"]`. The data type of `["abc", ">", "file0"]` must be an array of strings in the JSON format. This parameter is optional.
public DeployApplicationRequest.Builder configMapMountDesc(String configMapMountDesc)
* **congfigMapId**: the ID of the ConfigMap instance. You can call the [ListNamespacedConfigMaps](~~176917~~) operation to obtain the ID. * **key**: the key. > You can use `sae-sys-configmap-all` to mount all keys. * **mountPath**: the mount path in the container.
public DeployApplicationRequest.Builder cpu(Integer cpu)
public DeployApplicationRequest.Builder customHostAlias(String customHostAlias)
* **hostName**: the domain name or hostname. * **ip**: the IP address.
public DeployApplicationRequest.Builder deploy(String deploy)
* **true** (default): specifies that the system immediately deploys the application, enables new configurations, and pulls application instances. * **false**: specifies that the system only enables the new configurations.
public DeployApplicationRequest.Builder edasContainerVersion(String edasContainerVersion)
public DeployApplicationRequest.Builder enableAhas(String enableAhas)
* **true**: Access to AHAS is enabled. * **false**: Access to AHAS is disabled.
public DeployApplicationRequest.Builder enableGreyTagRoute(Boolean enableGreyTagRoute)
* **true**: The canary release rules are enabled. * **false**: The canary release rules are disabled.
public DeployApplicationRequest.Builder enableNewArms(Boolean enableNewArms)
public DeployApplicationRequest.Builder envs(String envs)
* Customize
* **name**: the name of the environment variable.
* **value**: the value of the environment variable.
* Reference ConfigMap
* **name**: the name of the environment variable. You can reference one or all keys. If you want to reference all keys, specify `sae-sys-configmap-all-
public DeployApplicationRequest.Builder imagePullSecrets(String imagePullSecrets)
public DeployApplicationRequest.Builder imageUrl(String imageUrl)
public DeployApplicationRequest.Builder jarStartArgs(String jarStartArgs)
public DeployApplicationRequest.Builder jarStartOptions(String jarStartOptions)
public DeployApplicationRequest.Builder jdk(String jdk)
* **Open JDK 8** * **Open JDK 7** * **Dragonwell 11** * **Dragonwell 8** * **openjdk-8u191-jdk-alpine3.9** * **openjdk-7u201-jdk-alpine3.9** This parameter is not returned if the **PackageType** parameter is set to **Image**.
public DeployApplicationRequest.Builder kafkaConfigs(String kafkaConfigs)
* **kafkaEndpoint**: the endpoint of the Message Queue for Apache Kafka API. * **kafkaInstanceId**: the ID of the Message Queue for Apache Kafka instance. * **kafkaConfigs**: One or more logging configurations of Message Queue for Apache Kafka. For information about sample values and parameters, see the request parameter **KafkaLogfileConfig** in this topic.
public DeployApplicationRequest.Builder liveness(String liveness)
* Example of **exec**: `{"exec":{"command":\["sh","-c","cat/home/admin/start.sh"]},"initialDelaySeconds":30,"periodSeconds":30,"timeoutSeconds":2}` * Sample code of the **httpGet** method: `{"httpGet":{"path":"/","port":18091,"scheme":"HTTP","isContainKeyWord":true,"keyWord":"SAE"},"initialDelaySeconds":11,"periodSeconds":10,"timeoutSeconds":1}` * Sample code of the **tcpSocket** method: `{"tcpSocket":{"port":18091},"initialDelaySeconds":11,"periodSeconds":10,"timeoutSeconds":1}` > You can use only one method to perform the health check. The following table describes the parameters that are used in the preceding statements. * **exec.command**: the health check command. * **httpGet.path**: the request path. * **httpGet.scheme**: the protocol that is used to perform the health check. Valid values: **HTTP** and **HTTPS**. * **httpGet.isContainKeyWord**: indicates whether the response contains keywords. Valid values: **true** and **false**. If this field is not returned, the advanced settings are not used. * **httpGet.keyWord**: the custom keyword. This parameter is available only if the **isContainKeyWord** field is returned. * **tcpSocket.port**: the port that is used to check the status of TCP connections. * **initialDelaySeconds**: the delay of the health check. Default value: 10. Unit: seconds. * **periodSeconds**: the interval at which health checks are performed. Default value: 30. Unit: seconds. * **timeoutSeconds**: the timeout period of the health check. Default value: 1. Unit: seconds. If you set this parameter to 0 or leave this parameter empty, the timeout period is automatically set to 1 second.
public DeployApplicationRequest.Builder memory(Integer memory)
public DeployApplicationRequest.Builder microRegistration(String microRegistration)
* **0**: SAE built-in Nacos registry * **1**: self-managed Nacos registry * **2** : MSE Nacos registry
public DeployApplicationRequest.Builder microRegistrationConfig(String microRegistrationConfig)
public DeployApplicationRequest.Builder minReadyInstanceRatio(Integer minReadyInstanceRatio)
* If you set the value to **-1**, the minimum number of available instances is not determined based on this parameter. Default value: -1. * If you set the value to a number **from 0 to 100**, the minimum number of available instances is calculated by using the following formula: Current number of instances × (Value of MinReadyInstanceRatio × 100%). The value is the nearest integer rounded up from the calculated result. For example, if the percentage is set to **50**% and five instances are available, the minimum number of available instances is 3. > When both **MinReadyInstance** and **MinReadyInstanceRatio** are specified and **MinReadyInstanceRatio** is set to a number from 0 to 100, the value of **MinReadyInstanceRatio**** takes precedence. For example, if **MinReadyInstances** is set to **5, and **MinReadyInstanceRatio** is set to **50**, the minimum number of available instances is set to the nearest integer rounded up from the calculated result of the following formula: Current number of instances × **50%**.
public DeployApplicationRequest.Builder minReadyInstances(Integer minReadyInstances)
* If you set the value to **0**, business interruptions occur when the application is updated. * If you set the value to \*\*-1\*\*, the minimum number of available instances is automatically set to a system-recommended value. The value is the nearest integer to which the calculated result of the following formula is rounded up: Current number of instances × 25%. For example, if five instances are available, the minimum number of available instances is calculated by using the following formula: 5 × 25% = 1.25. In this case, the minimum number of available instances is 2. > Make sure that at least one instance is available during application deployment and rollback to prevent business interruptions.
public DeployApplicationRequest.Builder mountDesc(String mountDesc)
public DeployApplicationRequest.Builder mountHost(String mountHost)
public DeployApplicationRequest.Builder nasConfigs(String nasConfigs)
* **mountPath**: the mount path of the container. * **readOnly**: If you set the value to **false**, the application has the read and write permissions. * **nasId**: the ID of the NAS file system. * **mountDomain**: the domain name of the mount target. For more information, see [DescribeMountTargets](~~62626~~). * **nasPath**: the directory in the NAS file system.
public DeployApplicationRequest.Builder nasId(String nasId)
public DeployApplicationRequest.Builder ossAkId(String ossAkId)
public DeployApplicationRequest.Builder ossAkSecret(String ossAkSecret)
public DeployApplicationRequest.Builder ossMountDescs(String ossMountDescs)
* **bucketName**: the name of the OSS bucket. * **bucketPath**: the directory or object in OSS. If the specified directory or object does not exist, an error is returned. * **mountPath**: the directory of the container in SAE. If the path already exists, the newly specified path overwrites the previous one. If the path does not exist, it is created. * **readOnly**: specifies whether to only allow the container path to read data from the OSS directory. Valid values: * **true**: The container path only has read permission on the OSS directory. * **false**: The application has read and write permissions.
public DeployApplicationRequest.Builder packageType(String packageType)
public DeployApplicationRequest.Builder packageUrl(String packageUrl)
public DeployApplicationRequest.Builder packageVersion(String packageVersion)
public DeployApplicationRequest.Builder php(String php)
public DeployApplicationRequest.Builder phpArmsConfigLocation(String phpArmsConfigLocation)
public DeployApplicationRequest.Builder phpConfig(String phpConfig)
public DeployApplicationRequest.Builder phpConfigLocation(String phpConfigLocation)
public DeployApplicationRequest.Builder postStart(String postStart)
public DeployApplicationRequest.Builder preStop(String preStop)
public DeployApplicationRequest.Builder pvtzDiscoverySvc(String pvtzDiscoverySvc)
* **serviceName**: the name of the Alibaba Cloud service. Format: `
public DeployApplicationRequest.Builder python(String python)
public DeployApplicationRequest.Builder pythonModules(String pythonModules)
public DeployApplicationRequest.Builder readiness(String readiness)
> You can use only one method to perform the health check.
public DeployApplicationRequest.Builder replicas(Integer replicas)
public DeployApplicationRequest.Builder securityGroupId(String securityGroupId)
public DeployApplicationRequest.Builder serviceTags(String serviceTags)
public DeployApplicationRequest.Builder slsConfigs(String slsConfigs)
* To use Log Service resources that are automatically created by SAE, set this parameter to `[{"logDir":"","logType":"stdout"},{"logDir":"/tmp/a.log"}]`. * To use custom Log Service resources, set this parameter to `[{"projectName":"test-sls","logType":"stdout","logDir":"","logstoreName":"sae","logtailName":""},{"projectName":"test","logDir":"/tmp/a.log","logstoreName":"sae","logtailName":""}]`. The following table describes the parameters that are used in the preceding statements. * **projectName**: the name of the Log Service project. * **logDir**: the path in which logs are stored. * **logType**: the log type. **stdout**: the standard output log of the container. You can specify only one stdout value for this parameter. If you leave this parameter empty, file logs are collected. * **logstoreName**: the name of the Logstore in Log Service. * **logtailName**: the name of the Logtail configuration in Log Service. If you do not configure this parameter, a new Logtail configuration is created. If you do not need to modify the logging configurations when you deploy the application, configure the **SlsConfigs** parameter only in the first request. You do not need to include this parameter in subsequent requests. If you no longer need to use Log Service, leave the **SlsConfigs** parameter empty in the request. > A Log Service project that is automatically created by SAE when you create an application is deleted when the application is deleted. Therefore, when you create an application, you cannot select a Log Service project that is automatically created by SAE for log collection.
public DeployApplicationRequest.Builder terminationGracePeriodSeconds(Integer terminationGracePeriodSeconds)
public DeployApplicationRequest.Builder timezone(String timezone)
public DeployApplicationRequest.Builder tomcatConfig(String tomcatConfig)
* **port**: the port number. The port number ranges from 1024 to 65535. Though the admin permissions are configured for the container, the root permissions are required to perform operations on ports whose number is smaller than 1024. Enter a value that ranges from 1025 to 65535 because the container has only the admin permissions. If you do not specify this parameter, the default port number 8080 is used. * **contextPath**: the path. Default value: /. This value indicates the root directory. * **maxThreads**: the maximum number of connections in the connection pool. Default value: 400. * **uriEncoding**: the URI encoding scheme in the Tomcat container. Valid values: UTF-8, ISO-8859-1, GBK, and GB2312.************ If you do not specify this parameter, the default value **ISO-8859-1** is used. * **useBodyEncoding**: specifies whether to use the encoding scheme specified in the request body for URI query parameters. Default value: true.
public DeployApplicationRequest.Builder updateStrategy(String updateStrategy)
* The application is deployed on an instance. The remaining instances are automatically classified into two release batches whose interval is set to 1. In this case, the parameter is set to `{"type":"GrayBatchUpdate","batchUpdate":{"batch":2,"releaseType":"auto","batchWaitTime":1},"grayUpdate":{"gray":1}}`. * The application is deployed on an instance. The remaining instances are manually classified into two release batches. In this case, the parameter is set to `{"type":"GrayBatchUpdate","batchUpdate":{"batch":2,"releaseType":"manual"},"grayUpdate":{"gray":1}}`. * All instances are automatically classified into two release batches. The application is deployed on the instances of the two batches in parallel. In this case, the parameter is set to `{"type":"BatchUpdate","batchUpdate":{"batch":2,"releaseType":"auto","batchWaitTime":0}}` The following table describes the parameters that are used in the preceding statements. * **type**: the type of the release policy. Valid values: **GrayBatchUpdate** and **BatchUpdate**. * **batchUpdate**: the phased release policy. * **batch**: the number of release batches. * **releaseType**: the processing method for the batches. Valid values: **auto** and **manual**. * **batchWaitTime**: the interval between release batches. Unit: seconds. * **grayUpdate**: the number of release batches in the phased release after a canary release. This parameter is returned only if the **type** parameter is set to **GrayBatchUpdate**.
public DeployApplicationRequest.Builder vSwitchId(String vSwitchId)
public DeployApplicationRequest.Builder warStartOptions(String warStartOptions)
public DeployApplicationRequest.Builder webContainer(String webContainer)
* **apache-tomcat-7.0.91** * **apache-tomcat-8.5.42** This parameter is not returned if the **PackageType** parameter is set to **Image**.
public DeployApplicationRequest build()
Copyright © 2024. All rights reserved.