API overview

更新时间:
复制 MD 格式

API standard and pre-built SDKs in multi-language

The OpenAPI specification of this product (OpenAPIExplorer/2024-11-30) follows the ROA 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.

ApiMcpServer global configuration

API

Title

Description

UpdateApiMcpServerUserConfig UpdateApiMcpServerUserConfig Updates the global API MCP Server configuration for a user.
GetApiMcpServerUserConfig GetApiMcpServerUserConfig Queries the global API MCP Server configuration for a user. The configuration includes settings for public network access and the whitelist of source VPC IDs for requests from a VPC.

Others

API

Title

Description

ApiMcpServerValidateHcl ApiMcpServerValidateHcl Validates the syntax of HashiCorp Configuration Language (HCL) for Terraform.
CreateApiMcpServer Create API MCP Server Creates an API MCP server.
CreateApiMcpServerCore CreateApiMcpServerCore Creates an ApiMcpServerCore resource.
DeleteApiMcpServer DeleteApiMcpServer Deletes an API MCP service.
DeleteApiMcpServerCore DeleteApiMcpServerCore Deletes an ApiMcpServerCore resource.
GenerateCLICommand GenerateCLICommand Generates an Alibaba Cloud CLI command dynamically.
GetApiDefinition GetApiDefinition Queries the metadata for an API operation of a cloud service.
GetApiMcpServer Query API MCP service details Queries the details of an API MCP service.
GetApiMcpServerCore GetApiMcpServerCore Retrieves the details of a specified ApiMcpServerCore resource.
GetCodeSample GetCodeSample Get SDK code sample
GetErrorCodeSolutions Query Error Diagnostic Solutions Obtains the corresponding error diagnostic solutions based on the provided error code.
GetOwnRequestLog Query API call logs of the current account Query the OpenAPI call log details for the current account by using the Request ID returned by the API. Used for troubleshooting.
GetProductEndpoints GetProductEndpoints Quries the endpoint information for a cloud service.
GetRequestLog GetRequestLog Use the request ID from an API response to find the corresponding logs for troubleshooting.
GetSdkDependencies GetSdkDependencies Retrieves SDK dependency information.
ListApiDefinitions ListApiDefinitions Retrieves the OpenAPI metadata for a product.
ListApiMcpServerCores ListApiMcpServerCores Lists ApiMcpServerCore resources.
ListApiMcpServerSystemTools ListApiMcpServerSystemTools Lists the system tools supported by the MCP service.
ListApiMcpServers Query API MCP server list Queries the list of all API MCP servers under the parent account.
ListProducts ListProducts Lists all Alibaba Cloud products. You can filter the results by keyword.
UpdateApiMcpServer Modify an API MCP service Modifies an API MCP service.
UpdateApiMcpServerCore UpdateApiMcpServerCore Updates an ApiMcpServerCore resource.