Use OpenAPI

Updated at: 2025-01-08 12:14

You can manage Application Load Balancer (ALB) by calling API operations. This topic describes the basic information about the ALB API, including its versions, API endpoints, API style, and call methods.

API version

OpenAPI Portal uses versions to manage the API operations of cloud services that are made available in different periods. For example, ALB supports API operations of the 2020-06-16 version, in which 2020-06-16 represents the API version instead of a time. This version provides all the latest API operations.

API version

Description

API version

Description

2020-06-16

We recommend that you use the ALB API of this version.

Endpoints

An endpoint provides access to the corresponding Alibaba Cloud service. An Alibaba Cloud service supports both public endpoints and virtual private cloud (VPC) endpoints. Public endpoints are globally accessible whereas VPC endpoints are accessible only within the specified VPC. An endpoint is a URL that specifies information about the service, such as the access protocol, hostname, port, and path. Clients can use the information to access the service. For more information, see ALB endpoints, NLB endpoints, GWLB endpoints, and CLB endpoints.

For specific ALB endpoints, see Endpoints.

User identities

User identity

Supported

User identity

Supported

Alibaba Cloud account

Yes

Resource Access Management (RAM) user (recommended)

Yes

RAM role (recommended)

Yes

We recommend that you use a RAM user or a RAM role to call API operations. Before doing so, you must grant the required permissions to the RAM user or the RAM role. For more information about identities, see Identities, credentials, and authorization.

API style

The API operations of ALB are called in the remote procedure call (RPC) style. For more information, see API styles.

Call methods

Call method

Supported

Description

Call method

Supported

Description

Alibaba Cloud SDK (recommended)

Yes

For supported languages and dependency installation methods of the ALB SDK, see ALB SDK.

Alibaba Cloud CLI

Yes

For information about using the ALB CLI, see ALB CLI.

Terraform

Yes

For information about using Terraform, see Application Load Balancer (ALB).

Resource Orchestration Service (ROS)

Yes

For information about using ROS, see ALB.

Native HTTP

Yes

If the SDKs cannot meet your business requirements, you can encapsulate HTTP requests. For more information, see Request syntax and signature method.

  • On this page (1, T)
  • API version
  • Endpoints
  • User identities
  • API style
  • Call methods
Feedback
phone Contact Us

Chat now with Alibaba Cloud Customer Service to assist you in finding the right products and services to meet your needs.

alicare alicarealicarealicare