API overview-API Gateway(API Gateway)-阿里云帮助中心

API standards and multilingual preset SDKs

The OpenAPI of this product (APIG/2024-03-27) uses the ROA signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.

Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.

Custom signature scenarios

If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.

Account and security preparation

Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.

API management

API	Title	Description
ExportHttpApi	Export an HTTP API	Exports a specified HTTP API.
ImportHttpApi	Import an HTTP API	Imports an HTTP API. Supports importing OpenAPI 2.0 and OpenAPI 3.0.x definition files as REST-type APIs.
DeployHttpApi	Publish API	Publishes an HTTP API. This includes REST APIs and routes within HTTP APIs.
CreateHttpApi	Create an HTTP API	Creates an HTTP API.
UpdateHttpApi	Update an HTTP API	Updates an HTTP API.
GetHttpApi	Get HTTP API	Retrieves the information of an HTTP API.
ListHttpApis	List HTTP aPIs	Retrieves a list of HTTP APIs.
UndeployHttpApi	Offline API	Cancels the deployment of an HTTP API.
DeleteHttpApi	Delete an HTTP API	Deletes a specified HTTP API.

Operation management

API	Title	Description
CreateHttpApiOperation	Create operations	Creates operations for an HTTP API.
GetHttpApiOperation	Retrieve operation information	Retrieves operation information.
UpdateHttpApiOperation	Update an API operation	Updates an API operation.
ListHttpApiOperations	List API operations	Retrieves the list of API operations.
DeleteHttpApiOperation	Delete an operation	Deletes a specified operation.

Route management

API	Title	Description
CreateHttpApiRoute	Create an HTTP API route	Creates a route for an HTTP API.
UpdateHttpApiRoute	Update route	Updates a route of an HTTP API.
GetHttpApiRoute	Query route details	Retrieves the route details of an HTTP API.
DeleteHttpApiRoute	Delete a route	Deletes a route of an HTTP API.
ListHttpApiRoutes	Query route list	Queries the route list of an HTTP API.

Service management

API	Title	Description
CreateServiceVersion	Create a service version	Creates a service version.
UpdateServiceVersion	Update a service version	Updates a service version.
DeleteServiceVersion	Delete a service version	Deletes a service version.

Gateway management

API	Title	Description
CreateGateway	Create a gateway	Creates a cloud-native gateway.
UpdateGatewayName	Modify gateway name	Modifies the name of a gateway.
UpdateGatewayFeature	Update gateway attribute parameters	Updates the attribute parameters of a gateway.
UpgradeGateway	Upgrade a gateway	Upgrades the gateway version.
GetGateway	Query gateway details	Retrieves basic information about a gateway, including the VPC, vSwitch, and gateway ingress.
ListGateways	Query gateway list	Queries a list of gateways.
AddGatewaySecurityGroupRule	Add gateway security group rule	Authorizes a security group to allow gateway access to services.
DeleteGateway	Delete a gateway	Deletes a gateway.
DeleteGatewaySecurityGroupRule	Delete gateway security group rules	Deletes a security group rule from a gateway.
ListZones	Get zones	Retrieves the zones available for a cloud-native API gateway in a specific region.
RestartGateway	Restart a gateway	Restarts a gateway.
ListGatewayFeatures	Query gateway attribute parameter settings	Queries the list of gateway attribute parameter settings.

Consumer group management

API	Title	Description
CreateConsumerGroup	Create a consumer group	Creates a consumer group.
GetConsumerGroup	Query a consumer group	Queries a consumer group.
ListConsumerGroups	Query consumer group list	Queries the list of consumer groups.
ListConsumerGroupConsumers	Query consumer group members	Queries the member list of a consumer group.
UpdateConsumerGroup	Update a consumer group	Updates a consumer group.
DeleteConsumerGroup	Delete a consumer group	Deletes a consumer group.
BatchAddConsumerGroupConsumers	Batch add consumer group members	Adds members to a consumer group in batches.
BatchRemoveConsumerGroupConsumers	Remove consumer group members in batches	Removes consumer group members in batches.

Consumer management

API	Title	Description
RemoveConsumerAuthorizationRule	Delete an API consumer authorization rule	Deletes an API consumer authorization rule.
QueryConsumerAuthorizationRules	Query consumer authorization rules	Queries the list of consumer authorization rules.
CreateConsumerAuthorizationRules	Create consumer authorization rules	Creates consumer authorization rules.
BatchDeleteConsumerAuthorizationRule	Batch revoke consumer authorization rules	Revokes consumer authorization rules in batches.
DeleteConsumer	Delete an API consumer	Deletes an API consumer.
ListConsumers	Retrieve consumer list	Retrieves a list of consumers.
DeleteConsumerAuthorizationRule	Delete an API consumer authorization rule	Deletes an API consumer authorization rule.
CreateConsumer	Create a consumer	Creates a consumer.
UpdateConsumer	Update a consumer	Updates a consumer.
GetConsumer	Retrieve an API consumer	Retrieves an API consumer.
CreateConsumerAuthorizationRule	Create a consumer authorization rule	Creates a consumer authorization rule.
UpdateConsumerAuthorizationRule	Update a consumer authorization rule	Updates a consumer authorization rule.
GetConsumerAuthorizationRule	Retrieve a consumer authorization rule	Retrieves a consumer authorization rule.

Policy management

