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 |
agentVersion(String agentVersion)
AgentVersion.
|
DeployApplicationRequest.Builder |
albIngressReadinessGate(String albIngressReadinessGate)
AlbIngressReadinessGate.
|
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)
The CPU specifications that are required for each instance.
|
DeployApplicationRequest.Builder |
customHostAlias(String customHostAlias)
The custom mappings between hostnames and IP addresses in the container.
|
DeployApplicationRequest.Builder |
customImageNetworkType(String customImageNetworkType)
Custom image type.
|
DeployApplicationRequest.Builder |
deploy(String deploy)
This parameter takes effect only for applications that are in the Stopped state.
|
DeployApplicationRequest.Builder |
dotnet(String dotnet)
The version of .NET
.NET 3.1
.NET 5.0
.NET 6.0
.NET 7.0
.NET 8.0
example:
.NET 3.1
|
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 |
emptyDirDesc(String emptyDirDesc)
EmptyDirDesc.
|
DeployApplicationRequest.Builder |
enableAhas(String enableAhas)
Indicates whether access to Application High Availability Service (AHAS) is enabled.
|
DeployApplicationRequest.Builder |
enableCpuBurst(Boolean enableCpuBurst)
Enable CPU Burst.
|
DeployApplicationRequest.Builder |
enableGreyTagRoute(Boolean enableGreyTagRoute)
Indicates whether canary release rules are enabled.
|
DeployApplicationRequest.Builder |
enableNamespaceAgentVersion(Boolean enableNamespaceAgentVersion)
EnableNamespaceAgentVersion.
|
DeployApplicationRequest.Builder |
enableNewArms(Boolean enableNewArms)
Enable new ARMS features.
|
DeployApplicationRequest.Builder |
enablePrometheus(Boolean enablePrometheus)
EnablePrometheus.
|
DeployApplicationRequest.Builder |
enableSidecarResourceIsolated(Boolean enableSidecarResourceIsolated)
Enable Sidecar resource isolation.
|
DeployApplicationRequest.Builder |
envs(String envs)
The environment variables.
|
DeployApplicationRequest.Builder |
gpuConfig(String gpuConfig)
GpuConfig.
|
DeployApplicationRequest.Builder |
html(String html)
Html.
|
DeployApplicationRequest.Builder |
imagePullSecrets(String imagePullSecrets)
The ID of the corresponding Secret.
|
DeployApplicationRequest.Builder |
imageUrl(String imageUrl)
The URL of the image.
|
DeployApplicationRequest.Builder |
initContainersConfig(List<InitContainerConfig> initContainersConfig)
Initialize container configuration.
|
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 |
labels(Map<String,String> labels)
Labels.
|
DeployApplicationRequest.Builder |
liveness(String liveness)
The details of the availability check that was performed on the container.
|
DeployApplicationRequest.Builder |
lokiConfigs(String lokiConfigs)
LokiConfigs.
|
DeployApplicationRequest.Builder |
maxSurgeInstanceRatio(Integer maxSurgeInstanceRatio)
MaxSurgeInstanceRatio.
|
DeployApplicationRequest.Builder |
maxSurgeInstances(Integer maxSurgeInstances)
MaxSurgeInstances.
|
DeployApplicationRequest.Builder |
memory(Integer memory)
The memory size that is required by each instance.
|
DeployApplicationRequest.Builder |
microRegistration(String microRegistration)
The Nacos registry.
|
DeployApplicationRequest.Builder |
microRegistrationConfig(String microRegistrationConfig)
Select the edition of Nacos.
|
DeployApplicationRequest.Builder |
microserviceEngineConfig(String microserviceEngineConfig)
Configure Microservices Governance
Whether to enable microservices governance (enable):
true: Enable
false: Disable
Configure lossless online/offline deployment (mseLosslessRule):
delayTime: Delay duration (unit: seconds)
enable: Whether to enable lossless deployment
true: Enable
false: Disable
notice: Whether to enable notifications
true: Enable
false: Disable
warmupTime: Small-traffic warm-up duration (unit: seconds)
example:
{"enable": true,"mseLosslessRule": {"delayTime": 0,"enable": false,"notice": false,"warmupTime": 120}}
|
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 File Storage NAS file system.
|
DeployApplicationRequest.Builder |
newSaeVersion(String newSaeVersion)
SAE edition.
|
DeployApplicationRequest.Builder |
oidcRoleName(String oidcRoleName)
The name of the RAM role used to authenticate the user identity.
|
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)
The package type.
|
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)
The dependent PHP version of PHP package.
|
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)
The number of instances.
|
DeployApplicationRequest.Builder |
secretMountDesc(String secretMountDesc)
Secret Mount Description
Use the secret dictionaries created in the Namespace Secret Dictionary page to inject information into containers.
|
DeployApplicationRequest.Builder |
securityGroupId(String securityGroupId)
Security group ID.
|
DeployApplicationRequest.Builder |
serviceTags(String serviceTags)
The gray-release tag of the application.
|
DeployApplicationRequest.Builder |
sidecarContainersConfig(List<SidecarContainerConfig> sidecarContainersConfig)
The configuration of the container.
|
DeployApplicationRequest.Builder |
slsConfigs(String slsConfigs)
The logging configurations of Log Service.
|
DeployApplicationRequest.Builder |
slsLogEnvTags(String slsLogEnvTags)
SlsLogEnvTags.
|
DeployApplicationRequest.Builder |
startupProbe(String startupProbe)
Check Failure: Indicates that the application failed to start.
|
DeployApplicationRequest.Builder |
swimlanePvtzDiscoverySvc(String swimlanePvtzDiscoverySvc)
Configure K8s Service-based Service Registration/Discovery and Full-Chain Grayscale Capabilities
enable: Whether to enable full-link grayscale based on K8s Service (set to "true" to enable; set to "false" to disable).
|
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)
The ID of the vSwitch, where the EIP of the application instances resides.
|
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)
The Alibaba Cloud Resource Name (ARN) required for a RAM role to obtain images across accounts. For more information, see Grant permissions across Alibaba Cloud accounts by using a RAM role.
example:acs:ram::123456789012****:role/adminrole
public DeployApplicationRequest.Builder acrInstanceId(String acrInstanceId)
The ID of Container Registry Enterprise Edition instance N. This parameter is required when the ImageUrl parameter is set to the URL of an image in an ACR Enterprise Edition instance.
example:cri-xxxxxx
public DeployApplicationRequest.Builder agentVersion(String agentVersion)
public DeployApplicationRequest.Builder albIngressReadinessGate(String albIngressReadinessGate)
public DeployApplicationRequest.Builder appId(String appId)
The ID of the application.
This parameter is required.
example:7171a6ca-d1cd-4928-8642-7d5cfe69****
public DeployApplicationRequest.Builder associateEip(Boolean associateEip)
Specifies whether to associate an EIP with the node pool. Take note of the following rules:
true
public DeployApplicationRequest.Builder autoEnableApplicationScalingRule(Boolean autoEnableApplicationScalingRule)
Specifies whether to automatically enable an auto scaling policy for the application. Take note of the following rules:
true
public DeployApplicationRequest.Builder batchWaitTime(Integer batchWaitTime)
The interval between batches during a batch release. Unit: minutes.
example:10
public DeployApplicationRequest.Builder changeOrderDesc(String changeOrderDesc)
The description of the change order.
example:Start the application
public DeployApplicationRequest.Builder command(String command)
The command that is used to start the image. The command must be an existing executable object in the container. Sample statements:
command:
- echo
- abc
- >
- file0
In this example, the Command parameter is set to Command="echo", CommandArgs=["abc", ">", "file0"].
echo
public DeployApplicationRequest.Builder commandArgs(String commandArgs)
The parameters of the image startup command. The CommandArgs parameter specifies the parameters that are required for the Command parameter. You can specify the name in one of the following formats:
["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.
["a","b"]
public DeployApplicationRequest.Builder configMapMountDesc(String configMapMountDesc)
The description of the ConfigMap instance mounted to the application. Use configurations created on the Configuration Items page to configure containers. The following table describes the parameters that are used in the preceding statements.
You can use
sae-sys-configmap-allto mount all keys.
[{"configMapId":16,"key":"test","mountPath":"/tmp"}]
public DeployApplicationRequest.Builder cpu(Integer cpu)
The CPU specifications that are required for each instance. Unit: millicores. This parameter cannot be set to 0. Valid values:
1000
public DeployApplicationRequest.Builder customHostAlias(String customHostAlias)
The custom mappings between hostnames and IP addresses in the container. Take note of the following rules:
[{"hostName":"samplehost","ip":"127.0.0.1"}]
public DeployApplicationRequest.Builder customImageNetworkType(String customImageNetworkType)
Custom image type. To it to empty string to use pre-built image.
internet: Public network image
intranet: Private network image
internet
public DeployApplicationRequest.Builder deploy(String deploy)
This parameter takes effect only for applications that are in the Stopped state. If you call the DeployApplication operation to manage a running application, the application is immediately redeployed.
true
public DeployApplicationRequest.Builder dotnet(String dotnet)
The version of .NET
.NET 3.1
public 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.
example:3.5.3
public DeployApplicationRequest.Builder emptyDirDesc(String emptyDirDesc)
public DeployApplicationRequest.Builder enableAhas(String enableAhas)
Indicates whether access to Application High Availability Service (AHAS) is enabled. Take note of the following rules:
false
public DeployApplicationRequest.Builder enableCpuBurst(Boolean enableCpuBurst)
Enable CPU Burst.
true: enable
false: disable
example:true
public DeployApplicationRequest.Builder enableGreyTagRoute(Boolean enableGreyTagRoute)
Indicates whether canary release rules are enabled. Canary release rules apply only to applications in Spring Cloud and Dubbo frameworks. Take note of the following rules:
false
public DeployApplicationRequest.Builder enableNamespaceAgentVersion(Boolean enableNamespaceAgentVersion)
public DeployApplicationRequest.Builder enableNewArms(Boolean enableNewArms)
Enable new ARMS features.
true: enable
false: disable
true
public DeployApplicationRequest.Builder enablePrometheus(Boolean enablePrometheus)
public DeployApplicationRequest.Builder enableSidecarResourceIsolated(Boolean enableSidecarResourceIsolated)
Enable Sidecar resource isolation.
true: enable
false: disable
example:true
public DeployApplicationRequest.Builder envs(String envs)
The environment variables. You can configure custom environment variables or reference a ConfigMap. If you want to reference a ConfigMap, you must first create a ConfigMap. For more information, see CreateConfigMap. Take note of the following rules:
Customize
Reference ConfigMap
sae-sys-configmap-all-<ConfigMap name>. Example: sae-sys-configmap-all-test1.configMapRef.Reference secret dictionary
sae-sys-secret-all-<Secret dictionary name>. Example: sae-sys-secret-all-test1.secretRef.[{"name":"envtmp","value":"0"}]
public DeployApplicationRequest.Builder gpuConfig(String gpuConfig)
public DeployApplicationRequest.Builder html(String html)
public DeployApplicationRequest.Builder imagePullSecrets(String imagePullSecrets)
The ID of the corresponding Secret.
example:10
public DeployApplicationRequest.Builder imageUrl(String imageUrl)
The URL of the image. This parameter is returned only if the PackageType parameter is set to Image.
example:registry.cn-hangzhou.aliyuncs.com/sae_test/ali_sae_test:0.0.1
public DeployApplicationRequest.Builder initContainersConfig(List<InitContainerConfig> initContainersConfig)
Initialize container configuration.
public DeployApplicationRequest.Builder jarStartArgs(String jarStartArgs)
The arguments in the JAR package. The arguments are used to start the application container. The default startup command is $JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArgs.
-Xms4G -Xmx4G
public DeployApplicationRequest.Builder jarStartOptions(String jarStartOptions)
The option settings in the JAR package. The settings are used to start the application container. The default startup command for application deployment is $JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArgs.
custom-option
public DeployApplicationRequest.Builder jdk(String jdk)
The version of the Java development kit (JDK) on which the deployment package of the application depends. The following versions are supported:
This parameter is not returned if the PackageType parameter is set to Image.
example:Open JDK 8
public DeployApplicationRequest.Builder kafkaConfigs(String kafkaConfigs)
The logging configurations of Message Queue for Apache Kafka. Take note of the following rules:
{"kafkaEndpoint":"10.0.X.XXX:XXXX,10.0.X.XXX:XXXX,10.0.X.XXX:XXXX","kafkaInstanceId":"alikafka_pre-cn-7pp2l8kr****","kafkaConfigs":[{"logType":"file_log","logDir":"/tmp/a.log","kafkaTopic":"test2"},{"logType":"stdout","logDir":"","kafkaTopic":"test"}]}
public DeployApplicationRequest.Builder labels(Map<String,String> labels)
public DeployApplicationRequest.Builder liveness(String liveness)
The details of the availability check that was performed on the container. If the container fails this health check multiple times, the system disables and restarts the container. You can use one of the following methods to perform the health check:
{"exec":{"command":["sh","-c","cat/home/admin/start.sh"]},"initialDelaySeconds":30,"periodSeconds":30,"timeoutSeconds":2}{"httpGet":{"path":"/","port":18091,"scheme":"HTTP","isContainKeyWord":true,"keyWord":"SAE"},"initialDelaySeconds":11,"periodSeconds":10,"timeoutSeconds":1}{"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":["sleep","5s"]},"initialDelaySeconds":10,"timeoutSeconds":11}
public DeployApplicationRequest.Builder lokiConfigs(String lokiConfigs)
public DeployApplicationRequest.Builder maxSurgeInstanceRatio(Integer maxSurgeInstanceRatio)
public DeployApplicationRequest.Builder maxSurgeInstances(Integer maxSurgeInstances)
public DeployApplicationRequest.Builder memory(Integer memory)
The memory size that is required by each instance. Unit: MB. This parameter cannot be set to 0. The values of this parameter correspond to the values of the Cpu parameter:
1024
public DeployApplicationRequest.Builder microRegistration(String microRegistration)
The Nacos registry. Valid values:
"0"
public DeployApplicationRequest.Builder microRegistrationConfig(String microRegistrationConfig)
Select the edition of Nacos.
0: SAE built-in Nacos. Unable to get the configuration of SAE built-in Nacos.
1: Self-built Nacos from users.
2: MSE enterprise Nacos.
{"instanceId":"mse-cn-zvp2bh6h70r","namespace":"4c0aa74f-57cb-423c-b6af-5d9f2d0e3dbd"}
public DeployApplicationRequest.Builder microserviceEngineConfig(String microserviceEngineConfig)
Configure Microservices Governance
Whether to enable microservices governance (enable):
Configure lossless online/offline deployment (mseLosslessRule):
delayTime: Delay duration (unit: seconds)
enable: Whether to enable lossless deployment
true: Enable
false: Disable
notice: Whether to enable notifications
true: Enable
false: Disable
warmupTime: Small-traffic warm-up duration (unit: seconds)
example:{"enable": true,"mseLosslessRule": {"delayTime": 0,"enable": false,"notice": false,"warmupTime": 120}}
public DeployApplicationRequest.Builder minReadyInstanceRatio(Integer minReadyInstanceRatio)
The percentage of the minimum number of available instances. Take note of the following rules:
example: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%.
-1
public DeployApplicationRequest.Builder minReadyInstances(Integer minReadyInstances)
The minimum number of available instances. Special values:
example:Make sure that at least one instance is available during application deployment and rollback to prevent business interruptions.
1
public DeployApplicationRequest.Builder mountDesc(String mountDesc)
The configurations for mounting the NAS file system. After the application is created, you may want to call other operations to manage the application. If you do not want to change the NAS configurations in these subsequent operations, you can omit the MountDesc parameter in the requests. If you want to unmount the NAS file system, you must set the MountDesc values in the subsequent requests to an empty string ("").
example:[{mountPath: "/tmp", nasPath: "/"}]
public DeployApplicationRequest.Builder mountHost(String mountHost)
The mount target of the NAS file system in the VPC where the application is deployed. If you do not need to modify this configuration during the deployment, configure the MountHost parameter only in the first request. You do not need to include this parameter in subsequent requests. If you need to remove this configuration, leave the MountHost parameter empty in the request.
example:10d3b4bc9****.com
public DeployApplicationRequest.Builder nasConfigs(String nasConfigs)
The configurations of mounting the NAS file system. Take note of the following rules:
[{"mountPath":"/test1","readOnly":false,"nasId":"nasId1","mountDomain":"nasId1.cn-shenzhen.nas.aliyuncs.com","nasPath":"/test1"},{"nasId":"nasId2","mountDomain":"nasId2.cn-shenzhen.nas.aliyuncs.com","readOnly":false,"nasPath":"/test2","mountPath":"/test2"}]
public DeployApplicationRequest.Builder nasId(String nasId)
The ID of the File Storage NAS file system. After the application is created, you may want to call other operations to manage the application. If you do not want to change the NAS configurations in these subsequent operations, you can omit the NasId parameter in the requests. If you want to unmount the NAS file system, you must set the NasId values in the subsequent requests to an empty string ("").
example:10d3b4****
public DeployApplicationRequest.Builder newSaeVersion(String newSaeVersion)
SAE edition.
lite: the lightweight edition.
std: the standard edition.
pro: the professional edition.
pro
public DeployApplicationRequest.Builder oidcRoleName(String oidcRoleName)
The name of the RAM role used to authenticate the user identity.
example:You need to create an OpenID Connect (OIDC) identity provider (IdP) and an identity provider (IdP) for role-based single sign-on (SSO) in advance. For more information, see Creates an OpenID Connect (OIDC) identity provider (IdP) and Creates an identity provider (IdP) for role-based single sign-on (SSO).
sae-test
public DeployApplicationRequest.Builder ossAkId(String ossAkId)
The AccessKey ID that is used to read data from and write data to Object Storage Service (OSS) buckets.
example:xxxxxx
public DeployApplicationRequest.Builder ossAkSecret(String ossAkSecret)
The AccessKey secret that is used to read data from and write data to OSS buckets.
example:xxxxxx
public DeployApplicationRequest.Builder ossMountDescs(String ossMountDescs)
Information of the Object Storage Service (OSS) bucket mounted to the application. The following table describes the parameters that are used in the preceding statements.
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:
[{"bucketName": "oss-bucket", "bucketPath": "data/user.data", "mountPath": "/usr/data/user.data", "readOnly": true}]
public DeployApplicationRequest.Builder packageType(String packageType)
The package type.
When using Java, FatJar, War and Image are supported. When using Python, PythonZip and Image are supported. When using PHP, the followings are supported:
FatJar
public DeployApplicationRequest.Builder packageUrl(String packageUrl)
The address of the deployment package. This parameter is required when the PackageType parameter is set to FatJar, War, or PythonZip.
example:http://myoss.oss-cn-hangzhou.aliyuncs.com/my-buc/2019-06-30/****.jar
public DeployApplicationRequest.Builder packageVersion(String packageVersion)
The version of the deployment package. This parameter is required when the PackageType parameter is set to FatJar, War, or PythonZip.
example:1.0.1
public DeployApplicationRequest.Builder php(String php)
The dependent PHP version of PHP package. Image is not supported.
example:PHP-FPM 7.0
public DeployApplicationRequest.Builder phpArmsConfigLocation(String phpArmsConfigLocation)
The path on which the PHP configuration file for application monitoring is mounted. Make sure that the PHP server loads the configuration file. SAE automatically generates the corresponding configuration file. No manual operations are required.
example:/usr/local/etc/php/conf.d/arms.ini
public DeployApplicationRequest.Builder phpConfig(String phpConfig)
The details of the PHP configuration file.
example:k1=v1
public DeployApplicationRequest.Builder phpConfigLocation(String phpConfigLocation)
The path on which the PHP configuration file for application startup is mounted. Make sure that the PHP server uses this configuration file during the startup.
example:/usr/local/etc/php/php.ini
public DeployApplicationRequest.Builder postStart(String postStart)
The script that is run immediately after the container is started. Example: {"exec":{"command":["sh","-c","echo hello"\]}}
{"exec":{"command":["sh","-c","echo hello"]}}
public DeployApplicationRequest.Builder preStop(String preStop)
The script that is run before the container is stopped. Example: {"exec":{"command":["sh","-c","echo hello"\]}}
{"exec":{"command":["sh","-c","echo hello"]}}
public DeployApplicationRequest.Builder pvtzDiscoverySvc(String pvtzDiscoverySvc)
The configurations of Kubernetes Service-based service registration and discovery. Take note of the following rules:
<Custom content>-<Namespace ID>. -<Namespace ID> is automatically specified based on the namespace in which an application resides and cannot be changed. For example, if you select the default namespace in the China (Beijing) region, -cn-beijing-default is automatically specified.{"serviceName":"bwm-poc-sc-gateway-cn-beijing-front","namespaceId":"cn-beijing:front","portAndProtocol":{"18012":"TCP"},"enable":true}
public DeployApplicationRequest.Builder python(String python)
The Python environment. Set the value to PYTHON 3.9.15.
example:PYTHON 3.9.15
public DeployApplicationRequest.Builder pythonModules(String pythonModules)
The configurations for installing custom module dependencies. By default, the dependencies defined by the requirements.txt file in the root directory are installed. If the package does not contain this file and you do not configure custom dependencies in the package, specify the dependencies that you want to install in the text box.
example:Flask==2.0
public DeployApplicationRequest.Builder readiness(String readiness)
The details of the health check that was performed on the container. If the container fails this health check multiple times, the system disables and restarts the container. Containers that fail health checks cannot receive traffic from Server Load Balancer (SLB) instances. You can use the exec, httpGet, or tcpSocket method to perform health checks. For more information, see the description of the Liveness parameter.
example:You can use only one method to perform the health check.
{"exec":{"command":["sleep","6s"]},"initialDelaySeconds":15,"timeoutSeconds":12}
public DeployApplicationRequest.Builder replicas(Integer replicas)
The number of instances.
example:1
public DeployApplicationRequest.Builder secretMountDesc(String secretMountDesc)
Secret Mount Description Use the secret dictionaries created in the Namespace Secret Dictionary page to inject information into containers. Parameter descriptions are as follows:
secretId: Secret instance ID. Obtain via the ListSecrets interface.
key: Key-value pair. Note: Set the parameter sae-sys-secret-all to mount all keys.
mountPath: Mount path.
[{“secretId":10,”key":"test","mountPath":"/tmp"}]
public DeployApplicationRequest.Builder securityGroupId(String securityGroupId)
Security group ID.
example:sg-wz969ngg2e49q5i4****
public DeployApplicationRequest.Builder serviceTags(String serviceTags)
The gray-release tag of the application.
example:{"alicloud.service.tag":"g1"}
public DeployApplicationRequest.Builder sidecarContainersConfig(List<SidecarContainerConfig> sidecarContainersConfig)
The configuration of the container.
public DeployApplicationRequest.Builder slsConfigs(String slsConfigs)
The logging configurations of Log Service.
[{"logDir":"","logType":"stdout"},{"logDir":"/tmp/a.log"}].[{"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.
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.
example: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.
[{"logDir":"","logType":"stdout"},{"logDir":"/tmp/a.log"}]
public DeployApplicationRequest.Builder slsLogEnvTags(String slsLogEnvTags)
public DeployApplicationRequest.Builder startupProbe(String startupProbe)
Check Failure: Indicates that the application failed to start. The system will report the exception and automatically restart it.
Note:
Supports exec, httpGet, and tcpSocket methods. For specific examples, see Liveness Parameters. Only one method can be selected for health checks.
example:{"exec":{"command":["sh","-c","cat /home/admin/start.sh"]},"initialDelaySeconds":30,"periodSeconds":30,"timeoutSeconds":2}
public DeployApplicationRequest.Builder swimlanePvtzDiscoverySvc(String swimlanePvtzDiscoverySvc)
Configure K8s Service-based Service Registration/Discovery and Full-Chain Grayscale Capabilities
enable: Whether to enable full-link grayscale based on K8s Service (set to "true" to enable; set to "false" to disable).
namespaceId: Namespace ID
portAndProtocol: Listener port and protocol. Format: {"Port:Protocol Type":"Container Port"}
portProtocols: Define service ports and protocols port: Port protocol: Protocol targetPort: Container port
pvtzDiscoveryName: Service discovery name
serviceId: Service ID
serviceName: Service name
{"enable":"false","namespaceId":"cn-beijing:test","portAndProtocol":{"2000:TCP":"18081"},"portProtocols":[{"port":2000,"protocol":"TCP","targetPort":18081}],"pvtzDiscoveryName":"cn-beijing-1421801774382676","serviceId":"3513","serviceName":"demo-gray.test"}
public DeployApplicationRequest.Builder terminationGracePeriodSeconds(Integer terminationGracePeriodSeconds)
The timeout period for a graceful shutdown. Default value: 30. Unit: seconds. Valid values: 1 to 300.
example:10
public DeployApplicationRequest.Builder timezone(String timezone)
The time zone. Default value: Asia/Shanghai.
example:Asia/Shanghai
public DeployApplicationRequest.Builder tomcatConfig(String tomcatConfig)
The Tomcat configuration. If you want to cancel this configuration, set this parameter to "" or "{}". The following variables are included in the configuration: Take note of the following rules:
{"port":8080,"contextPath":"/","maxThreads":400,"uriEncoding":"ISO-8859-1","useBodyEncodingForUri":true}
public DeployApplicationRequest.Builder updateStrategy(String updateStrategy)
The deployment policy. If the minimum number of available instances is 1, the value of the UpdateStrategy parameter is an empty string (""). If the minimum number of available instances is greater than 1, the following strategies can be configured:
{"type":"GrayBatchUpdate","batchUpdate":{"batch":2,"releaseType":"auto","batchWaitTime":1},"grayUpdate":{"gray":1}}.{"type":"GrayBatchUpdate","batchUpdate":{"batch":2,"releaseType":"manual"},"grayUpdate":{"gray":1}}.{"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.
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.
{"type":"GrayBatchUpdate","batchUpdate":{"batch":2,"releaseType":"auto","batchWaitTime":1},"grayUpdate":{"gray":1}}
public DeployApplicationRequest.Builder vSwitchId(String vSwitchId)
The ID of the vSwitch, where the EIP of the application instances resides. The vSwitch must reside in the VPC above.
example:vsw-bp12mw1f8k3jgygk9****
public DeployApplicationRequest.Builder warStartOptions(String warStartOptions)
The startup command of the WAR package. For information about how to configure the startup command, see Configure startup commands.
example:CATALINA_OPTS="$CATALINA_OPTS $Options" catalina.sh run
public DeployApplicationRequest.Builder webContainer(String webContainer)
The version of the Tomcat container on which the deployment package depends. Valid values:
This parameter is not returned if the PackageType parameter is set to Image.
example:apache-tomcat-7.0.91
public DeployApplicationRequest build()
Copyright © 2026. All rights reserved.