DocsICP FilingConsole
Documentation
Home Page API Gateway Cloud-native API Gateway Developer Reference API Reference API overview

API overview

Updated at:
Copy as MD
Product
My Favorites

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 by importing OpenAPI 2.0 and OpenAPI 3.0.x definition files as REST APIs.
DeployHttpApi Publish an API Publishes an HTTP API. This includes REST APIs and routes within HTTP APIs.
CreateHttpApi Create HTTP API Creates an HTTP API.
UpdateHttpApi Update an HTTP API Updates an HTTP API.
GetHttpApi Retrieve HTTP API Retrieves HTTP API information.
ListHttpApis Retrieve a list of HTTP aPIs Retrieves a list of HTTP APIs.
UndeployHttpApi Offline an API Cancels the deployment of an HTTP API.
DeleteHttpApi Delete an HTTP API Deletes a specified HTTP API.

Interface management

API

Title

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

Route management

API

Title

Description
CreateHttpApiRoute Create an HTTP API route Creates a route for an HTTP API.
UpdateHttpApiRoute Update a route Updates a route for 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 the basic information of a gateway, such as the associated VPC, vSwitch, and gateway endpoint.
ListGateways List gateways Queries a list of gateways.
AddGatewaySecurityGroupRule Add gateway security group rule Authorizes a security group for gateway access to services.
DeleteGateway Delete a gateway Deletes a gateway.
DeleteGatewaySecurityGroupRule Delete a gateway security group rule Deletes a gateway security group rule.
ListZones Query zones Retrieves the zones available for a cloud-native API gateway in a specified 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 List consumer groups 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 Add consumer group members in batches 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 List 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 API consumer authorization rules in batches.
DeleteConsumer Delete a consumer Deletes a consumer.
ListConsumers Retrieve API consumer list Retrieves a list of API consumers.
DeleteConsumerAuthorizationRule Delete an API consumer authorization rule Deletes an API consumer authorization rule.
CreateConsumer Create an API consumer Creates an API 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 consumer authorization rules Retrieves consumer authorization rules.

Policy management

API

Title

Description
ListPolicyClasses Retrieve policy templates Retrieves policy templates.
UpdatePolicy Update a policy Updates a policy.
CreatePolicyAttachment Create a policy attachment Creates a policy attachment to a resource.
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 plug-in list Retrieves a list of plug-ins.
CreatePluginAttachment Mount a plug-in Mounts a plug-in.
GetPluginAttachment Get a plugin attachment Queries a plugin attachment.
ListPluginAttachments Retrieve plugin mounts Retrieves the list of plugin mounts.
UpdatePluginAttachment Update 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 the resource overview information.

Legacy aPIs

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 Retrieve plug-in list Retrieves plug-ins.
ListConsumerAuthorizationRules Retrieve consumer authorization rules Retrieves the list of consumer authorization rules.
ListSecretReferences List secret references Lists secret references.
UpdateSecret Update a secret Updates a secret.
GetSecret Retrieve a key Retrieves a key.
AddGatewayQuotaRule Create 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 a service Creates a service.
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 from 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 the region list of APIG 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 Retrieve usage details of a consumer subject under a quota rule Queries the usage details of a subject for a gateway quota throttling rule, including the used quota, total quota, over-limit status, 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 secret value Retrieves the value of a secret.
GetService Retrieve service details Retrieves the details of a service.
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 Retrieve external services Retrieves external service information for a gateway.
ListGatewayQuotaRules Query finOps quota rules Queries the FinOps quota rules associated with a gateway.
ListPolicies Query policy list Queries a list of policies.
ListSecrets List keys Lists keys.
ListServices List services Retrieves the list of services.
ListTagResources Retrieve resource tags Retrieves a list of resource tags.
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 Update a finOps quota rule Updates 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. Supports updating the health check configuration, DNS domain names, and static address configurations of the service.

Other (uncategorized documents)

API

Title

