API overview

更新时间:
复制 MD 格式

API standard and pre-built SDKs in multi-language

The OpenAPI specification of this product (eas/2021-07-01) follows the ROA standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.

Custom signature

If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).

Before you begin

An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.

Service

API

Title

Description

CreateServiceAutoScaler CreateServiceAutoScaler Enables the Autoscaler feature and creates an Autoscaler controller for a service.
CreateServiceCronScaler CreateServiceCronScaler Creates a scheduled auto scaling rule for a service.
CreateServiceInstanceToken CreateServiceInstanceToken Call this operation to obtain a token and a WebSocket URL for logging on to a container.
DescribeGroupEndpoints DescribeGroupEndpoints Obtains a list of endpoints of service groups.
DescribeServiceEndpoints DescribeServiceEndpoints Retrieves a list of service endpoints.
CloneService CloneService Clones a service.
ScaleService ScaleService Scales a service.
UpdateServiceVersion UpdateServiceVersion Updates the version of a service or rolls back the service to a specific version.
DeleteServiceLabel DeleteServiceLabel Deletes a service label.
DeleteServiceInstances DeleteServiceInstances Restarts specified instances of a service.
ListServices ListServices Lists services.
UpdateServiceAutoScaler UpdateServiceAutoScaler Updates the Autoscaler configurations of a service.
UpdateServiceCronScaler UpdateServiceCronScaler Updates the scheduled auto scaling configuration for a service.
UpdateServiceInstance UpdateServiceInstance Updates the properties of a service instance. This operation applies only to fencing service instances.
DescribeService DescribeService Queries the details about a service.
DescribeServiceAutoScaler DescribeServiceAutoScaler Queries information about the Autoscaler configurations of a service.
DescribeServiceCronScaler DescribeServiceCronScaler Queries the Cron Horizontal Pod Autoscaler (CronHPA) configurations of a service.
DescribeServiceEvent DescribeServiceEvent Queries recent deployment events for a specified service.
DescribeSpotDiscountHistory DescribeSpotDiscountHistory Queries the historical prices of preemptible instances. For more information about preemptible instances, see Create and use preemptible instances.
ListServiceInstances ListServiceInstances Lists the instances of a specified service.
ListServiceVersions ListServiceVersions Queries the information about the historical versions of a service.
ListGroups ListGroups Queries a list of service groups.
DescribeMachineSpec DescribeMachineSpec Returns a list of available machine specifications.
CreateServiceRollout CreateServiceRollout Creates a service rollout.
DescribeServiceRollout DescribeServiceRollout Retrieves the details of a service rollout.
DeleteServiceRollout DeleteServiceRollout Deletes a service rollout.
UpdateServiceRollout UpdateServiceRollout Updates a service rollout.
CreateFaultInjection CreateFaultInjection Creates a fault injection task.
DeleteFaultInjection DeleteFaultInjection Deletes a fault injection task.
ListServiceInstanceFaultInjectionInfo ListServiceInstanceFaultInjectionInfo Retrieves fault injection information.

Resource group

API

Title

Description

ListVirtualResource ListVirtualResource Queries the virtual resource groups for the current user.
DescribeVirtualResource DescribeVirtualResource Queries the details of a virtual resource group.
CreateResource CreateResource Create a new resource group.
CreateResourceInstances CreateResourceInstances Creates machine instances in a dedicated resource group.
DeleteResourceInstanceLabel DeleteResourceInstanceLabel Deletes tags from instances in a resource group.
MigrateResourceInstance MigrateResourceInstance Migrates instances to a specified resource group.
UpdateResourceInstance UpdateResourceInstance Updates the scheduling status of an instance in a dedicated resource group.
DescribeResource DescribeResource Retrieves the details of a resource group.
ListResourceInstances ListResourceInstances Lists the instances in a specified dedicated resource group.
ListResourceInstanceWorker ListResourceInstanceWorker Lists the service workers of a resource instance.
ListResources ListResources Lists the resource groups for the current user.
ListResourceServices ListResourceServices Queries a list of services that are deployed in the dedicated resource group.

Stress testing task

API

Title

Description

ListBenchmarkTask ListBenchmarkTask Lists all deployed stress testing tasks.

Private gateway

API

Title

Description

CreateGateway CreateGateway Creates a gateway.
DeleteGatewayLabel DeleteGatewayLabel Deletes gateway labels.
UpdateGatewayLabel UpdateGatewayLabel Adds a gateway label or updates an existing one.
ListGatewayDomains ListGatewayDomains Lists the custom domain names for a private gateway.
ListGateway ListGateway Lists private gateways.
DescribeGateway DescribeGateway Queries the details of a private gateway.
UpdateGateway UpdateGateway Updates a private gateway.
CreateGatewayIntranetLinkedVpc CreateGatewayIntranetLinkedVpc Creates an internal endpoint for a private gateway.
ListGatewayIntranetLinkedVpc ListGatewayIntranetLinkedVpc Lists the internal access endpoints of a private gateway.
ListGatewayIntranetLinkedVpcPeer ListGatewayIntranetLinkedVpcPeer Lists the VPC peering connections for a gateway's private network endpoint.

Other

API

Title

Description

ListTenantAddons ListTenantAddons Queries a list of tenant plug-ins.
DescribeRegions DescribeRegions Queries available regions.

Others

API

Title

Description

