API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (CloudAPI/2016-07-14) follows the RPC 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.
API list
|
API |
Title |
Description |
| AbolishApi | AbolishApi | Unpublishes a specified API from a specified runtime environment. |
| AddAccessControlListEntry | AddAccessControlListEntry | This feature provides instance-level access control capabilities for dedicated instances. Adds an IP address entry to the access control polocy of an instance. |
| AddIpControlPolicyItem | AddIpControlPolicyItem | Adds a policy to an existing ACL. |
| AddTrafficSpecialControl | AddTrafficSpecialControl | Adds a custom special policy to a specified throttling policy. |
| AssociateInstanceWithPrivateDNS | AssociateInstanceWithPrivateDNS | Associates an internal domain name resolution with a dedicated instance. |
| AttachApiProduct | AttachApiProduct | Attaches APIs to an API product. If the API product does not exist, the system automatically creates the API product. |
| AttachGroupPlugin | Attach plugin to group | Attach plugin to API group. |
| AttachPlugin | AttachPlugin | Binds a plug-in to an API. |
| BatchAbolishApis | BatchAbolishApis | Unpublishes multiple published APIs at a time. |
| BatchDeployApis | BatchDeployApis | Publishes multiple APIs at a time. |
| CreateAccessControlList | CreateAccessControlList | This feature provides instance-level access control capabilities for dedicated instances. Creates an Access Control List (ACL). Each user is allowed to create five ACLs in each region. |
| CreateApi | CreateApi | Creates an API. |
| CreateApiGroup | CreateApiGroup | Creates an API group. |
| CreateApiStageVariable | CreateApiStageVariable | Adds a variable to an environment. |
| CreateApp | CreateApp | Creates an app for API Gateway. |
| CreateAppCode | CreateAppCode | Adds an AppCode to an application. |
| CreateAppKey | CreateAppKey | Adds an AppKey and AppSecret pair to an application. |
| CreateBackend | CreateBackend | Creates a backend service in API Gateway. |
| CreateBackendModel | CreateBackendModel | Creates a backend service configuration in an environment. |
| CreateDataset | CreateDataset | Creates a custom dataset. |
| CreateDatasetItem | CreateDatasetItem | Creates a data entry in a custom dataset. |
| CreateInstance | CreateInstance | Creates an API Gateway instance. |
| CreateIpControl | CreateIpControl | Creates an access control list (ACL) in a region. |
| CreateLogConfig | CreateLogConfig | Creates a Simple Log Service configuration for an API. |
| CreateModel | CreateModel | Creates a model for an API group. |
| CreateMonitorGroup | CreateMonitorGroup | Enables CloudMonitor alerting for a specified API group. |
| CreatePlugin | CreatePlugin | Creates a plug-in. |
| CreatePrivateDNS | CreatePrivateDNS | Creates an internal domain name resolution and adds a resolution record. |
| CreateSignature | CreateSignature | Creates a backend signature key. |
| CreateTrafficControl | CreateTrafficControl | Creates a custom throttling policy. |
| DeleteAccessControlList | DeleteAccessControlList | This feature provides instance-level access control capabilities for dedicated instances. Deletes an access control policy. |
| DeleteAllTrafficSpecialControl | DeleteAllTrafficSpecialControl | Deletes all custom special policies of a specified throttling policy. |
| DeleteApi | DeleteApi | Deletes the definition of a specified API. |
| DeleteApiGroup | DeleteApiGroup | Deletes an API group. |
| DeleteApiProduct | DeleteApiProduct | Deletes an API product. Deleting an API product causes the association between APIs and the deleted API product to be deleted as well. Exercise caution when you delete an API product. If any API in the API product is associated with an application, the API product fails to be deleted. |
| DeleteApiStageVariable | DeleteApiStageVariable | Deletes a specified variable in a specified environment. |
| DeleteApp | DeleteApp | Deletes a specified app. |
| DeleteAppCode | DeleteAppCode | Deletes the AppCode of an application. |
| DeleteAppKey | DeleteAppKey | Deletes the AppKey and AppSecret of an application. |
| DeleteBackend | DeleteBackend | Deletes a backend service. |
| DeleteBackendModel | DeleteBackendModel | Deletes the definition of a backend service in an environment. After the definition is deleted, the API that uses the backend service and is published to this environment will be unpublished. |
| DeleteDataset | DeleteDataset | Deletes a custom dataset. |
| DeleteDatasetItem | DeleteDatasetItem | Deletes a data entry from a custom dataset. |
| DeleteDomain | DeleteDomain | Unbinds a custom domain name from an API group. |
| DeleteDomainCertificate | DeleteDomainCertificate | Deletes the SSL certificate of a specified domain name. This operation is intended for API providers. If the SSL certificate does not exist, a success response is still returned. If the specified API group does not exist, the InvalidGroupId.NotFound error is returned. Access over HTTPS is not supported after the SSL certificate is deleted. Exercise caution when using this API operation. |
| DeleteInstance | DeleteInstance | Deletes an API Gateway instance. |
| DeleteIpControl | DeleteIpControl | Deletes an access control list (ACL). |
| DeleteLogConfig | DeleteLogConfig | Deletes a log configuration. |
| DeleteModel | DeleteModel | Deletes a model. |
| DeleteMonitorGroup | DeleteMonitorGroup | Deletes a CloudMonitor application group corresponding to an API group. |
| DeletePlugin | DeletePlugin | Deletes a plug-in. |
| DeletePrivateDNS | DeletePrivateDNS | Deletes an internal domain name resolution. |
| DeleteSignature | DeleteSignature | Deletes a backend signature key. |
| DeleteTrafficControl | DeleteTrafficControl | Deletes a custom throttling policy and the special throttling rules in the policy. |
| DeleteTrafficSpecialControl | DeleteTrafficSpecialControl | Deletes a custom special throttling policy. |
| DeployApi | DeployApi | Publishes an API to a specified environment. |
| DescribeAbolishApiTask | DescribeAbolishApiTask | Queries the progress of an API unpublishing task. |
| DescribeAccessControlListAttribute | DescribeAccessControlListAttribute | This feature provides instance-level access control for dedicated instances. Queries the details of an access control policy. |
| DescribeAccessControlLists | DescribeAccessControlLists | This feature provides instance-level access control for dedicated instances. Queries access control policies. |
| DescribeApi | DescribeApi | Retrieves the definition of a specified API. |
| DescribeApiDoc | DescribeApiDoc | Queries the documentation of an API. |
| DescribeApiGroup | DescribeApiGroup | Queries the details of a specified API group, including its system-generated second-level domain name, custom domain names, and SSL Certificate information. |
| DescribeApiGroupVpcWhitelist | DescribeApiGroupVpcWhitelist | Queries the VPC whitelist that is allowed to access an API group. |
| DescribeApiGroups | DescribeApiGroups | Queries existing API groups and their basic information. |
| DescribeApiHistories | DescribeApiHistories | Queries the historical versions of a specified API. |
| DescribeApiHistory | DescribeApiHistory | Queries the details of a specified historical version of a specified API definition. |
| DescribeApiIpControls | DescribeApiIpControls | Queries the access control lists (ACLs) that are bound to all the APIs in an API group in a specified environment. |
| DescribeApiLatencyData | DescribeApiLatencyData | Queries the response time statistics of an API. |
| DescribeApiMarketAttributes | DescribeApiMarketAttributes | Queries the Alibaba Cloud Marketplace attributes of an API. |
| DescribeApiProductApis | DescribeApiProductApis | Queries the attached APIs of an API product. |
| DescribeApiProductsByApp | DescribeApiProductsByApp | Queries API products by application. |
| DescribeApiQpsData | DescribeApiQpsData | Queries the QPS statistics of an API. |
| DescribeApiSignatures | DescribeApiSignatures | Queries the backend signature keys that are bound to the APIs of a specified API group in a specified environment. |
| DescribeApiTrafficControls | DescribeApiTrafficControls | Queries the throttling policies bound to all members of an API group in a specified environment. |
| DescribeApiTrafficData | DescribeApiTrafficData | Queries the statistics on the traffic of an API. |
| DescribeApis | DescribeApis | Queries a list of APIs that are being defined. |
| DescribeApisByApp | DescribeApisByApp | Queries the APIs with which an application is associated. |
| DescribeApisByBackend | DescribeApisByBackend | Queries APIs in the draft or published state that are created by using a specified backend service. |
| DescribeApisByIpControl | DescribeApisByIpControl | Queries the APIs that are bound to an access control list (ACL). |
| DescribeApisBySignature | DescribeApisBySignature | Queries the APIs to which a specified backend signature key is bound. |
| DescribeApisByTrafficControl | DescribeApisByTrafficControl | Queries the APIs to which a specified throttling policy is bound. |
| DescribeApisByVpcAccess | DescribeApisByVpcAccess | Queries the APIs that are associated with a virtual private cloud (VPC) access authorization in a region. |
| DescribeApisWithStageNameIntegratedByApp | DescribeApisWithStageNameIntegratedByApp | Queries APIs by application and returns the result by environment. |
| DescribeApp | DescribeApp | Queries the details of a specified application. You can use this operation to fetch application information for authorization. |
| DescribeAppAttributes | DescribeAppAttributes | Queries a list of applications and their basic information. |
| DescribeAppSecurities | DescribeAppSecurities | Queries the key-related information of an application. |
| DescribeAppSecurity | DescribeAppSecurity | This key is used for authentication when an API call is made. |
| DescribeApps | DescribeApps | Queries the apps of a user. App information is returned only to the app owner. |
| DescribeAppsByApiProduct | DescribeAppsByApiProduct | Queries authorized applications by API product. |
| DescribeAuthorizedApis | DescribeAuthorizedApis | Queries the authorized APIs of a specified APP. |
| DescribeAuthorizedApps | DescribeAuthorizedApps | Queries the current apps. |
| DescribeBackendInfo | DescribeBackendInfo | Queries the information about a backend service and its URL configured for each environment. |
| DescribeBackendList | DescribeBackendList | Queries backend services. You can filter backend services by backend service name and backend service type. |
| DescribeDatasetInfo | DescribeDatasetInfo | Queries the details of a single dataset. |
| DescribeDatasetItemInfo | DescribeDatasetItemInfo | Queries a data entry in a custom dataset. |
| DescribeDatasetItemList | DescribeDatasetItemList | Queries the data entries of a custom dataset. |
| DescribeDatasetList | DescribeDatasetList | Queries a list of custom datasets. |
| DescribeDeployApiTask | DescribeDeployApiTask | Queries the progress of an asynchronous API publishing task. |
| DescribeDeployedApi | DescribeDeployedApi | Queries the definition of an API that takes effect in an environment. The definition may differ from the definition being edited. |
| DescribeDeployedApis | DescribeDeployedApis | Queries the APIs that have been published to a specified environment. |
| DescribeDomain | DescribeDomain | Queries details about a bound custom domain name, including the automatically assigned second-level domain name, custom domain name, and SSL certificate. |
| DescribeGroupLatency | DescribeGroupLatency | Queries the average latency of an API group in an environment. |
| DescribeGroupQps | DescribeGroupQps | Queries the statistics on the number of requests directed to an API group within a period of time. |
| DescribeGroupTraffic | DescribeGroupTraffic | Queries the traffic of an API group. |
| DescribeHistoryApis | DescribeHistoryApis | Queries the historical versions of an API. |
| DescribeImportOASTask | DescribeImportOASTask | Queries the result of an OAS API import task. |
| DescribeInstanceClusterInfo | DescribeInstanceClusterInfo | Queries the information about a dedicated instance cluster. |
| DescribeInstanceClusterList | DescribeInstanceClusterList | Queries dedicated instance clusters. |
| DescribeInstanceDropConnections | DescribeInstanceDropConnections | Queries the number of lost connections to a dedicated instance within a period of time. |
| DescribeInstanceDropPacket | DescribeInstanceDropPacket | Queries the number of dropped packets within a period of time. |
| DescribeInstanceHttpCode | DescribeInstanceHttpCode | Queries the distribution of HTTP status codes of requests to a dedicated instance within a period of time. |
| DescribeInstanceLatency | DescribeInstanceLatency | Queries the average latency of a dedicated instance over a period of time. |
| DescribeInstanceNewConnections | DescribeInstanceNewConnections | Queries the number of new connections to a dedicated instance within a period of time. |
| DescribeInstancePackets | DescribeInstancePackets | Queries the numbers of inbound and outbound packets of a dedicated instance within a period of time. |
| DescribeInstanceQps | DescribeInstanceQps | Queries the number of requests to a dedicated instance within a period of time. |
| DescribeInstanceSlbConnect | DescribeInstanceSlbConnect | Queries the number of concurrent connections to a dedicated instance within a period of time. |
| DescribeInstanceTraffic | DescribeInstanceTraffic | Queries the request traffic and response traffic of a dedicated instance within a period of time. |
| DescribeInstances | DescribeInstances | Describes the details of one or more shared or dedicated instances in a region. |
| DescribeIpControlPolicyItems | DescribeIpControlPolicyItems | Queries the rule entries of an IP address-based traffic control policy. |
| DescribeIpControls | DescribeIpControls | Queries custom access control lists (ACLs) on separate pages. |
| DescribeLogConfig | DescribeLogConfig | Queries the log configuration. |
| DescribeMarketRemainsQuota | DescribeMarketRemainsQuota | Queries the number of remaining ordered relationships for a purchaser. |
| DescribeModels | DescribeModels | Queries the created models of an API group. |
| DescribePluginApis | DescribePluginApis | Queries the APIs to which a specified plug-in is bound. |
| DescribePluginGroups | Query the List of Groups Bound to a Plugin | Query the list of groups bound to a plugin based on the plugin ID |
| DescribePluginSchemas | DescribePluginSchemas | Describes the plugin schemas that API Gateway supports. |
| DescribePluginTemplates | DescribePluginTemplates | Querying plugin templates |
| DescribePlugins | DescribePlugins | Queries API Gateway plug-ins and the details of the plug-ins. |
| DescribePluginsByApi | DescribePluginsByApi | Queries the plug-ins that are bound to a running API in a specified environment. |
| DescribePluginsByGroup | Query Plugins Bound to API Group | Query Plugins Bound to API Group |
| DescribePurchasedApiGroup | DescribePurchasedApiGroup | Queries the details about an API group purchased from Alibaba Cloud Marketplace. |
| DescribePurchasedApiGroups | DescribePurchasedApiGroups | Queries the API groups purchased from Alibaba Cloud Marketplace. |
| DescribePurchasedApis | DescribePurchasedApis | Queries the APIs purchased in the Alibaba Cloud Marketplace. |
| DescribeRegions | DescribeRegions | Queries the Alibaba Cloud regions that are supported by API Gateway. |
| DescribeSignatures | DescribeSignatures | Queries backend signature keys. |
| DescribeSignaturesByApi | DescribeSignaturesByApi | Queries the backend signature keys that are bound to a specified API. |
| DescribeSummaryData | DescribeSummaryData | Queries the number of API Gateway resources in a region. |
| DescribeSystemParameters | DescribeSystemParameters | Queries the common parameters supported by the system. |
| DescribeTrafficControls | DescribeTrafficControls | Queries custom throttling policies and their details. Conditional queries are supported. |
| DescribeTrafficControlsByApi | DescribeTrafficControlsByApi | Queries the throttling policy that is bound to a specific API. |
| DescribeUpdateBackendTask | DescribeUpdateBackendTask | When you modify the definition of a backend service in an environment, the associated published APIs are updated in batches. You can call this operation to query the results of the update. |
| DescribeUpdateVpcInfoTask | DescribeUpdateVpcInfoTask | When you update a VPC authorization, the associated published APIs are updated asynchronously. You can call this operation to query the progress of these API updates. |
| DescribeVpcAccesses | DescribeVpcAccesses | Queries VPC access authorizations. |
| DescribeZones | DescribeZones | Queries zones in a region. |
| DetachApiProduct | DetachApiProduct | Detaches APIs from an API product. |
| DetachGroupPlugin | Unbind the plugin from the group | Unbind group plugin |
| DetachPlugin | DetachPlugin | Detaches a plugin from an API. |
| DisableInstanceAccessControl | DisableInstanceAccessControl | This feature provides instance-level access control capabilities for dedicated API Gateway instances. Disables access control on an instance. |
| DissociateInstanceWithPrivateDNS | DissociateInstanceWithPrivateDNS | Disassociates an internal domain name resolution from a dedicated instance. |
| DryRunSwagger | DryRunSwagger | Checks the syntax before Swagger-compliant data is imported. |
| EnableInstanceAccessControl | EnableInstanceAccessControl | This feature provides instance-level access control capabilities for dedicated API Gateway instances. Specifies the access control policy of an instance. |
| ExportOAS | ExportOAS | Exports APIs based on OpenAPI Specification (OAS). |
| ImportOAS | ImportOAS | Imports OpenAPI Specification (OAS)-compliant data to create an API. |
| ImportSwagger | ImportSwagger | Creates an API by importing Swagger-compliant data. |
| ListPrivateDNS | ListPrivateDNS | Queries private DNS resolution. You can filter the results by private domain name or resolution type. |
| ListTagResources | ListTagResources | Queries the visible resource tags. |
| ModifyApi | ModifyApi | Modifies the definition of an API. |
| ModifyApiConfiguration | ModifyApiConfiguration | This API operation is used to modify the draft definition of an API. It is different from the ModifyApi operation in that it does not require all information about the API. You need to only specify the parameters that you want to modify. For example, if you want to change the authentication method of the API from Anonymous to APP, you need to only specify the value of AuthType, which is APP. |
| ModifyApiGroup | ModifyApiGroup | Modifies the name, description, or base path of an existing API group. |
| ModifyApiGroupInstance | ModifyApiGroupInstance | Modifies a group instance. |
| ModifyApiGroupNetworkPolicy | ModifyApiGroupNetworkPolicy | Modifies the network policy of an API group. |
| ModifyApiGroupVpcWhitelist | ModifyApiGroupVpcWhitelist | Modifies the VPC whitelist of an API group. |
| ModifyApp | ModifyApp | Modifies a specified application. |
| ModifyBackend | ModifyBackend | Modifies the basic information of a backend service, such as its name and description. Note that the backend service type cannot be modified after the service is created. |
| ModifyBackendModel | ModifyBackendModel | This operation modifies the definition of a backend service in an environment. After the modification, the backend addresses of APIs that use this backend service and are published in this environment are batch updated automatically, without requiring manual publishing. |
| ModifyDataset | ModifyDataset | Modifies the name of a custom dataset. |
| ModifyDatasetItem | ModifyDatasetItem | Modifies the timeout period and description of a data entry in a custom dataset. |
| ModifyInstanceAttribute | ModifyInstanceAttribute | Modifies the properties of an API Gateway instance. |
| ModifyInstanceSpec | ModifyInstanceSpec | Upgrades or downgrades the configurations of an API Gateway instance. |
| ModifyInstanceVpcAttributeForConsole | Modify instance client VPC config | Modify instance client VPC config. |
| ModifyIntranetDomainPolicy | ModifyIntranetDomainPolicy | Modifies the VPC domain name policy of an API group. |
| ModifyIpControl | ModifyIpControl | Modifies an access control list (ACL). |
| ModifyIpControlPolicyItem | ModifyIpControlPolicyItem | Modifies a policy in an access control list (ACL). |
| ModifyLogConfig | ModifyLogConfig | Modifies the log configuration. |
| ModifyModel | ModifyModel | Updates the model of an API group. |
| ModifyPlugin | ModifyPlugin | Modifies the information of a plug-in. |
| ModifySignature | ModifySignature | Modifies a backend signature key. |
| ModifyTrafficControl | ModifyTrafficControl | Modifies the settings of a custom throttling policy. |
| ModifyVpcAccessAndUpdateApis | ModifyVpcAccessAndUpdateApis | Modifies the information of a VPC access authorization and updates the metadata of the associated API. |
| OpenApiGatewayService | OpenApiGatewayService | Activates API Gateway. |
| QueryRequestLogs | QueryRequestLogs | Queries the request logs of a user. |
| ReactivateDomain | ReactivateDomain | Reactivates a custom domain name whose validity status is Abnormal. |
| RemoveAccessControlListEntry | RemoveAccessControlListEntry | This operation is used for instance-level access control on dedicated API Gateway instances and deletes IP address entries from an access control policy. |
| RemoveApiProductsAuthorities | RemoveApiProductsAuthorities | Revokes permissions on API products from an application. |
| RemoveApisAuthorities | RemoveApisAuthorities | Revokes the access permissions on multiple APIs from a specified application. |
| RemoveAppsAuthorities | RemoveAppsAuthorities | Revokes the access permissions on a specified API from multiple apps. In this case, multiple apps map to a single API. |
| RemoveIpControlApis | RemoveIpControlApis | Unbinds an API from an access control list (ACL). |
| RemoveIpControlPolicyItem | RemoveIpControlPolicyItem | Removes one or more policies from an access control list (ACL). |
| RemoveSignatureApis | RemoveSignatureApis | Unbinds a backend signature key from APIs. |
| RemoveTrafficControlApis | RemoveTrafficControlApis | Unbinds a specified throttling policy from APIs. |
| RemoveVpcAccess | RemoveVpcAccess | Deletes a VPC access authorization without unpublishing the associated APIs. |
| RemoveVpcAccessAndAbolishApis | RemoveVpcAccessAndAbolishApis | Removes authorization for a VPC and unpublishes the associated APIs. |
| ResetAppCode | ResetAppCode | Resets the AppCode of an application. You can call this operation only once per minute. |
| ResetAppSecret | ResetAppSecret | Resets the key for an app. |
| SdkGenerateByApp | SdkGenerateByApp | Generates a software development kit (SDK) for an application. |
| SdkGenerateByAppForRegion | SdkGenerateByAppForRegion | Generates a software development kit (SDK) for the APIs associated with an app. |
| SdkGenerateByGroup | SdkGenerateByGroup | Generates a software development kit (SDK) for an API group. |
| SetAccessControlListAttribute | SetAccessControlListAttribute | Modifies the name of an access control policy, a feature that provides instance-level access control for dedicated instances of API Gateway. |
| SetApiProductsAuthorities | SetApiProductsAuthorities | Grants permissions on API products to an application. |
| SetApisAuthorities | SetApisAuthorities | Authorizes a specified application to call multiple APIs. |
| SetAppsAuthToApiProduct | SetAppsAuthToApiProduct | Authorizes multiple applications to call APIs in an API product. |
| SetAppsAuthorities | SetAppsAuthorities | Grants access permissions on a specified API to multiple applications. |
| SetDomain | SetDomain | Binds a custom domain name to a specified API group. |
| SetDomainCertificate | SetDomainCertificate | Uploads an SSL certificate for a specified custom domain name. |
| SetDomainWebSocketStatus | SetDomainWebSocketStatus | Enables or disables WebSocket for a custom domain name. |
| SetIpControlApis | SetIpControlApis | Creates a binding relationship between specified access control lists (ACLs) and APIs. |
| SetSignatureApis | SetSignatureApis | Binds a signature key to APIs. |
| SetTrafficControlApis | SetTrafficControlApis | Binds a throttling policy to APIs. |
| SetVpcAccess | SetVpcAccess | Creates a virtual private cloud (VPC) access authorization and enables reverse access. |
| SetWildcardDomainPatterns | SetWildcardDomainPatterns | Specifies a wildcard domain name template for a bound custom domain name. |
| SwitchApi | SwitchApi | Switches the definition of an API in a specified runtime environment to a historical version. |
| TagResources | TagResources | Adds user tags to resources. |
| UntagResources | UntagResources | Removes tags from resources. |
| UpdatePrivateDNS | UpdatePrivateDNS | Modifies an internal domain name resolution. |
| ValidateVpcConnectivity | ValidateVpcConnectivity | Tests the network connectivity between an API Gateway instance and a port on an Elastic Compute Service (ECS) or Server Load Balance (SLB) instance in a virtual private cloud (VPC) access authorization. |