API	Title	Description
ListPolicyClasses	Retrieve policy templates	Retrieves policy templates.
UpdatePolicy	Update a policy	Updates a policy.
CreatePolicyAttachment	Create a policy mount	Creates a policy resource mount.
GetPolicyAttachment	Query policy attachment	Queries the resource attachment of a policy.
DeletePolicyAttachment	Delete a policy attachment	Deletes a policy attachment.

Plugin management

API	Title	Description
ListPlugins	Retrieve plugin list	Retrieves a list of plugins.
CreatePluginAttachment	Mount a plug-in	Mounts a plug-in.
GetPluginAttachment	Query plugin mount	Queries a plugin mount.
ListPluginAttachments	Get plug-in mount list	Retrieves the plug-in mount list.
UpdatePluginAttachment	Update a plugin mount	Updates a plugin mount.
DeletePluginAttachment	Delete a plugin mount	Deletes a plugin mount.
InstallPlugin	Install a plug-in	Installs a plug-in.
UninstallPlugin	Uninstall a plugin	Uninstalls a plugin.

Domain name management

API	Title	Description
ListSslCerts	Retrieve certificate list	Retrieves a list of certificates.
GetDomain	Query a domain name	Queries a domain name.
CreateDomain	Create a domain name	Creates a domain name.
ListDomains	Query domain name list	Queries a list of domain names.
DeleteDomain	Delete a domain name	Deletes a domain name.
UpdateDomain	Update a domain name	Updates a domain name.

Monitoring management

API	Title	Description
GetTraceConfig	Retrieve trace configuration	Retrieves the Tracing Analysis configuration.
GetDashboard	Retrieve monitoring dashboard	Retrieves the monitoring log dashboard.

Resource management

API	Title	Description
GetResourceOverview	Retrieve resource overview	Retrieves resource overview information.

Legacy operations

API	Title	Description
Environment management	Environment management
GetEnvironment	Query an environment	Queries an environment.
CreateAndAttachPolicy	Create and attach a policy	Creates and attaches a policy.
UpdateAndAttachPolicy	Update and mount a policy	Updates and mounts a policy.

Others

API	Title	Description
ListPluginClasses	Get plug-in list	Retrieves plug-ins.
ListConsumerAuthorizationRules	List consumer authorization rules	Retrieves a list of consumer authorization rules.
ListSecretReferences	List secret references	Lists secret references.
UpdateSecret	Update a key pair	Updates a key pair.
GetSecret	Retrieve a key	Retrieves a key.
AddGatewayQuotaRule	Create a finOps quota rule	Creates a gateway quota throttling rule.
ChangeResourceGroup	Move resource to resource group	Moves a resource to a different resource group.
CreateEnvironment	Create an environment	Creates an environment.
CreatePluginClass	Create a custom plugin class	Creates a custom plugin class.
CreatePolicy	Create a policy	Creates a policy.
CreateSecret	Generate a key	Generates a key.
CreateService	Create services	Creates services.
CreateSource	Create a source	Creates a source.
DeleteEnvironment	Delete an environment	Deletes an environment.
DeleteGatewayQuotaRule	Delete a finOps quota rule	Deletes a quota throttling rule for a gateway.
DeletePolicy	Delete a policy	Deletes a policy.
DeleteSecret	Delete a key value	Deletes a key value.
DeleteService	Delete a service	Deletes a service.
DeleteSource	Delete a service source	Deletes a service source.
DescribeRegions	Query APIG region list	Queries the regions where the cloud-native API gateway is available for the current account.
GetGatewayQuotaRule	Query finOps quota rule details	Queries the details of a gateway quota throttling rule.
GetGatewayQuotaRuleSubjectUsage	Query usage details of a subject under a quota rule	Queries the usage details of a subject under a gateway quota throttling rule, including used quota, total quota, whether the limit is exceeded, usage details, and consumption records.
GetPluginClass	Retrieve a custom plug-in class	Retrieves a custom plug-in class.
GetPolicy	Retrieve a policy	Retrieves a policy.
GetSecretValue	Retrieve key value	Retrieves the value of a key.
GetService	Get service details	Gets service details.
GetSource	Retrieve service source details	Retrieves the details of a service source.
ListConsumerQuotaRules	Query quota rules configured for a consumer	Queries the list of quota rules configured for a specific consumer.
ListEnvironments	Query environment list	Queries the list of environments.
ListExternalServices	Get external services	Retrieves external service information for a gateway.
ListGatewayQuotaRules	Query finOps quota rules	Queries the list of FinOps quota rules bound to a gateway.
ListPolicies	Query policy list	Queries a list of policies.
ListSecrets	List keys	Lists keys.
ListServices	Query service list	Retrieves a list of services.
ListTagResources	Retrieve resource label list	Retrieves the list of resource labels.
ResetGatewayQuotaRule	Reset a finOps quota rule	Resets a quota throttling rule on a gateway.
TagResources	Tag resources	Tags resources.
UntagResources	Remove resource tags	Removes tags from resources.
UpdateEnvironment	Update an environment	Updates an environment.
UpdateGatewayQuotaRule	Edit a finOps quota rule	Edits a quota throttling rule on a gateway.
UpdateGatewayQuotaRuleStatus	Enable or disable a finOps quota rule	Enables or disables a quota throttling rule for a gateway.
UpdateService	Update a service	Updates a service. You can update the health check configuration, DNS domain name, and address configuration of fixed addresses for the service.