AttachGatewayDomain AttachGatewayDomain Binds a custom domain name to a private gateway.
CommitService CommitService Commits the Worker0 container in the custom container service and deploys the container as a new image.
CreateAclPolicy CreateAclPolicy Creates an access control list (ACL) for a private gateway. The IP CIDR blocks added to the ACL can access the private gateway.
CreateAppService CreateAppService Creates an application service to obtain the inference capabilities of large models.
CreateBenchmarkTask CreateBenchmarkTask Creates a stress testing task.
CreateGatewayIntranetLinkedVpcPeer CreateGatewayIntranetLinkedVpcPeer Creates a VPC peering connection on an internal endpoint of a gateway.
CreateResourceLog CreateResourceLog Enables the LogShipper feature of Log Service for a resource group.
CreateService CreateService Creates a model service in Elastic Algorithm Service (EAS).
CreateServiceMirror CreateServiceMirror Enables the traffic mirroring feature for a service. After the feature is enabled, requests received by the service can be mirrored to another service.
CreateVirtualResource CreateVirtualResource Creates a virtual resource group.
DeleteAclPolicy DeleteAclPolicy Deletes an access control list (ACL) for a private gateway. The IP CIDR block that is deleted from the ACL cannot access the private gateway.
DeleteBenchmarkTask DeleteBenchmarkTask Deletes a stress testing task.
DeleteGateway DeleteGateway Deletes a private gateway.
DeleteGatewayIntranetLinkedVpc DeleteGatewayIntranetLinkedVpc Deletes an internal endpoint of a private gateway.
DeleteGatewayIntranetLinkedVpcPeer DeleteGatewayIntranetLinkedVpcPeer Deletes a VPC peering connection from an internal endpoint of a gateway.
DeleteResource DeleteResource Deletes a resource group that contains no resources or instances.
DeleteResourceDLink DeleteResourceDLink Disables the virtual private cloud (VPC) direct connection feature for a dedicated resource group.
DeleteResourceInstances DeleteResourceInstances Deletes instances in a dedicated resource group. You can delete only pay-as-you-go instances as a regular user.
DeleteResourceLog DeleteResourceLog Disables the LogShipper feature of Log Service for a dedicated resource group.
DeleteService DeleteService Deletes a service.
DeleteServiceAutoScaler DeleteServiceAutoScaler Deletes the existing Autoscaler controller and disables the Autoscaler feature for a service.
DeleteServiceCronScaler DeleteServiceCronScaler Disables the Cronscaler feature for a service.
DeleteServiceMirror DeleteServiceMirror Disables the traffic mirroring feature for a service.
DeleteVirtualResource DeleteVirtualResource Deletes a virtual resource group that contains no resources or instances.
DescribeBenchmarkTask DescribeBenchmarkTask Queries details about the configurations of a stress testing task.
DescribeBenchmarkTaskReport DescribeBenchmarkTaskReport Queries the report of a stress testing task.
DescribeGroup DescribeGroup Queries the information about a service group.
DescribeResourceDLink DescribeResourceDLink Queries detailed configurations about a virtual private cloud (VPC) direct connection of a dedicated resource group.
DescribeResourceLog DescribeResourceLog Queries the details about the LogShipper configurations of Log Service for a dedicated resource group.
DescribeServiceDiagnosis DescribeServiceDiagnosis Queries the diagnostics details of a service.
DescribeServiceInstanceDiagnosis DescribeServiceInstanceDiagnosis Queries the diagnostics details of an instance that runs Elastic Algorithm Service (EAS).
DescribeServiceLog DescribeServiceLog Queries the information about the logs of a service.
DescribeServiceMirror DescribeServiceMirror Queries details about the traffic mirroring settings of a service.
DescribeServiceSignedUrl DescribeServiceSignedUrl Obtains the logon-free URL of the service.
DetachGatewayDomain DetachGatewayDomain Unbinds a custom domain name from a private gateway.
DevelopService DevelopService Switches a container service to development mode or exits development mode.
ListAclPolicy ListAclPolicy Queries access control lists (ACLs) created for a private gateway.
ListGatewayIntranetSupportedZone ListGatewayIntranetSupportedZone Obtains the zones supported by a gateway within an intranet.
ListServiceContainers ListServiceContainers Queries the containers of a service.
ReinstallTenantAddon ReinstallTenantAddon Resets tenant configurations.
ReleaseService ReleaseService Switch the traffic state or weight of the service.
RestartService RestartService Restarts a service.
StartBenchmarkTask StartBenchmarkTask Starts a stress testing task.
StartService StartService Starts a service.
StopBenchmarkTask StopBenchmarkTask Stops a stress testing task.
StopService StopService Stops a running service.
UpdateAppService UpdateAppService Updates an application service.
UpdateBenchmarkTask UpdateBenchmarkTask Updates a stress testing task.
UpdateGroup UpdateGroup Updates the specific fields of a service group.
UpdateResource UpdateResource Updates the information about a dedicated resource group. Only the name of a dedicated resource group can be updated.
UpdateResourceDLink UpdateResourceDLink Updates the configurations of a virtual private cloud (VPC) direct connection for a dedicated resource group.
UpdateResourceInstanceLabel UpdateResourceInstanceLabel Updates the tag of an instance in a resource group.
UpdateService UpdateService Updates a model or processor of a service. If only the metadata.instance field is updated, manual scaling can be performed.
UpdateServiceLabel UpdateServiceLabel Adds service tags or updates existing service tags.
UpdateServiceMirror UpdateServiceMirror Updates the traffic mirroring configurations of a service.
UpdateServiceSafetyLock UpdateServiceSafetyLock Updates the safety lock of a service to minimize misoperations on the service.
UpdateVirtualResource UpdateVirtualResource Updates the information about a virtual resource group.