# Alibaba Cloud Serverless App Engine API > Alibaba Cloud Serverless App Engine API on Apizie: 153 endpoints (Terminates a change order and rolls back the corresponding application, Aborts a change order, Restarts applications in batches, Starts applications in batches, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://www.apizie.tech/v1/cloud:aliyun-sae/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month. - Project key: `cloud:aliyun-sae` - Category: Cloud - Status: byok - Source: https://api.alibabacloud.com/product/sae - Page: https://www.apizie.tech/api/cloud/aliyun-sae - OpenAPI: https://www.apizie.tech/api/cloud/aliyun-sae/openapi.json Alibaba Cloud OpenAPI for Serverless App Engine (sae, version 2019-05-06). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret. ## Endpoints ### Terminates a change order and rolls back the corresponding application `POST https://www.apizie.tech/v1/cloud:aliyun-sae/abort-and-rollback-change-order` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | ChangeOrderId | string | yes | The ID of the change order | ### Aborts a change order `POST https://www.apizie.tech/v1/cloud:aliyun-sae/abort-change-order` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | ChangeOrderId | string | yes | The ID of the change order | | Rollback | string | no | Specifies whether to roll back | ### Restarts applications in batches `POST https://www.apizie.tech/v1/cloud:aliyun-sae/batch-restart-applications` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | NamespaceId | string | yes | The namespace ID | | AppIds | string | yes | The list of application IDs. Separate multiple IDs with commas (,) | ### Starts applications in batches `POST https://www.apizie.tech/v1/cloud:aliyun-sae/batch-start-applications` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | NamespaceId | string | yes | The namespace ID | | AppIds | string | no | The application IDs. Separate multiple IDs with commas (,) | | Version | string | no | The application version | ### Stops multiple applications `POST https://www.apizie.tech/v1/cloud:aliyun-sae/batch-stop-applications` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | NamespaceId | string | yes | The namespace ID | | AppIds | string | no | The IDs of the applications to be stopped. To stop multiple applications at the same time, separate the application IDs with commas (,) | | Version | string | no | The version of the application | ### Binds a Network Load Balancer (NLB) to an application `POST https://www.apizie.tech/v1/cloud:aliyun-sae/bind-nlb` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | AppId | string | no | The ID of the application | | NlbId | string | no | The ID of the NLB instance | | Listeners | string | no | The JSON array string of the listeners to be configured. The structure of each listener is as follows: Port: Integer type, required. The… | | ZoneMappings | string | no | The JSON string of the zone and vSwitch mapping list. You can add up to 10 zones. If the current region supports two or more zones, you… | | AddressType | string | no | The address type. Valid values: Internet: public network address. Intranet: private network address | ### Binds a Server Load Balancer (SLB) instance to the application `POST https://www.apizie.tech/v1/cloud:aliyun-sae/bind-slb` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | AppId | string | yes | 0099b7be-5f5b-4512-a7fc-56049ef1\\ | | Internet | string | no | [{"port":80,"targetPort":8080,"protocol":"TCP"}] | | Intranet | string | no | [{"port":80,"targetPort":8080,"protocol":"TCP"}] | | InternetSlbId | string | no | lb-bp1tg0k6d9nqaw7l1\\ | | IntranetSlbId | string | no | lb-bp1tg0k6d9nqaw7l1\\ | | InternetSlbChargeType | string | no | The billing method of an Internet-facing SLB instance. The following billing methods are supported: PayBySpec: Pay-by-specification.… | | IntranetSlbChargeType | string | no | The billing method of an Internal-facing SLB instance. The following billing methods are supported: PayBySpec: Pay-by-specification.… | ### Confirms whether to start the next batch `GET https://www.apizie.tech/v1/cloud:aliyun-sae/confirm-pipeline-batch` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | PipelineId | string | yes | The batch ID. You can obtain this ID by calling the DescribeChangeOrder… | | Confirm | string | yes | Specifies whether to start the next batch. Valid values: true: Start the next batch. false: Terminate the process | ### Creates an application `POST https://www.apizie.tech/v1/cloud:aliyun-sae/create-application` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | AppName | string | yes | The name of the application. The name can contain digits, letters, and hyphens (-). It must start with a letter and cannot end with a… | | NamespaceId | string | no | The ID of the Serverless App Engine (SAE) namespace. Only namespaces whose names contain lowercase letters and hyphens (-) are supported.… | | AppDescription | string | no | The description of the application. The description can be up to 1,024 characters in length | | VpcId | string | no | The ID of the virtual private cloud (VPC) that corresponds to the SAE namespace. In SAE, a namespace can correspond to only one VPC, and… | | VSwitchId | string | no | The ID of the vSwitch to which the elastic network interface controllers (NICs) of the application instance belong. The vSwitch must… | | PackageType | string | yes | The type of the application package. Valid values: When you deploy the application by using Java, FatJar, War, and Image are supported.… | | PackageVersion | string | no | The version number of the deployment package. This parameter is required when PackageType is set to FatJar, War, or PythonZip | | PackageUrl | string | no | The URL of the deployment package. This parameter is required when PackageType is set to FatJar, War, or PythonZip | | ImageUrl | string | no | The URL of the image. This parameter is required when PackageType is set to Image | | Jdk | string | no | The JDK version on which the deployment package depends. Valid values: Open JDK 8 Open JDK 7 Dragonwell 11 Dragonwell 8… | | WebContainer | string | no | The Tomcat version on which the WebContainer deployment package depends. Valid values: apache-tomcat-7.0.91 apache-tomcat-8.5.42 This… | | Cpu | integer | no | The number of CPU cores required for each instance. Unit: millicore. The value cannot be 0. Only the following defined specifications are… | | Memory | integer | no | The memory size required for each instance. Unit: MB. The value cannot be 0. The memory size has a one-to-one correspondence with the… | | Replicas | integer | yes | The initial number of instances | | Command | string | no | The startup command of the image. The command must be an executable object that exists in the container. Example: ``` command: - echo -… | | CommandArgs | string | no | The arguments for the image startup command, which are required by the startup command Command. The format is as follows: `["a","b"]` In… | | Envs | string | no | The environment variables of the container. You can customize environment variables or reference ConfigMaps. To reference a ConfigMap, you… | | CustomHostAlias | string | no | The custom host mapping in the container. Valid values: hostName: the domain name or hostname. ip: the IP address | | JarStartOptions | string | no | The startup options for the JAR package. Default startup command: `$JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS… | | JarStartArgs | string | no | The startup arguments for the JAR package. Default startup command: `$JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS… | | Liveness | string | no | The liveness probe of the container. A container that failed the health check undergoes shutdown and recovers. The following methods are… | | Readiness | string | no | The readiness probe of the application. A container that fails multiple health checks is stopped and restarted. Traffic from Server Load… | | Deploy | string | no | Specifies whether to deploy the application immediately. Valid values: true: deploys the application immediately. This is the default… | | EdasContainerVersion | string | no | The version of the application runtime environment in the High-Speed Service Framework (HSF), such as the Ali-Tomcat container | | Timezone | string | no | The time zone. Default value: Asia/Shanghai | | SlsConfigs | string | no | The configuration for collecting logs to Simple Log Service (SLS). Use SLS resources from automatic creation by SAE:… | | NasId | string | no | Do not configure this field. Configure NasConfigs instead. The ID of the mounted Apsara File Storage NAS file system. The NAS file system… | | MountHost | string | no | Do not configure this field. Configure NasConfigs instead. The mount target of the NAS file system in the VPC of the application. If the… | | MountDesc | string | no | Do not configure this field. Configure NasConfigs instead. The mount description of the NAS file system. If the configuration remains… | | PreStop | string | no | The script to execute before the container stops. A script is triggered and executed before the container is deleted. Format:… | | PostStart | string | no | The script to execute after the container starts. A script is triggered and executed immediately after the container is created. Format:… | | WarStartOptions | string | no | The startup command for the application deployed by using a WAR package. The procedure is the same as that for configuring the startup… | | ConfigMapMountDesc | string | no | The mount description of the ConfigMap. Uses the configuration item created on the configuration item page of the namespace to inject… | | SecurityGroupId | string | no | The ID of the security group | | AutoConfig | string | no | Specifies whether to automatically configure the network environment. Valid values: true: SAE automatically configures the network… | | TerminationGracePeriodSeconds | integer | no | The timeout period for graceful shutdown. Default value: 30. Unit: seconds. Valid values: 1 to 300 | | PhpArmsConfigLocation | string | no | The mount path for PHP application monitoring. You must ensure that the PHP server loads the configuration file in this path. You do not… | | PhpConfigLocation | string | no | The mount path for the PHP application startup configuration. You must ensure that the PHP server uses this configuration file to start | | PhpConfig | string | no | The content of the PHP configuration file | | TomcatConfig | string | no | The Tomcat file configuration. Set the value to "" or "{}" to delete the configuration: port: the port range is 1024 to 65535. Ports… | | OssMountDescs | string | no | The OSS mount description. Parameter description: bucketName: the name of the bucket. bucketPath: the folder or object that you created in… | | OssAkId | string | no | The AccessKey ID used to read and write OSS data | | OssAkSecret | string | no | The AccessKey Secret used to read and write OSS data | | Php | string | no | The PHP version on which the PHP deployment package depends. Images are not supported | | AcrInstanceId | string | no | The Container Registry ACR Enterprise instance ID. This parameter is required when ImageUrl is set to a Container Registry Enterprise… | | AcrAssumeRoleArn | string | no | The ARN of the RAM role required to pull images across accounts. For more information, see… | | ImagePullSecrets | string | no | The ID of the corresponding Secret | | AssociateEip | string | no | Specifies whether to associate an elastic IP address (EIP). Valid values: true: associates an EIP. false: does not associate an EIP | | ProgrammingLanguage | string | no | The programming language used to create the application. Valid values: java: Java. php: PHP. python: Python. dotnet: .NET Core. other:… | | KafkaConfigs | string | no | The summary configuration for collecting logs to Kafka. Valid values: kafkaEndpoint: the service registration address of the Kafka API.… | | PvtzDiscoverySvc | string | no | Enables Kubernetes Service registration and discovery. Valid values: serviceName: the service name. The format is custom-namespace ID. The… | | MicroRegistration | string | no | The Nacos registry. Valid values: 0: the built-in Nacos of SAE. 1: a self-managed Nacos. 2: Microservices Engine (MSE) Nacos | | MicroRegistrationConfig | string | no | The configuration of the registry | | NasConfigs | string | no | The configuration for mounting the NAS file system. Valid values: mountPath: the mount path of the container. readOnly: A value of false… | | Python | string | no | The Python environment. PYTHON 3.9.15 is supported | | PythonModules | string | no | The custom installation module dependencies. By default, the dependencies defined in the requirements.txt file in the root folder are… | | Dotnet | string | no | The version number of the .NET framework: .NET 3.1 .NET 5.0 .NET 6.0 .NET 7.0 .NET 8.0 | | EnableEbpf | string | no | Specifies whether to enable application monitoring for non-Java applications based on eBPF technology. Valid values: true: enables the… | | SaeVersion | string | no | The SAE version. Valid values: v1 v2 | | AppSource | string | no | The source of the application. A value of micro_service indicates a microservice application | | BaseAppId | string | no | The ID of the base application | | ServiceTags | string | no | The canary release tags configured for the application | | EnableNewArms | string | no | Specifies whether to enable the new Application Real-Time Monitoring Service (ARMS) features: true: enables the features. false: disables… | | EnableCpuBurst | string | no | Specifies whether to enable the CPU Burst feature: true: enables the feature. false: disables the feature | | OidcRoleName | string | no | The RAM role for the identity authentication service. You must create an OIDC identity provider and an identity provider role in the same… | | SidecarContainersConfig | string | no | The container configuration (JSON-encoded) | | SecretMountDesc | string | no | The mount description of the Secret. Uses the Secret created on the Secret page of the namespace to inject confidential information into… | | EnableSidecarResourceIsolated | string | no | Specifies whether to enable sidecar resource isolation: true: enables isolation. false: disables isolation | | CustomImageNetworkType | string | no | The custom image type. If the image is not a custom image, set this parameter to an empty string: internet: public network image.… | | ResourceType | string | no | The resource type. Valid values: NULL (default), default (default), and haiguang (Hygon servers) | | NewSaeVersion | string | no | The application version. Valid values: lite: Lite Edition. std: Standard Edition. pro: Professional Edition | | MicroserviceEngineConfig | string | no | Configures microservice governance features. enable: Specifies whether to enable microservice governance. Valid values: true: Enabled.… | | DiskSize | integer | no | The disk storage size, in GB | | InitContainersConfig | string | no | The init container configuration (JSON-encoded) | | GpuConfig | string | no | The GPU configuration | | StartupProbe | string | no | Enables application startup probes. Success: Indicates that the application is started. If you configure liveness and readiness probes,… | | IsStateful | string | no | Specifies whether the application is stateful | | EnablePrometheus | string | no | Specifies whether to enable Prometheus custom metric collection | | HeadlessPvtzDiscoverySvc | string | no | The Kubernetes headless service registration and discovery configuration. serviceName: The service name. namespaceId: The namespace ID | | Html | string | no | The NGINX version. Valid values: nginx 1.20 nginx 1.22 nginx 1.24 nginx 1.26 nginx 1.28 | | EmptyDirDesc | string | no | The shared ephemeral storage configuration | | EnableNamespaceAgentVersion | string | no | Specifies whether to reuse the namespace agent version configuration | | AgentVersion | string | no | The Aliyun Agent version | | EnableNamespaceSlsConfig | string | no | Specifies whether to reuse the namespace Simple Log Service (SLS) log configuration | | SlsLogEnvTags | string | no | sls log tags | | LokiConfigs | string | no | LokiConfigs | | Labels | string | no | The application labels. Both keys and values are strings (JSON-encoded) | | RaspConfig | string | no | The application runtime security protection (RASP) configuration (JSON-encoded) | ### Creates an elastic scaling policy for an application `POST https://www.apizie.tech/v1/cloud:aliyun-sae/create-application-scaling-rule` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | AppId | string | yes | The application ID | | ScalingRuleName | string | yes | The custom name of the elastic scaling policy. The policy name must be unique within the application, start with a lowercase letter, and… | | ScalingRuleType | string | yes | The type of the elastic scaling policy. Valid values: timing: scheduled elastic scaling. metric: monitoring metric-based elastic scaling.… | | ScalingRuleTimer | string | no | The configuration of the scheduled elastic policy. This parameter is required when you select a scheduled elastic policy or use an SDK for… | | ScalingRuleMetric | string | no | The configuration of the monitoring metric-based elastic policy. This parameter is required when you select the monitoring metric-based… | | MinReadyInstances | integer | no | The minimum number of surviving instances. Valid values: If you set this parameter to 0, services are interrupted during the application… | | MinReadyInstanceRatio | integer | no | The percentage of the minimum number of surviving instances. Valid values: -1: the initial value, which indicates that the percentage is… | | ScalingRuleEnable | string | no | Specifies whether to enable the elastic scaling policy. Valid values: true: enabled. false: disabled | | EnableIdle | string | no | Specifies whether to enable the idle mode | ### Creates a ConfigMap instance in a namespace `POST https://www.apizie.tech/v1/cloud:aliyun-sae/create-config-map` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | Name | string | yes | The name of the ConfigMap instance. The name can contain digits, letters, and underscores (_), and must start with a letter | | NamespaceId | string | yes | The ID of the namespace where the ConfigMap instance resides | | Data | string | yes | The key-value pair data of the ConfigMap in JSON format. The format is as follows: {"Data":"{\"k1\":\"v1\", \"k2\":\"v2\"}"} k represents… | | Description | string | no | The description. The description cannot contain spaces and can be up to 255 characters in length | ### Creates a canary release rule for a Spring Cloud or Dubbo application `POST https://www.apizie.tech/v1/cloud:aliyun-sae/create-grey-tag-route` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | AppId | string | yes | The application ID | | Name | string | yes | The rule name. It must start with a lowercase letter, end with a digit or a lowercase letter, and can contain only lowercase letters,… | | Description | string | no | The rule description. It can be up to 64 characters in length | | ScRules | string | no | The canary release rules created for a Spring Cloud application. This parameter is required when your application uses the Spring Cloud… | | DubboRules | string | no | The canary release rules created for a Dubbo application. This parameter is required when your application uses the Dubbo framework. You… | | AlbRules | string | no | The canary release rules created for an application that has ALB gateway routing configured | ### Creates a routing rule `POST https://www.apizie.tech/v1/cloud:aliyun-sae/create-ingress` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | NamespaceId | string | yes | The ID of the namespace where the application resides. Cross-namespace applications are not supported | | Description | string | no | The name of the routing rule | | SlbId | string | no | The SLB instance ID used by the routing rule. Server Load Balancer (SLB) includes CLB and ALB instances | | ListenerPort | integer | yes | The listening port of the SLB instance. The port must not be occupied | | CertId | string | no | The ID of the CLB certificate. Valid values: If LoadBalanceType is set to clb, use this field to configure the certificate for the HTTPS… | | CertIds | string | no | The IDs of the ALB certificates. Valid values: If LoadBalanceType is set to alb, use this field to configure multiple certificates for the… | | DefaultRule | string | yes | The default forwarding rule. Traffic is forwarded to the specified application based on the IP address through the specified port. The… | | Rules | string | yes | The forwarding rules. Traffic is forwarded to the specified application based on the domain name and the request path through the… | | LoadBalanceType | string | no | The type of the SLB instance. The type depends on the value specified when the routing rule is created and cannot be changed during… | | ListenerProtocol | string | no | The request forwarding protocol. Valid values: HTTP: applicable to applications that need to identify data content. HTTPS: applicable to… | | SecurityPolicyId | string | no | The ID of the security policy instance | | RequestTimeout | integer | no | Specifies the request timeout period. Unit: seconds. Valid values: 1 to 180. If the backend server does not send a response within the… | | IdleTimeout | integer | no | Specifies the connection idle timeout period. Unit: seconds. Valid values: 1 to 60. If no access request is received within the timeout… | | EnableXForwardedFor | string | no | Specifies whether to enable the feature to obtain the client IP address of the visitor through the X-Forwarded-For header field | | EnableXForwardedForClientSrcPort | string | no | Specifies whether to obtain the listening port of the load balancing instance through the X-Forwarded-Port header field | | EnableXForwardedForProto | string | no | Specifies whether to obtain the listening protocol of the load balancing instance through the X-Forwarded-Proto header field | | EnableXForwardedForSlbId | string | no | Specifies whether to obtain the load balancing instance ID through the SLB-ID header field | | EnableXForwardedForSlbPort | string | no | Specifies whether to obtain the listening port of the load balancing instance through the X-Forwarded-Port header field | | AddressType | string | no | The address type. Valid values: Internet: public network address. Intranet: private network address | | LoadBalancerEdition | string | no | The edition of the Application Load Balancer (ALB). Different editions have different feature limits and billing policy. Valid values:… | | ZoneMappings | string | no | The JSON string of the zone and vSwitch mapping list. If the current region supports two or more zones, you must add at least two zones. A… | | CorsConfig | string | no | The cross-origin resource sharing (CORS) configuration | | EnableGzip | string | no | Specifies whether to enable data compression | ### Creates a job template `POST https://www.apizie.tech/v1/cloud:aliyun-sae/create-job` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | AppName | string | yes | The name of the job template. The name can contain digits, letters, and hyphens (-). It must start with a letter and can be up to 36… | | NamespaceId | string | no | The ID of the Serverless App Engine (SAE) namespace. Only namespaces whose names contain lowercase letters and hyphens (-) are supported.… | | AppDescription | string | no | The description of the job template. The description can be up to 1,024 characters in length | | VpcId | string | no | The ID of the virtual private cloud (VPC) that is associated with the SAE namespace. In SAE, a namespace can be associated with only one… | | VSwitchId | string | no | The ID of the vSwitch to which the elastic network interface controller (NIC) of the job instance belongs. The vSwitch must reside in the… | | PackageType | string | yes | The type of the job package. Valid values: If you use Java for deployment, valid values are FatJar, War, and Image. If you use PHP for… | | PackageVersion | string | no | The version of the deployment package. This parameter is required when PackageType is set to FatJar, War, or PythonZip | | PackageUrl | string | no | The URL of the deployment package. This parameter is required when PackageType is set to FatJar, War, or PythonZip | | ImageUrl | string | no | The image address. This parameter is required when PackageType is set to Image | | Jdk | string | no | The Java Development Kit (JDK) version on which the deployment package depends. Valid values: Open JDK 8 Open JDK 7 Dragonwell 11… | | WebContainer | string | no | The Tomcat version on which the deployment package depends. Valid values: apache-tomcat-7.0.91 apache-tomcat-8.5.42 This parameter is not… | | Cpu | integer | no | The number of CPU cores required for each instance. Unit: millicores. The value cannot be 0. Only the following defined specifications are… | | Memory | integer | no | The memory size required for each instance. Unit: MB. The value cannot be 0. The memory size has a one-to-one mapping with the number of… | | Replicas | integer | yes | The number of concurrent instances for the job | | Command | string | no | The startup command of the image. The command must be an executable object that exists in the container. Example: ``` command: - echo -… | | CommandArgs | string | no | The arguments for the image startup command. These are the arguments required by the Command parameter. Format: `["a","b"]` In the… | | Envs | string | no | The environment variables for the container. You can customize environment variables or reference ConfigMaps. To reference a ConfigMap,… | | CustomHostAlias | string | no | The custom host mapping in the container. Valid values: hostName: the domain name or hostname. ip: the IP address | | JarStartOptions | string | no | The startup options for the JAR package. Default job startup command: `$JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS… | | JarStartArgs | string | no | The startup arguments for the JAR package. Default job startup command: `$JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS… | | EdasContainerVersion | string | no | The runtime environment version of the job in the High-Speed Service Framework (HSF), such as the Ali-Tomcat container | | Timezone | string | no | The time zone. Default value: Asia/Shanghai | | SlsConfigs | string | no | The configuration for collecting logs to Simple Log Service (SLS). To use SLS resources automatically created by SAE:… | | NasId | string | no | The ID of the Apsara File Storage NAS file system. If the configuration remains unchanged during deployment, you do not need to set this… | | MountHost | string | no | The mount target of the NAS file system in the VPC of the job template. If the configuration remains unchanged during deployment, you do… | | MountDesc | string | no | The description of the NAS mount. If the configuration remains unchanged during deployment, you do not need to set this parameter, which… | | PreStop | string | no | The script to execute before the container stops. A script is triggered and executed before the container is deleted. Format:… | | PostStart | string | no | The script to execute after the container starts. A script is triggered and executed immediately after the container is created. Format:… | | WarStartOptions | string | no | The startup command for the WAR package deployment job. The procedure is the same as configuring the startup command for image deployment.… | | ConfigMapMountDesc | string | no | The mount description of the ConfigMap. Uses the configuration items created on the namespace configuration item page to inject… | | SecurityGroupId | string | no | The ID of the security group | | AutoConfig | string | no | Specifies whether to automatically configure the network environment. Valid values: true: SAE automatically configures the network… | | TerminationGracePeriodSeconds | integer | no | The timeout period for graceful shutdown. Default value: 30. Unit: seconds. Valid values: 1 to 300 | | PhpConfigLocation | string | no | The mount path for the PHP job startup configuration. You must ensure that the PHP server uses this configuration file to start | | PhpConfig | string | no | The content of the PHP configuration file | | TomcatConfig | string | no | The Tomcat configuration. Set the value to "" or "{}" to delete the configuration. Valid values: port: the port range is 1024 to 65535.… | | OssMountDescs | string | no | The OSS mount description. The parameter descriptions are as follows: bucketName: the name of the bucket. bucketPath: the folder or object… | | OssAkId | string | no | The AccessKey ID used to read and write OSS data | | OssAkSecret | string | no | The AccessKey Secret used to read and write OSS data | | AcrInstanceId | string | no | The instance ID of the ACR Enterprise instance. This parameter is required when ImageUrl is set to an ACR Enterprise instance image | | AcrAssumeRoleArn | string | no | The Alibaba Cloud Resource Name (ARN) of the Resource Access Management (RAM) role required to pull images across accounts. For more… | | ImagePullSecrets | string | no | The ID of the secret | | EnableImageAccl | string | no | Specifies whether to enable image acceleration. Valid values: true: enabled. false: disabled | | Workload | string | yes | The workload type. Set the value to `job` | | TriggerConfig | string | no | The trigger configuration of the job. Configure this parameter based on the job type. Scheduled job: set the type field to time, the… | | ConcurrencyPolicy | string | no | The concurrency policy of the job. Valid values: Forbid: forbids concurrent execution. A new job is not created if the previous job is not… | | Timeout | integer | no | The timeout period of the job. Unit: seconds | | BackoffLimit | integer | no | The number of retries for the job | | Slice | string | no | Specifies whether to enable job sharding | | SliceEnvs | string | no | The sharding parameters of the job | | RefAppId | string | no | The ID of the referenced job target | | ProgrammingLanguage | string | no | The programming language. Valid values: java, php, python, and shell | | Python | string | no | The Python environment. Valid value: PYTHON 3.9.15 | | PythonModules | string | no | The module dependencies for custom installation. By default, the dependencies defined in the requirements.txt file in the root folder are… | | NasConfigs | string | no | The configuration for mounting the NAS file system | | BestEffortType | string | no | The BestEffort policy | ### Creates a namespace `POST https://www.apizie.tech/v1/cloud:aliyun-sae/create-namespace` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | NamespaceId | string | no | The long-format namespace ID. If you specify this parameter, NameSpaceShortId is ignored. This parameter is retained for compatibility.… | | NamespaceName | string | yes | The name of the namespace. The name cannot exceed 64 characters in length | | NamespaceDescription | string | no | The description of the namespace. The description cannot exceed 100 characters in length | | NameSpaceShortId | string | no | The short-format namespace ID. You do not need to specify a region ID. This parameter is recommended. The ID cannot exceed 20 characters… | | EnableMicroRegistration | string | no | Specifies whether to enable the built-in service registry of SAE. true false The default value is true. If you do not use the built-in… | ### Creates or updates a traffic lane `POST https://www.apizie.tech/v1/cloud:aliyun-sae/create-or-update-swimming-lane` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | LaneId | integer | no | The ID of the traffic lane | | LaneName | string | no | The name of the traffic lane | | LaneTag | string | no | The tag of the traffic lane | | GroupId | integer | no | The ID of the traffic lane group to which the traffic lane belongs | | NamespaceId | string | no | The ID of the namespace | | CanaryModel | integer | no | The end-to-end canary release mode. Valid values: 0: Routes traffic based on request content. 1: Routes traffic based on proportion | | Enable | string | no | Specifies whether the traffic lane is enabled. Valid values: true: Enabled. false: Disabled | | AppEntryRule | string | no | The gateway routing configuration. This parameter is required when the gateway entry of the traffic lane group is Java (JSON-encoded) | | MseGatewayEntryRule | string | no | The MSE gateway routing configuration. This parameter is required when EntryAppType is set to apig or mse-gw (JSON-encoded) | ### Creates or updates a traffic lane group `POST https://www.apizie.tech/v1/cloud:aliyun-sae/create-or-update-swimming-lane-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | GroupId | integer | no | The ID of the traffic lane group. Required when updating a traffic lane group | | GroupName | string | no | The name of the traffic lane group | | NamespaceId | string | no | The namespace ID | | AppIds | string | no | The IDs of the baseline applications (JSON-encoded) | | EntryAppType | string | no | The application entry type (gateway type). Valid values: apig: Cloud-native API gateway. mse: Java service gateway. mse-gw: MSE… | | EntryAppId | string | no | The unique ID of the corresponding gateway | | SwimVersion | string | no | The end-to-end canary release version. Valid values: 0 and 2 (recommended) | ### Creates a Secret instance in a namespace `POST https://www.apizie.tech/v1/cloud:aliyun-sae/create-secret` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | NamespaceId | string | yes | The ID of the namespace where the Secret instance resides. If the namespace is the default namespace, you only need to specify RegionId,… | | SecretName | string | yes | The name of the Secret instance. The name can contain digits, letters, and underscores (_), and must start with a letter | | SecretType | string | yes | The type of the Secret instance. Valid values: kubernetes.io/dockerconfigjson: stores the username and password of an image repository. It… | | SecretData | string | yes | The data of the Secret (JSON-encoded) | ### Create a web application `POST https://www.apizie.tech/v1/cloud:aliyun-sae/create-web-application` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | NamespaceId | string | yes | The namespace ID | | ApplicationName | string | yes | The name of the application | | Description | string | no | The description of the application | | RevisionConfig | object | yes | The configuration on the application revision | | WebNetworkConfig | object | no | The network configurations. This field is used to configure network for the application | | WebScalingConfig | object | no | The scaling configurations of the applications | | WebTrafficConfig | object | no | The traffic configurations of the applications | ### Create a custom domain name for the web application `POST https://www.apizie.tech/v1/cloud:aliyun-sae/create-web-custom-domain` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | NamespaceId | string | yes | The namespace ID | | DefaultForwardingAppName | string | no | The name of the application to which data is forwarded by the domain name by default | | DomainName | string | yes | The domain name. Enter a custom domain name that has obtained an Internet content provider (ICP) filing in the Alibaba Cloud ICP Filing… | | Protocol | string | no | The protocol type that is supported by the custom domain name. Valid values: HTTP: Only HTTP is supported. HTTPS: Only HTTPS is supported.… | | RouteConfig | object | no | The route configurations | | WebCertConfig | object | no | The information about the HTTPS certificate | | WebTLSConfig | object | no | The Transport Layer Security (TLS) configurations | | WebWAFConfig | object | no | The Web Application Firewall (WAF) configurations | ### Deletes an application `POST https://www.apizie.tech/v1/cloud:aliyun-sae/delete-application` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | AppId | string | yes | The ID of the application | ### Deletes an application auto scaling policy by calling the CreateApplicationScalingRule operation `POST https://www.apizie.tech/v1/cloud:aliyun-sae/delete-application-scaling-rule` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | AppId | string | yes | The application ID | | ScalingRuleName | string | yes | The name of the auto scaling policy | ### Deletes a ConfigMap instance `POST https://www.apizie.tech/v1/cloud:aliyun-sae/delete-config-map` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | ConfigMapId | integer | yes | The ID of the ConfigMap instance to delete. You can call the https://help.aliyun.com/document_detail/176917.html operation to obtain the ID | ### Deletes a grey tag route by the specified rule ID `POST https://www.apizie.tech/v1/cloud:aliyun-sae/delete-grey-tag-route` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | GreyTagRouteId | integer | yes | The rule ID | ### Deletes a job `POST https://www.apizie.tech/v1/cloud:aliyun-sae/delete-history-job` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | AppId | string | yes | The ID of the job template to delete | | JobId | string | yes | The job ID | ### Deletes an ingress instance `POST https://www.apizie.tech/v1/cloud:aliyun-sae/delete-ingress` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | IngressId | integer | yes | The ID of the ingress rule to delete. You can obtain the ID by calling the https://help.aliyun.com/document_detail/153934.html operation | ### Deletes application instances `POST https://www.apizie.tech/v1/cloud:aliyun-sae/delete-instances` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | AppId | string | yes | The application ID | | InstanceIds | string | yes | The instance IDs to be deleted | ### Deletes a task template `POST https://www.apizie.tech/v1/cloud:aliyun-sae/delete-job` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | AppId | string | yes | The ID of the task template to delete | ### Deletes a namespace `POST https://www.apizie.tech/v1/cloud:aliyun-sae/delete-namespace` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | NamespaceId | string | no | The long namespace ID. If specified, this parameter takes precedence and NameSpaceShortId is ignored. This parameter is retained for… | | NameSpaceShortId | string | no | The short namespace ID. This ID does not require a region prefix. Use this parameter | ### Deletes a secret instance `POST https://www.apizie.tech/v1/cloud:aliyun-sae/delete-secret` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | NamespaceId | string | yes | The ID of the namespace to which the secret instance belongs. If the namespace is the default namespace, you only need to specify… | | SecretId | integer | yes | Instance ID of the secret instance to be deleted. You can call the https://help.aliyun.com/document_detail/466929.html operation to query… | ### Deletes a lane group `POST https://www.apizie.tech/v1/cloud:aliyun-sae/delete-swimming-lane-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | NamespaceId | string | no | The namespace ID | | GroupId | integer | no | The lane group ID | ### Delete a web application `POST https://www.apizie.tech/v1/cloud:aliyun-sae/delete-web-application` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | NamespaceId | string | yes | The namespace ID | | ApplicationId | string | yes | The application ID | ### Delete a web application version `POST https://www.apizie.tech/v1/cloud:aliyun-sae/delete-web-application-revision` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | NamespaceId | string | yes | The namespace ID | | ApplicationId | string | yes | The application ID | | RevisionId | string | yes | The revision ID | ### Delete a custom domain name `POST https://www.apizie.tech/v1/cloud:aliyun-sae/delete-web-custom-domain` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | NamespaceId | string | yes | The namespace ID | | DomainName | string | yes | The custom domain name | ### Deploys an application `POST https://www.apizie.tech/v1/cloud:aliyun-sae/deploy-application` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | AppId | string | yes | The ID of the application to be deployed | | Jdk | string | no | The JDK version required by the deployment package. Valid values: Open JDK 8 Open JDK 7 Dragonwell 11 Dragonwell 8… | | WebContainer | string | no | The Tomcat version required by the deployment package. Valid values: apache-tomcat-7.0.91 apache-tomcat-8.5.42 This parameter is not… | | PackageVersion | string | no | The version number of the deployment package. This parameter is required when Package Type is set to FatJar, War, or PythonZip | | PackageUrl | string | no | The URL of the deployment package. This parameter is required when Package Type is set to FatJar, War, or PythonZip | | ImageUrl | string | no | The URL of the image. This parameter is required when Package Type is set to Image | | Command | string | no | The startup command of the image. The command must be an executable object that exists in the container. Example: ``` command: - echo -… | | CommandArgs | string | no | The arguments for the image startup command. These are the arguments required by the Command startup command. Format: `["a","b"]` In the… | | Envs | string | no | The environment variables for the container. You can specify custom environment variables or reference ConfigMaps. To reference a… | | CustomHostAlias | string | no | The custom host mappings in the container. Valid values: hostName: the domain name or hostname. ip: the IP address | | JarStartOptions | string | no | The startup options for the JAR package. Default startup command: `$JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS… | | JarStartArgs | string | no | The startup arguments for the JAR package. Default startup command: `$JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS… | | Liveness | string | no | The liveness probe for the container. Containers that fail the health check are shutdown and recovered. Valid values: exec: Example:… | | Readiness | string | no | The readiness probe for the application. Containers that fail multiple health checks are stopped and restarted. Traffic from the SLB… | | MinReadyInstances | integer | no | The minimum number of ready instances. Valid values: If you set this parameter to 0, services are interrupted during the application… | | MinReadyInstanceRatio | integer | no | The percentage of the minimum number of ready instances. Valid values: -1: the initial value, which indicates that the percentage is not… | | BatchWaitTime | integer | no | The interval between deployment batches. Unit: seconds | | EdasContainerVersion | string | no | The version of the application runtime environment in the HSF framework, such as the Ali-Tomcat container | | UpdateStrategy | string | no | The deployment policy. When the minimum number of ready instances is 1, the value of the UpdateStrategy field is "". When the minimum… | | SlsConfigs | string | no | The Settings for collecting logs to Simple Log Service (SLS). Use SLS resources automatically created by SAE:… | | Timezone | string | no | The time zone. Default value: Asia/Shanghai | | NasId | string | no | This field is not recommended. Configure NasConfigs instead. The ID of the NAS file system. If the configurations remain unchanged during… | | MountHost | string | no | This field is not recommended. Configure NasConfigs instead. The mount target of the NAS file system in the VPC of the application. If the… | | MountDesc | string | no | This field is not recommended. Configure NasConfigs instead. The description of the NAS mount. If the configurations remain unchanged… | | PostStart | string | no | The script to execute after the container starts. A script is triggered immediately after the container is created. Format:… | | PreStop | string | no | The script to execute before the container stops. A script is triggered before the container is deleted. Format:… | | ChangeOrderDesc | string | no | The description of the change order | | WarStartOptions | string | no | The startup command for the application deployed by using a WAR package. The procedure is the same as that for configuring the startup… | | AutoEnableApplicationScalingRule | string | no | Specifies whether the elastic scaling policy for the application is automatically enabled. Valid values: true: enables the policy. false:… | | ConfigMapMountDesc | string | no | The mount description of the ConfigMap. Uses the configuration item created on the configuration item page of the namespace to inject… | | TerminationGracePeriodSeconds | integer | no | The timeout period for graceful shutdown. Default value: 30. Unit: seconds. Valid values: 1 to 300 | | EnableAhas | string | no | Specifies whether to connect to AHAS. Valid values: true: connects to AHAS. false: does not connect to AHAS | | PhpArmsConfigLocation | string | no | The mount path for PHP application monitoring. You must ensure that the PHP server loads the configuration file in this path. You do not… | | PhpConfigLocation | string | no | The mount path for the PHP application startup configuration. You must ensure that the PHP server uses this configuration file to start | | PhpConfig | string | no | The content of the PHP configuration file | | TomcatConfig | string | no | The Tomcat file configuration. Set the value to "" or "{}" to delete the configuration. Valid values: port: the port range is 1024 to… | | OssMountDescs | string | no | The OSS mount description. Parameter description: bucketName: the name of the bucket. bucketPath: the folder or object that you created in… | | OssAkId | string | no | The AccessKey ID used to read and write OSS data | | OssAkSecret | string | no | The AccessKey Secret used to read and write OSS data | | EnableGreyTagRoute | string | no | Specifies whether to enable the canary release rules for traffic. This rule applies only to applications that use the Spring Cloud and… | | Php | string | no | The PHP version required by the PHP deployment package. Images are not supported | | AcrInstanceId | string | no | The ACR Enterprise instance ID. This parameter is required when ImageUrl is set to an ACR Enterprise instance image | | AcrAssumeRoleArn | string | no | The ARN of the RAM role required to pull images across accounts. For more information, see… | | ImagePullSecrets | string | no | The ID of the corresponding secret | | AssociateEip | string | no | Specifies whether to associate an elastic IP address (EIP). Valid values: true: associates an EIP. false: does not associate an EIP | | KafkaConfigs | string | no | The summary of configurations for collecting logs to Kafka. Valid values: kafkaEndpoint: the service registration address of the Kafka… | | PvtzDiscoverySvc | string | no | Enables service registration and discovery for Kubernetes Services. Valid values: portProtocols: the port and protocol. Valid values for… | | SwimlanePvtzDiscoverySvc | string | no | Configures service registration and discovery and end-to-end canary release based on Kubernetes Services: enable: specifies whether to… | | MicroRegistration | string | no | The Nacos registry. Valid values: 0: the built-in Nacos of SAE. 1: a self-managed Nacos. 2: Microservices Engine (MSE) Nacos Commercial… | | MicroRegistrationConfig | string | no | The registry configurations. This parameter takes effect only when the registry type is MSE Nacos Enterprise Edition | | NasConfigs | string | no | The configurations for mounting a NAS file system. Valid values: mountPath: the mount path in the container. readOnly: A value of false… | | Python | string | no | The Python environment. PYTHON 3.9.15 is supported | | PythonModules | string | no | The custom installation module dependencies. By default, the dependencies defined in the requirements.txt file in the root folder are… | | Dotnet | string | no | The version of the .NET framework. Valid values: .NET 3.1 .NET 5.0 .NET 6.0 .NET 7.0 .NET 8.0 | | Deploy | string | no | This parameter takes effect only for applications in the stopped state. If a running application calls the DeployApplication operation,… | | PackageType | string | no | The type of the application package. Valid values: If you use Java for deployment, valid values are FatJar, War, and Image. If you use PHP… | | Cpu | integer | no | The CPU required for each instance. Unit: millicores. The value cannot be 0. Only the following defined specifications are supported: 500… | | Memory | integer | no | The memory required for each instance. Unit: MB. The value cannot be 0. The memory has a one-to-one mapping with the CPU. Only the… | | Replicas | integer | no | The number of instances | | SecurityGroupId | string | no | The ID of the security group | | VSwitchId | string | no | The vSwitch where the network interface controller (NIC) of the application instance resides. The vSwitch must be located in the preceding… | | ServiceTags | string | no | The canary tags configured for the application | | EnableNewArms | string | no | Specifies whether to enable the new ARMS features. Valid values: true: enables the features. false: disables the features | | EnableCpuBurst | string | no | Specifies whether to enable the CPU Burst feature. Valid values: true: enables the feature. false: disables the feature | | OidcRoleName | string | no | The RAM role for the identity authentication service. You must create an OIDC identity provider and an identity provider role in the same… | | SidecarContainersConfig | string | no | The container configuration information (JSON-encoded) | | SecretMountDesc | string | no | The mount description of the Secret. Uses the secret created on the Secret page of the namespace to inject confidential information into… | | EnableSidecarResourceIsolated | string | no | Specifies whether to enable sidecar resource isolation. Valid values: true: enables isolation. false: disables isolation | | CustomImageNetworkType | string | no | The custom image network type. If the image is not a custom image, set this parameter to an empty string. Valid values: internet: public… | | MicroserviceEngineConfig | string | no | Configures microservice governance features. enable: Specifies whether to enable microservice governance. Valid values: true: Enabled.… | | NewSaeVersion | string | no | The application edition. Valid values: lite: Lite Edition. std: Standard Edition. pro: Professional Edition | | InitContainersConfig | string | no | The init container configuration (JSON-encoded) | | GpuConfig | string | no | The GPU configuration | | StartupProbe | string | no | Enables application startup probing. Check succeeded: indicates that the application is started. If you configure liveness and readiness… | | EnablePrometheus | string | no | Specifies whether to enable Prometheus custom metric collection | | Html | string | no | The NGINX version. Valid values: nginx 1.20 nginx 1.22 nginx 1.24 nginx 1.26 nginx 1.28 | | EmptyDirDesc | string | no | The shared ephemeral storage configuration | | AlbIngressReadinessGate | string | no | The Application Load Balancer (ALB) gateway readiness gate configuration | | MaxSurgeInstances | integer | no | The maximum number of surge instances. Note the following rules: If the minimum number of available instances is 100%, the Peak Volume… | | MaxSurgeInstanceRatio | integer | no | The maximum surge instance ratio. Note the following rules: If the minimum number of available instances is 100%, the Peak Volume Settings… | | AgentVersion | string | no | The AliyunAgent version | | EnableNamespaceAgentVersion | string | no | Specifies whether to reuse the agent version configuration of the namespace | | SlsLogEnvTags | string | no | sls log tags | | LokiConfigs | string | no | LokiConfigs | | Labels | string | no | The application labels. Both keys and values are strings (JSON-encoded) | | RaspConfig | string | no | The application runtime security protection (RASP) configuration (JSON-encoded) | ### Describes the metadata details of an application service `GET https://www.apizie.tech/v1/cloud:aliyun-sae/describe-app-service-detail` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | AppId | string | yes | The application ID | | ServiceType | string | no | The service type. Valid values: dubbo springCloud | | ServiceGroup | string | no | The service group. This is a custom parameter | | ServiceVersion | string | no | The service version. This is a custom parameter | | ServiceName | string | no | The service name | | NacosInstanceId | string | no | The ID of the MSE Nacos instance | | NacosNamespaceId | string | no | The ID of the MSE Nacos namespace | ### Retrieves the application configuration information `GET https://www.apizie.tech/v1/cloud:aliyun-sae/describe-application-config` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | AppId | string | yes | The application ID | | VersionId | string | no | The version ID | ### Queries application instance groups `GET https://www.apizie.tech/v1/cloud:aliyun-sae/describe-application-groups` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | AppId | string | yes | The application ID | | CurrentPage | integer | no | The page number | | PageSize | integer | no | The page size | ### Retrieves information about an application image `GET https://www.apizie.tech/v1/cloud:aliyun-sae/describe-application-image` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | AppId | string | yes | The application ID | | ImageUrl | string | yes | The image URL | ### Retrieves a list of application instances `GET https://www.apizie.tech/v1/cloud:aliyun-sae/describe-application-instances` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | AppId | string | yes | The application ID | | GroupId | string | yes | The application group ID. You can call the https://help.aliyun.com/document_detail/126249.html operation to obtain the ID | | CurrentPage | integer | no | The current page number | | PageSize | integer | no | The paging Settings for the number of entries per page in a paged query. Default value: 10. Valid values: (0, 1000000000) | | Reverse | string | no | Specifies the sorting order of application instances based on their running status. If the status is the same, the instances are sorted by… | | InstanceId | string | no | The application instance ID | | PipelineId | string | no | The batch ID. You can call the https://help.aliyun.com/document_detail/126617.html operation to obtain the ID | ### Queries the Microservices Engine (MSE) microservice governance application information associated with an… `GET https://www.apizie.tech/v1/cloud:aliyun-sae/describe-application-mse-service` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | AppId | string | yes | The application ID | | EnableAhas | string | yes | Specifies whether the throttling and degradation feature is enabled. Set this parameter to true when you call API operations related to… | ### Queries the Network Load Balancer (NLB) configurations bound to an application `GET https://www.apizie.tech/v1/cloud:aliyun-sae/describe-application-nlbs` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | AppId | string | no | The application ID | ### Describes a single auto scaling policy for an application `GET https://www.apizie.tech/v1/cloud:aliyun-sae/describe-application-scaling-rule` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | AppId | string | yes | The application ID | | ScalingRuleName | string | yes | The name of the auto scaling policy | ### Describes the Auto Scaling policies for an application `GET https://www.apizie.tech/v1/cloud:aliyun-sae/describe-application-scaling-rules` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | AppId | string | yes | The application ID | ### Retrieves the Server Load Balancer (SLB) configuration of an application `GET https://www.apizie.tech/v1/cloud:aliyun-sae/describe-application-slbs` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | AppId | string | yes | The ID of the target application | ### Queries the status information of an application `GET https://www.apizie.tech/v1/cloud:aliyun-sae/describe-application-status` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | AppId | string | yes | The ID of the target application | ### Call DescribeChangeOrder to get information about a change order `GET https://www.apizie.tech/v1/cloud:aliyun-sae/describe-change-order` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | ChangeOrderId | string | yes | The change order ID. You can obtain it by calling the https://help.aliyun.com/document_detail/126615.html interface | ### Call the DescribeComponents API to retrieve the component versions required to create an application… `GET https://www.apizie.tech/v1/cloud:aliyun-sae/describe-components` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | AppId | string | no | The application ID | | Type | string | yes | The supported component type. Valid values: TOMCAT JDK | ### Queries the details of a ConfigMap instance `GET https://www.apizie.tech/v1/cloud:aliyun-sae/describe-config-map` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | ConfigMapId | integer | yes | The ID of the ConfigMap. You can call the https://help.aliyun.com/document_detail/176917.html operation to obtain the ID | ### Queries the price of a configuration `GET https://www.apizie.tech/v1/cloud:aliyun-sae/describe-configuration-price` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | Cpu | integer | yes | The number of CPU cores required for each instance. Unit: millicores. This value cannot be 0. Only the following defined specifications… | | Memory | integer | yes | The amount of memory required for each instance. Unit: MB. This value cannot be 0. The memory size must correspond to the CPU… | | Workload | string | no | The application scenario. Valid values: web micro_service | | ResourceType | string | no | The resource type. Valid values: NULL (default), default, and haiguang (Haiguang server) | | NewSaeVersion | string | no | The application version. Valid values: lite: Lightweight Edition std: Standard Edition pro: Professional Edition | | BestEffortType | string | no | The BestEffort policy. Valid values: besteffort: BestEffort try-besteffort: BestEffort preferred default: default | | GpuA10 | string | no | The GpuA10 | | GpuPpu810e | string | no | The GpuPpu810e | ### Retrieves the microservice container components for an application `GET https://www.apizie.tech/v1/cloud:aliyun-sae/describe-edas-containers` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | ### Gets a canary release rule by rule ID `GET https://www.apizie.tech/v1/cloud:aliyun-sae/describe-grey-tag-route` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | GreyTagRouteId | integer | yes | The ID of the rule | ### Queries the details of an Ingress `GET https://www.apizie.tech/v1/cloud:aliyun-sae/describe-ingress` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | IngressId | integer | yes | The ID of the routing rule. Call the https://help.aliyun.com/document_detail/2834910.html operation to obtain this ID | ### Retrieves the log of an instance `GET https://www.apizie.tech/v1/cloud:aliyun-sae/describe-instance-log` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | InstanceId | string | yes | The instance ID | | ContainerId | string | no | The ID of the sidecar container. Call the https://help.aliyun.com/document_detail/2834847.html operation to obtain this ID | | Previous | string | no | Specifies whether to view the log of the instance from before its last restart. Note: This parameter is active only if the instance was… | ### Retrieves a list of available application instance specifications `GET https://www.apizie.tech/v1/cloud:aliyun-sae/describe-instance-specifications` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | ### Retrieves the configuration information of a job template `GET https://www.apizie.tech/v1/cloud:aliyun-sae/describe-job` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | AppId | string | yes | The ID of the job template | | JobId | string | no | The ID of the job | ### Queries job history records `GET https://www.apizie.tech/v1/cloud:aliyun-sae/describe-job-history` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | AppId | string | yes | The ID of the job template | | CurrentPage | integer | no | The current page number | | PageSize | integer | no | The number of entries per page in the paging Settings for a paged query. Valid values: 0 to 10000 | | State | string | no | The running status of the job. Valid values: 0: Not run. 1: Succeeded. 2: Failed. 3: Running | ### Queries the status of a job `GET https://www.apizie.tech/v1/cloud:aliyun-sae/describe-job-status` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | AppId | string | yes | The ID of the job template | | JobId | string | no | The ID of the job | ### Queries the details of a namespace `GET https://www.apizie.tech/v1/cloud:aliyun-sae/describe-namespace` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | NamespaceId | string | no | The ID of the namespace. The information about the default namespace cannot be queried or modified. The default namespace cannot be deleted | | NameSpaceShortId | string | no | The short ID of the namespace. You do not need to specify a region ID. The value of this parameter can be up to 20 characters in length… | ### Queries a list of namespaces `GET https://www.apizie.tech/v1/cloud:aliyun-sae/describe-namespace-list` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | ContainCustom | string | no | Specifies whether to return custom namespaces. Valid values: true: The system returns custom namespaces. false: The system does not return… | | HybridCloudExclude | string | no | Indicates whether hybrid cloud namespaces are excluded. Valid values: true: Hybrid cloud namespaces are excluded. false: Hybrid cloud… | ### Queries the resource information in a namespace `GET https://www.apizie.tech/v1/cloud:aliyun-sae/describe-namespace-resources` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | NamespaceId | string | no | The long namespace ID. If this parameter is specified, it takes effect and NameSpaceShortId is ignored. This parameter is retained for… | | NameSpaceShortId | string | no | The short namespace ID. The region ID is not required. This parameter is recommended | ### Queries a list of namespaces `GET https://www.apizie.tech/v1/cloud:aliyun-sae/describe-namespaces` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | CurrentPage | integer | yes | The current page number | | PageSize | integer | yes | The number of entries per page. Valid values: 0 to 10000 | ### Queries batch information `GET https://www.apizie.tech/v1/cloud:aliyun-sae/describe-pipeline` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | PipelineId | string | yes | The batch ID. You can retrieve the ID by calling the https://help.aliyun.com/document_detail/126617.html operation | ### Queries the available regions `GET https://www.apizie.tech/v1/cloud:aliyun-sae/describe-regions` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | ### Queries the details of a Secret instance `GET https://www.apizie.tech/v1/cloud:aliyun-sae/describe-secret` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | NamespaceId | string | yes | The ID of the namespace to which the Secret instance belongs. If the namespace is the default namespace, specify only the RegionId, such… | | SecretId | integer | yes | Instance ID of the Secret instance to query. You can call the https://help.aliyun.com/document_detail/466929.html operation to obtain… | ### Queries the details of a traffic lane `GET https://www.apizie.tech/v1/cloud:aliyun-sae/describe-swimming-lane` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | NamespaceId | string | no | The namespace ID | | GroupId | integer | no | The traffic lane group ID | | LaneId | integer | no | The traffic lane ID | ### DescribeVSwitches `GET https://www.apizie.tech/v1/cloud:aliyun-sae/describe-vswitches` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | VpcId | string | yes | The VpcId | | VSwitchId | string | no | The VSwitchId | | VSwitchName | string | no | The VSwitchName | ### Query web applications `GET https://www.apizie.tech/v1/cloud:aliyun-sae/describe-web-application` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | NamespaceId | string | yes | The namespace ID | | ApplicationId | string | yes | The application ID | ### Query the resource usage of a web application `GET https://www.apizie.tech/v1/cloud:aliyun-sae/describe-web-application-resource-statics` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | NamespaceId | string | yes | The namespace ID | | ApplicationId | string | yes | The application ID | | RegionId | string | no | The region ID | | StartTime | integer | no | The time when the task was created | | EndTime | integer | no | The end of the time range during which data was queried | ### Describe a web application version `GET https://www.apizie.tech/v1/cloud:aliyun-sae/describe-web-application-revision` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | NamespaceId | string | yes | The namespace ID | | ApplicationId | string | yes | The application ID | | RevisionId | string | yes | The revision ID | ### Describe the scaling configuration of a web application `GET https://www.apizie.tech/v1/cloud:aliyun-sae/describe-web-application-scaling-config` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | NamespaceId | string | yes | The namespace ID | | ApplicationId | string | yes | The application ID | ### Query the traffic configurations of a web application `GET https://www.apizie.tech/v1/cloud:aliyun-sae/describe-web-application-traffic-config` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | NamespaceId | string | yes | The namespace ID | | ApplicationId | string | yes | The application ID | ### Query the details of a custom domain name for a web application `GET https://www.apizie.tech/v1/cloud:aliyun-sae/describe-web-custom-domain` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | NamespaceId | string | yes | The namespace ID | | DomainName | string | yes | The custom domain name | ### Obtain the logs of web application instances `GET https://www.apizie.tech/v1/cloud:aliyun-sae/describe-web-instance-logs` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | NamespaceId | string | yes | The namespace ID | | ApplicationId | string | yes | The application ID | | InstanceId | string | yes | The ID of the application instance | ### Invokes the DisableApplicationScalingRule API operation to disable an application elastic scaling policy `POST https://www.apizie.tech/v1/cloud:aliyun-sae/disable-application-scaling-rule` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | AppId | string | yes | The application ID | | ScalingRuleName | string | yes | The elastic scaling policy name | ### Disables ARMS monitoring `POST https://www.apizie.tech/v1/cloud:aliyun-sae/disable-arms` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | AppId | string | yes | The application ID | ### Disables ARMS Premium Edition monitoring `POST https://www.apizie.tech/v1/cloud:aliyun-sae/downgrade-application-apm-service` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | AppId | string | yes | The application ID | ### Enables an elastic scaling policy for an application `POST https://www.apizie.tech/v1/cloud:aliyun-sae/enable-application-scaling-rule` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | AppId | string | yes | The application ID | | ScalingRuleName | string | yes | The elastic scaling policy name. An elastic policy has been created for this application | ### Executes a job `GET https://www.apizie.tech/v1/cloud:aliyun-sae/exec-job` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | AppId | string | yes | The ID of the job template | | EventId | string | no | The event ID. This parameter is user-defined and used for idempotence. Only one job is created for the same event ID | | Command | string | no | The image startup command. The command must be an executable object that exists in the container. Example: ``` command: - echo - abc - > -… | | CommandArgs | string | no | The arguments for the image startup command, which are required by the Command parameter. Format: `["a","b"]` In the preceding example,… | | Envs | string | no | The environment variables of the container. You can customize environment variables or reference configuration items. To reference a… | | JarStartOptions | string | no | The startup options for the JAR package job. The default startup command for the job is: `$JAVA_HOME/bin/java $JarStartOptions -jar… | | JarStartArgs | string | no | The startup arguments for the JAR package job. The default startup command for the job is: `$JAVA_HOME/bin/java $JarStartOptions -jar… | | WarStartOptions | string | no | The startup command for the WAR package deployment job. The procedure is the same as configuring the startup command for image deployment.… | | Time | string | no | The trigger time of the job. Format: `yyyy-MM-dd'T'HH:mm:ss'Z'` | | Replicas | string | no | The number of concurrent instances for the job | ### Retrieves basic information about an application `GET https://www.apizie.tech/v1/cloud:aliyun-sae/get-application` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | AppId | string | no | The ID of the application | | AppName | string | no | The name of the application | | NamespaceId | string | no | The ID of the namespace | ### Queries the top N applications in Application Monitoring `GET https://www.apizie.tech/v1/cloud:aliyun-sae/get-arms-top-nmetric` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | RegionId | string | yes | The field based on which you want to sort the returned entries | | OrderBy | string | yes | The number of entries to return. Valid values: 0 to 100 | | Limit | integer | yes | The beginning of the time range to query | | StartTime | integer | yes | The end of the time range to query | | EndTime | integer | yes | The SAE application type. Valid values: micro_service web job | | AppSource | string | no | The CPU allocation policy. Valid values: request: CPU cores are allocated only when a request is initiated. always: Fixed CPU cores are… | | CpuStrategy | string | no | The additional information that is returned. The following limits are imposed on the ID: success: If the call is successful, success is… | ### Queries the top N applications in which abnormal instances exist. The applications are sorted by the total… `GET https://www.apizie.tech/v1/cloud:aliyun-sae/get-availability-metric` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The region ID | | Limit | integer | yes | The number of entries to return. Valid values: 0 to 100 | | AppSource | string | no | The SAE application type. Valid values: micro_service web job | | CpuStrategy | string | no | The CPU allocation policy. Valid values: request: CPU cores are allocated only when a request is initiated. always: Fixed CPU cores are… | ### Retrieves the top N applications with abnormal change orders `GET https://www.apizie.tech/v1/cloud:aliyun-sae/get-change-order-metric` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The region ID | | CreateTime | string | yes | The start time of change order creation | | OrderBy | string | yes | The field used to sort the query results | | Limit | integer | yes | The number of entries to return. Valid values: 0 to 100 | | AppSource | string | no | The type of the Serverless App Engine (SAE) application. micro_service web job | | CpuStrategy | string | no | The CPU allocation strategy. Valid values: request: Allocates CPU resources only when requests are received. always: Always allocates a… | | AppId | string | no | The application ID | | CoType | string | no | The change order type | ### Queries the top N applications in which auto scaling takes effect `GET https://www.apizie.tech/v1/cloud:aliyun-sae/get-scale-app-metric` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The region ID | | Limit | integer | yes | The number of entries to return. Valid values: 0 to 100 | | AppSource | string | no | The SAE application type. Valid values: micro_service web job | | CpuStrategy | string | no | The CPU allocation policy. Valid values: request: CPU cores are allocated only when a request is initiated. always: Fixed CPU cores are… | ### Queries the top N applications in which Warning events occur `GET https://www.apizie.tech/v1/cloud:aliyun-sae/get-warning-event-metric` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | RegionId | string | yes | The region ID | | StartTime | integer | yes | The beginning of the time range to query | | EndTime | integer | yes | The end of the time range to query | | Limit | integer | yes | The number of entries to return. Valid values: 0 to 100 | | AppSource | string | no | The SAE application type. Valid values: micro_service web job | | CpuStrategy | string | no | The CPU allocation policy. Valid values: request: CPU cores are allocated only when a request is initiated. always: Fixed CPU cores are… | ### Obtains the token used to remotely log on to the Webshell of an instance `GET https://www.apizie.tech/v1/cloud:aliyun-sae/get-webshell-token` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | AppId | string | yes | The ID of the interactive messaging application | | PodName | string | yes | The name of the pod | | ContainerName | string | no | The name of the init container. Note: If you specify this parameter, Cloud Assistant runs the command in the specified container of the… | ### Returns a list of all swimlane groups `GET https://www.apizie.tech/v1/cloud:aliyun-sae/list-all-swimming-lane-groups` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | NamespaceId | string | no | The namespace ID | ### Queries all traffic lanes `GET https://www.apizie.tech/v1/cloud:aliyun-sae/list-all-swimming-lanes` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | NamespaceId | string | no | The namespace ID | | GroupId | integer | no | The traffic lane group ID | ### To list application events, call the `ListAppEvents` API `GET https://www.apizie.tech/v1/cloud:aliyun-sae/list-app-events` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | CurrentPage | integer | no | The current page number | | PageSize | integer | no | The number of entries to return per page. The value must be an integer from 0 to 10,000 | | AppId | string | no | The application ID | | ObjectKind | string | no | The object kind. Valid values: Deployment: The application. Pod: The application instance. Service: The Server Load Balancer (SLB)… | | ObjectName | string | no | The name of the object. Prefix matching is supported | | EventType | string | no | The event type. Valid values: Warning: An event that indicates a potential problem. Normal: An event that indicates a routine operation | | Reason | string | no | The reason for the event. Prefix matching is supported | | Namespace | string | yes | The ID of the region where the namespace is located | ### Lists microservices `GET https://www.apizie.tech/v1/cloud:aliyun-sae/list-app-services` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | AppId | string | no | The application ID. Specify exactly one of the following parameters: `VpcId`, `NamespaceId`, or `AppId` | | ServiceType | string | no | The service type. Valid values: dubbo springCloud hsf k8sService | | RegistryType | string | no | The service registry type. Valid values: 0: SAE Nacos 1: self-managed service registry 2: MSE Nacos 9: SAE K8s Service | | NacosInstanceId | string | no | The instance ID of MSE Nacos. This parameter is required if the service registry is MSE Nacos | | NacosNamespaceId | string | no | The namespace ID of MSE Nacos. This parameter is required if the service registry is MSE Nacos | | PageNumber | integer | no | The page number | | PageSize | integer | no | The number of entries per page | | VpcId | string | no | The ID of the VPC. Specify exactly one of the following parameters: `VpcId`, `NamespaceId`, or `AppId` | | NamespaceId | string | no | The namespace ID. Specify exactly one of the following parameters: `VpcId`, `NamespaceId`, or `AppId` | ### Call `ListAppServicesPage` to get a list of application services `GET https://www.apizie.tech/v1/cloud:aliyun-sae/list-app-services-page` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | AppId | string | yes | The application ID | | ServiceType | string | yes | The service type. Valid values: Dubbo Spring Cloud | | PageNumber | integer | no | The page number | | PageSize | integer | no | The page size. The value must be an integer from 0 to 9,999 | ### Lists the historical versions of an application `GET https://www.apizie.tech/v1/cloud:aliyun-sae/list-app-versions` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | AppId | string | yes | The application ID | ### ListApplicationCenterServiceInstances `GET https://www.apizie.tech/v1/cloud:aliyun-sae/list-application-center-service-instances` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | NamespaceId | string | no | The NamespaceId | | RegionId | string | no | The RegionId | ### Retrieves a list of applications `GET https://www.apizie.tech/v1/cloud:aliyun-sae/list-applications` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | CurrentPage | integer | no | The current page number | | PageSize | integer | no | The number of entries per page in a paging query. Valid values: [0,10000] | | AppName | string | no | The application name | | NamespaceId | string | no | The namespace ID | | Tags | string | no | The tag key-value pairs. Valid values: key: the tag key. The length must be in the range of [1,128]. value: the tag value. The length must… | | OrderBy | string | no | The field by which to sort applications. Valid values: runnings: sorts by the current number target instances. instances: sorts by the… | | Reverse | string | no | Specifies whether to sort application instances by running status. If instances have the same status, they are sorted by instance ID.… | | FieldType | string | no | The dimension by which to filter applications. Valid values: appName: application name. appIds: application ID. slbIps: SLB IP address.… | | FieldValue | string | no | The application name, application ID, SLB IP address, or instance IP address of the target application | | AppSource | string | no | The Serverless App Engine (SAE) application type. micro_service. web. job | | IsStateful | string | no | Specifies whether the application is stateful | | NewSaeVersion | string | no | The application version. Valid values: lite: Lite Edition std: Standard Edition pro: Professional Edition | | ProgrammingLanguage | string | no | The ProgrammingLanguage | ### Retrieves a list of applications for full-link canary releases `GET https://www.apizie.tech/v1/cloud:aliyun-sae/list-applications-for-swimming-lane` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | NamespaceId | string | yes | The namespace ID | | GroupId | integer | no | The ID of the application group. You can call the https://help.aliyun.com/document_detail/126249.html operation to obtain the ID | | Tag | string | no | The canary tag | ### Queries the list of change orders `GET https://www.apizie.tech/v1/cloud:aliyun-sae/list-change-orders` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | AppId | string | yes | The application ID | | CurrentPage | integer | no | The current page number | | PageSize | integer | no | The number of entries per page | | Key | string | no | The keyword used for fuzzy match of the change order description. Change orders whose descriptions contain the keyword are returned | | CoType | string | no | The type of the change order. Valid values: CoBindSlb: bind an SLB instance CoUnbindSlb: unbind an SLB instance CoCreateApp: create an… | | CoStatus | string | no | The status of the change order. Valid values: 0: preparing 1: executing 2: executed successfully 3: execution failed 6: terminated 8:… | | OrderBy | string | no | The sorting condition | | Reverse | string | no | Specifies whether to sort the results in ascending order based on the field specified by the OrderBy parameter. Valid values: true: sort… | ### You can call the ListConsumedServices operation to retrieve a list of subscribed microservices `GET https://www.apizie.tech/v1/cloud:aliyun-sae/list-consumed-services` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | AppId | string | yes | The application ID | ### Queries the details of a canary release rule based on the application ID `GET https://www.apizie.tech/v1/cloud:aliyun-sae/list-grey-tag-route` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | AppId | string | yes | The application ID | ### Queries the list of ingresses `GET https://www.apizie.tech/v1/cloud:aliyun-sae/list-ingresses` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | NamespaceId | string | yes | The namespace ID | | AppId | string | no | The application ID | | CurrentPage | integer | no | The current page number | | PageSize | integer | no | The number of entries per page | ### Queries a list of job templates `GET https://www.apizie.tech/v1/cloud:aliyun-sae/list-jobs` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | CurrentPage | integer | no | The current page number. Valid values start from 1 | | PageSize | integer | no | The number of entries per page. Valid values: 0 to 200 | | AppName | string | no | The name of the job template | | NamespaceId | string | no | The ID of the namespace | | Tags | string | no | The list of tags. The value is a JSON string that contains the following fields: key: the tag key value: the tag value | | OrderBy | string | no | The field used to sort job templates. Valid values: running: sort by the current number target instances instances: sort by the target… | | Reverse | string | no | Specifies whether to reverse the sort order based on the field specified by the OrderBy parameter. Valid values: true: sort in ascending… | | FieldType | string | no | The dimension used to filter job templates. Valid values: appName: the job template name appIds: the job template ID | | FieldValue | string | no | The value used to filter job templates based on the dimension specified by the FieldType parameter. Enter the job template name or job… | | Workload | string | no | The workload type. Set the value to `job` | ### Returns a list of application logs `GET https://www.apizie.tech/v1/cloud:aliyun-sae/list-log-configs` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | AppId | string | yes | The application ID | | PageSize | integer | yes | The number of entries to return on each page. Valid values: 1 to 10000 | | CurrentPage | integer | yes | The page number | ### Queries the change orders in a namespace `GET https://www.apizie.tech/v1/cloud:aliyun-sae/list-namespace-change-orders` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | NamespaceId | string | yes | The namespace ID | | CoStatus | string | no | The status of the change order. Valid values: 0: preparing 1: executing 2: succeeded 3: failed 6: terminated 10: failed due to a system… | | CoType | string | no | The type of the change order. Valid values: CoBatchStartApplication: Starts applications in batches. CoBatchStopApplication: Stops… | | Key | string | no | The keyword used for fuzzy matching of the change order description. All change orders whose descriptions contain this key are returned | | CurrentPage | integer | no | The current page number | | PageSize | integer | no | The number of entries per page | ### Retrieves a list of ConfigMap instances in a namespace `GET https://www.apizie.tech/v1/cloud:aliyun-sae/list-namespaced-config-maps` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | NamespaceId | string | yes | The namespace ID | ### Retrieves the list of published microservices `GET https://www.apizie.tech/v1/cloud:aliyun-sae/list-published-services` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | AppId | string | yes | The application ID | ### Queries the Secret instances in a namespace `GET https://www.apizie.tech/v1/cloud:aliyun-sae/list-secrets` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | NamespaceId | string | yes | The ID of the namespace where the Secret instance resides. If the Secret instance resides in the default namespace, specify only the… | ### Queries the available gateway routes for a traffic lane `GET https://www.apizie.tech/v1/cloud:aliyun-sae/list-swimming-lane-gateway-routes` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | NamespaceId | string | no | The namespace ID | | GatewayUniqueId | string | no | The unique ID of the gateway | ### Queries all lane tags `GET https://www.apizie.tech/v1/cloud:aliyun-sae/list-swimming-lane-group-tags` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | NamespaceId | string | no | The namespace ID | | GroupId | integer | no | The lane group ID | ### Queries the mapping between applications and tags `GET https://www.apizie.tech/v1/cloud:aliyun-sae/list-tag-resources` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | RegionId | string | yes | The region ID | | ResourceType | string | yes | The resource type. Only `application` is supported | | NextToken | string | no | The pagination token. A single query returns up to 50 results. If the total number of results exceeds 50, a NextToken is returned. You can… | | ResourceIds | string | no | The resource IDs. You can specify multiple resource IDs separated by commas (,). This parameter is required if you do not specify the Tags… | | Tags | string | no | The tag key-value pairs. This parameter is required if you do not specify the ResourceIds parameter. key: the tag key. The value must be 1… | ### Query the list of web application instances `GET https://www.apizie.tech/v1/cloud:aliyun-sae/list-web-application-instances` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | NamespaceId | string | yes | The namespace ID | | ApplicationId | string | yes | The application ID | | InstanceIds | string | no | The instance ID (JSON-encoded) | | VersionIds | string | no | The ID of the application version (JSON-encoded) | | Statuses | string | no | The status of the application instance (JSON-encoded) | | Limit | string | no | The number of application instances returned | | StartTime | integer | no | The time when the task was created | | EndTime | integer | no | The time when the operation ended | ### Query the list of web application versions `GET https://www.apizie.tech/v1/cloud:aliyun-sae/list-web-application-revisions` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | NamespaceId | string | yes | The namespace ID | | ApplicationId | string | yes | The application ID | | NextToken | string | no | The pagination token | | Limit | integer | no | The number of applications returned | ### Query the list of web applications `GET https://www.apizie.tech/v1/cloud:aliyun-sae/list-web-applications` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | NamespaceId | string | no | The namespace ID | | Prefix | string | no | The prefix of the application name | | NextToken | string | no | The pagination token | | Limit | integer | no | The number of applications returned | ### Query available custom domain names `GET https://www.apizie.tech/v1/cloud:aliyun-sae/list-web-custom-domains` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | NamespaceId | string | no | The namespace ID | | ApplicationId | string | no | The application ID | | Prefix | string | no | The prefix of the custom domain name that you want to query | | NextToken | string | no | The pagination token | | Limit | integer | no | The number of custom domain names returned | ### Activates Serverless App Engine (SAE) for free `POST https://www.apizie.tech/v1/cloud:aliyun-sae/open-sae-service` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | ### Publish a web application version `POST https://www.apizie.tech/v1/cloud:aliyun-sae/publish-web-application-revision` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | NamespaceId | string | yes | The namespace ID | | ApplicationId | string | yes | The application ID | | Containers | array | yes | The container configurations of the revision version | | Description | string | no | The version description | | EnableArmsMetrics | string | no | Specifies whether to enable Application Real-Time Monitoring Service (ARMS) monitoring | | TakeEffect | string | no | Specifies whether to switch all traffic to a new version after the new version is released. Default value: false | ### Queries whether ARMS monitoring is enabled for a specified application `GET https://www.apizie.tech/v1/cloud:aliyun-sae/query-arms-enable` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | AppId | string | yes | The application ID | ### Retrieves the resource usage of an application `GET https://www.apizie.tech/v1/cloud:aliyun-sae/query-resource-statics` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | AppId | string | yes | The application ID | ### Scales in an application based on instance IDs `POST https://www.apizie.tech/v1/cloud:aliyun-sae/reduce-application-capacity-by-instance-ids` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | AppId | string | yes | The ID of the application | | InstanceIds | string | yes | The ID of the instance. Separate multiple instances with commas (,) | ### Rescale an application `POST https://www.apizie.tech/v1/cloud:aliyun-sae/rescale-application` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | AppId | string | yes | The ID of the application | | Replicas | integer | yes | The expected number of instances | | MinReadyInstances | integer | no | The minimum number of available instances. Special values: If you set the value to 0, business interruptions occur when the application is… | | MinReadyInstanceRatio | integer | no | The percentage of the minimum number of available instances. Take note of the following rules: If you set the value to -1, the minimum… | | AutoEnableApplicationScalingRule | string | no | Specifies whether to automatically enable an auto scaling policy for the application. Take note of the following rules: true: turns on… | ### Modifies the instance specifications of an application `POST https://www.apizie.tech/v1/cloud:aliyun-sae/rescale-application-vertically` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | AppId | string | yes | The ID of the application | | Cpu | string | yes | The target CPU specifications, in millicores | | Memory | string | yes | The target memory specifications, in MB | | minReadyInstances | integer | no | The minimum number of ready instances | | minReadyInstanceRatio | integer | no | The minimum percentage of ready instances | | autoEnableApplicationScalingRule | string | no | Specifies whether to automatically enable the elastic scaling rule | | DiskSize | string | no | The disk storage size per node, in GB | | ResourceType | string | no | The type of resource used for vertical scaling of the application | | VSwitchId | string | no | The VSwitchId | | Deploy | string | no | The Deploy | ### Restarts an application `POST https://www.apizie.tech/v1/cloud:aliyun-sae/restart-application` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://sae.ap-southeast-1.aliyuncs.com | | AppId | string | yes | The ID of the application | | MinReadyInstances | integer | no | The minimum number of ready instances. Valid values: If you set this parameter to 0, services are interrupted during the application… | | MinReadyInstanceRatio | integer | no | The percentage of the minimum number of ready instances. Valid values: -1: the initial value, which indicates that the percentage is not… | | AutoEnableApplicationScalingRule | string | no | Specifies whether the elastic scaling policy for the application is automatically enabled. Valid values: true: enables the policy. false:… | …and 33 more. See the OpenAPI spec. ## Example ``` curl "https://www.apizie.tech/v1/cloud:aliyun-sae/abort-and-rollback-change-order" \ -H "x-api-key: $APIZIE_KEY" \ -H "x-upstream-key: $PROVIDER_KEY" ``` ## FAQ ### How do I call the Alibaba Cloud Serverless App Engine API? Create a free Apizie key, then send POST https://www.apizie.tech/v1/cloud:aliyun-sae/abort-and-rollback-change-order with the header x-api-key. Every endpoint returns { project, data, timestamp }. ### Is the Alibaba Cloud Serverless App Engine API free on Apizie? Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Serverless App Engine itself also needs your own key from aliyuncs.com. ### Can AI agents use the Alibaba Cloud Serverless App Engine API? Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-sae. ### What is the status of the Alibaba Cloud Serverless App Engine API? Needs your own provider key (bring your own key)