API standard and pre-built SDKs in multi-language
This product (APIG/2024-03-27) OpenAPI adopts an ROA-style signature mechanism. For implementation details, please refer to the Signature Mechanism documentation.To streamline development, we provide official SDKs for major programming languages. Using the SDK allows you to call APIs directly without worrying about low-level details such as request signatures, significantly lowering the barrier to entry and reducing integration complexity.
Custom signature
If your use case requires direct API integration with custom signatures, consult our technical support team first. Join our DingTalk support group (147535001692) to receive expert guidance.
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.
API Management
| API | Title | Description |
|---|---|---|
| ExportHttpApi | ExportHttpApi | Exports an HTTP API. |
| ImportHttpApi | ImportHttpApi | Imports HTTP APIs. You can call this operation to import OpenAPI 2.0 and OpenAPI 3.0.x definition files to create REST APIs. |
| DeployHttpApi | DeployHttpApi | Deploy HttpApi |
| CreateHttpApi | CreateHttpApi | Creates an HTTP API. |
| UpdateHttpApi | UpdateHttpApi | Updates an HTTP API. |
| GetHttpApi | GetHttpApi | Read HttpApi |
| ListHttpApis | ListHttpApis | Queries a list of HTTP APIs. |
| UndeployHttpApi | UndeployHttpApi | Unpublishes an HTTP API. |
| DeleteHttpApi | DeleteHttpApi | Deletes an HTTP API. |
Interface Management
| API | Title | Description |
|---|---|---|
| CreateHttpApiOperation | CreateHttpApiOperation | Create an Operation for HTTP API |
| GetHttpApiOperation | GetHttpApiOperation | Get Operation |
| UpdateHttpApiOperation | UpdateHttpApiOperation | Updates an operation of an HTTP API. |
| ListHttpApiOperations | ListHttpApiOperations | List Operations |
| DeleteHttpApiOperation | DeleteHttpApiOperation | Deletes an operation from an HTTP API. |
MCP Management
| API | Title | Description |
|---|---|---|
| CreateMcpServer | CreateMcpServer | Creates an MCP server. |
| UpdateMcpServer | UpdateMcpServer | Updates an MCP server. |
| GetMcpServer | GetMcpServer | Queries the detailed information of an MCP server. |
| ListMcpServers | ListMcpServers | Retrieves a list of MCP servers. |
| DeleteMcpServer | DeleteMcpServer | Deletes an MCP server. |
| DeployMcpServer | DeployMcpServer | Deploys an MCP server. |
| UnDeployMcpServer | UnDeployMcpServer | Undeploys an MCP server. |
| SyncMCPServers | SyncMCPServers | Synchronizes Nacos Model Context Protocol (MCP) server configurations to Cloud-native API Gateway. |
Routing Management
| API | Title | Description |
|---|---|---|
| CreateHttpApiRoute | CreateHttpApiRoute | Creates a route for an HTTP API. |
| UpdateHttpApiRoute | UpdateHttpApiRoute | Updates the route of an HTTP API. |
| GetHttpApiRoute | GetHttpApiRoute | Queries the details of a route of an HTTP API. |
| DeleteHttpApiRoute | DeleteHttpApiRoute | Deletes a route in an HTTP API. |
| ListHttpApiRoutes | ListHttpApiRoutes | Queries the routes of an HTTP API. |
Service Management
| API | Title | Description |
|---|---|---|
| GetService | GetService | Queries a service. |
| CreateService | CreateService | Creates a service. |
| ListServices | ListServices | Queries a list of services. |
| UpdateService | UpdateService | Updates a service. You can call this operation to update the health check, DNS domain name, and fixed address configurations of a service. |
| DeleteService | DeleteService | Deletes a service. |
| CreateServiceVersion | CreateServiceVersion | Creates a service version. |
| UpdateServiceVersion | UpdateServiceVersion | Updates a service version. |
| DeleteServiceVersion | DeleteServiceVersion | Deletes a service version. |
| CreateSource | CreateSource | Creates a service source. |
| GetSource | GetSource | Obtains the details of a service source. |
Gateway Management
| API | Title | Description |
|---|---|---|
| CreateGateway | CreateGateway | Creates a cloud-native gateway. |
| UpdateGatewayName | UpdateGatewayName | Changes the name of a Cloud-native API Gateway instance. |
| UpdateGatewayFeature | UpdateGatewayFeature | Updates the configuration of an instance feature parameter. |
| UpgradeGateway | UpgradeGateway | Updates the version of a Cloud-native API Gateway instance. |
| GetGateway | GetGateway | Queries the basic information about an instance, such as the virtual private cloud (VPC) and vSwitch to which the instance belongs and its ingress. |
| ListGateways | ListGateways | Queries a list of instances. |
| AddGatewaySecurityGroupRule | AddGatewaySecurityGroupRule | Adds a security group that authorizes an instance to access services. |
| DeleteGateway | DeleteGateway | Deletes a Cloud-native API Gateway instance. |
| DeleteGatewaySecurityGroupRule | DeleteGatewaySecurityGroupRule | Deletes a security group rule from a Cloud-native API Gateway instance. |
| ListZones | ListZones | Retrieve the availability zones under a cloud-native API gateway region |
| RestartGateway | RestartGateway | Restarts an instance. |
| ListGatewayFeatures | ListGatewayFeatures | Queries the feature parameter configurations of an instance. |
Consumer Management
| API | Title | Description |
|---|---|---|
| RemoveConsumerAuthorizationRule | RemoveConsumerAuthorizationRule | Deletes a consumer authorization rule. |
| QueryConsumerAuthorizationRules | QueryConsumerAuthorizationRules | Queries a list of consumer authentication rules. |
| CreateConsumerAuthorizationRules | CreateConsumerAuthorizationRules | Creates a consumer authentication rule. |
| BatchDeleteConsumerAuthorizationRule | BatchDeleteConsumerAuthorizationRule | Removes consumer authentication rules. |
| DeleteConsumer | DeleteConsumer | Deletes a consumer. |
| ListConsumers | ListConsumers | Queries a list of consumers. |
| DeleteConsumerAuthorizationRule | DeleteConsumerAuthorizationRule | Deletes a consumer authorization rule. |
| CreateConsumer | CreateConsumer | Creates a consumer. |
| UpdateConsumer | UpdateConsumer | Updates a consumer. |
| GetConsumer | GetConsumer | Obtains the information of a consumer. |
| CreateConsumerAuthorizationRule | CreateConsumerAuthorizationRule | Creates a consumer authorization rule. |
| UpdateConsumerAuthorizationRule | UpdateConsumerAuthorizationRule | Updates a consumer authorization rule. |
| GetConsumerAuthorizationRule | GetConsumerAuthorizationRule | Obtains a consumer authentication rule. |
Policy Management
| API | Title | Description |
|---|---|---|
| ListPolicies | ListPolicies | Queries policies. |
| ListPolicyClasses | ListPolicyClasses | Queries policy templates. |
| CreatePolicy | CreatePolicy | Creates a policy. |
| GetPolicy | GetPolicy | Queries a policy. |
| UpdatePolicy | UpdatePolicy | Updates a policy. |
| DeletePolicy | DeletePolicy | Deletes a policy. |
| CreatePolicyAttachment | CreatePolicyAttachment | Creates a policy attachment. |
| GetPolicyAttachment | GetPolicyAttachment | Queries a policy attachment. |
| DeletePolicyAttachment | DeletePolicyAttachment | Deletes a policy attachment. |
Plug-in Management
| API | Title | Description |
|---|---|---|
| ListPlugins | ListPlugins | Queries plug-ins. |
| CreatePluginAttachment | CreatePluginAttachment | Attaches a plug-in. |
| GetPluginAttachment | GetPluginAttachment | Queries a plug-in attachment. |
| ListPluginAttachments | ListPluginAttachments | Retrieves a list of plug-in attachments. |
| UpdatePluginAttachment | UpdatePluginAttachment | Updates a plug-in attachment. |
| DeletePluginAttachment | DeletePluginAttachment | Deletes a plug-in attachment. |
| InstallPlugin | InstallPlugin | Installs a plug-in. |
| UninstallPlugin | UninstallPlugin | Uninstalls a plug-in. |
Domain Name Management
| API | Title | Description |
|---|---|---|
| ListSslCerts | ListSslCerts | Queries SSL certificates. |
| GetDomain | GetDomain | Queries the information about a domain name. |
| CreateDomain | CreateDomain | Creates a domain name. |
| ListDomains | ListDomains | Queries a list of domain names. |
| DeleteDomain | DeleteDomain | Deletes a domain name. |
| UpdateDomain | UpdateDomain | Updates a domain name. |
Monitoring Management
| API | Title | Description |
|---|---|---|
| GetTraceConfig | GetTraceConfig | Queries the tracing configurations of a Cloud-native API Gateway instance. |
| GetDashboard | GetDashboard | Obtains data from dashboards. |
Resource Management
| API | Title | Description |
|---|---|---|
| ChangeResourceGroup | ChangeResourceGroup | Moves a resource from one resource group to another. |
| GetResourceOverview | GetResourceOverview | Get resource overview information |
Historical Interfaces
| API | Title | Description |
|---|---|---|
| CreateAndAttachPolicy | CreateAndAttachPolicy | Creates and associates a policy. |
| UpdateAndAttachPolicy | UpdateAndAttachPolicy | Updates and associates a policy. |
| Environmental Management | Environmental Management | |
| GetEnvironment | GetEnvironment | Queries an environment. |
| UpdateEnvironment | UpdateEnvironment | Modifies an environment. |
| DeleteEnvironment | DeleteEnvironment | Deletes an environment. |
| ListEnvironments | ListEnvironments | ListEnvironments |
| API | Title | Description |
|---|---|---|
| ListSecrets | ListSecrets |