Description
VerifyMigrationTask Validate a migration task Validates a migration task.
UpdateRiskNotification Update risk item notification muting rule Updates the notification configuration for risk items.
UpdateNetworkAccess Change gateway network access type Changes the network access type of a gateway.
UpdateMigrationTask Update a migration task Updates a migration task.
UpdateGatewayMaintenancePeriod Update the maintenance time window configuration of a serverless gateway Modifies the O&M window of a gateway.
UpdateGatewayLoadBalancer Update a gateway load balancer Updates a Gateway Load Balancer (GWLB).
UpdateGatewayElasticPolicy Update gateway elastic policy Updates the elastic policy of a gateway.
UpdateAuthorizationRule Update an authorization rule Updates an authorization rule.
RunPluginPipeline Trigger a codeup pipeline build in a plug-in workspace Runs a pipeline in a plug-in workspace.
RefreshPluginOAuthCode Save or renew the codeup oAuth authorization code for the current user Refreshes the OAuth code for the plugin-managed repository.
ListSyncMCPServer List MCP servers pending synchronization Lists MCP servers that are pending synchronization.
ListSources Query source list Retrieves a list of sources.
ListRiskCheckResults List risk detection task results for a specified gateway by page Queries risk detection results.
ListPluginWorkspace Query plugin workspaces filtered by gateway type for the current user Retrieves the list of plugin WebIDE workspaces for the current user.
ListPluginRepositories Query codeup organization list and repositories for the current user Queries the list of repositories and organization information for custom plugins hosted on Codeup. Before calling this operation, enable code hosting on Codeup, create organizations and repositories, and authorize API Gateway to access the Codeup account.
ListMigrationTasks List migration tasks Lists migration tasks.
ListK8sClusterSources Query clusters available as kubernetes sources Queries the list of clusters that can be added as Kubernetes sources.
ListInstallableGateways Retrieve installable gateways Retrieves gateways on which a plugin can be installed.
ListGlobalPolicies Retrieve global policies Retrieves global policies.
ListGatewayLoadBalancers Retrieve gateway load balancer list Retrieves the list of load balancers for a gateway.
ListGatewayErrorAccessLogs List gateway error access logs Lists gateway error access logs.
ListConsumerGroupQuotaRules Query quota rules configured for a consumer group Queries the list of quota throttling rules for a consumer group.
ListBatchExportTasks Query batch export tasks Queries a list of batch export tasks.
InvokeAIAgent Call an AI agent Calls an AI agent.
GetRiskNotification Query the risk notification muting rule for a specific risk item of a gateway Retrieves the notification configuration for a risk item.
GetPluginWorkspace Query plugin workspace details Queries the WebIDE workspace of a plugin.
GetMigrationTask Retrieve a migration task Retrieves a migration task.
GetMigrationNamespacedServices Retrieve namespaced services for migration Retrieves the namespaced services for a migration task.
GetGatewayResourceQuotaUsage Query gateway resource quotas and usage Queries the resource quotas and usage of a gateway.
GetGatewayElasticPolicy Retrieve gateway elastic scaling rule Retrieves the elastic scaling rule of a gateway.
GetBatchImportTask Query a batch import task Queries a batch import task. The task ID is returned after a batch import task is created by calling BatchImportHttpApis. Pass an empty string to list all existing batch import tasks.
GetBatchExportTask Query a batch export task Queries a batch export task.
DeletePluginClass Delete a custom plugin class Deletes a custom plugin class.
DeleteMigrationTask Delete a data migration task Deletes a data migration task.
CreateRiskCheckTask Create a gateway risk detection task (health check) Creates a risk check task.
CreatePluginWorkspace Create a plugin workspace Creates a WebIDE workspace for a plugin.
CreateMigrationTask Create a migration task Creates a migration task.
CreateHttpApiVersion Create an httpApi version Creates an API version.
BatchUpdateHttpApiOperation Batch update HTTP API operations Updates HTTP API operations in batches.
BatchExportHttpApis Batch export HTTP aPIs Batch exports HTTP APIs.
BatchImportHttpApis Batch import HTTP aPIs Imports HTTP APIs in batches.
Previous：API ReferenceNext：Endpoints