API标准及多语言预置SDK
本产品（OpenAPIExplorer/2024-11-30）的OpenAPI采用ROA签名风格。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
自定义签名场景
若您的业务场景有特殊需求，需通过自签名方式对接 API，建议优先咨询我们的技术支持团队（服务钉钉群：147535001692），获取专业指导以确保高效接入。
账号与安全准备
阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露，所有相关资源都将面临未经授权访问的风险。为确保安全，建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey，同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下，才使用阿里云账号。
ApiMcpServerCore
|
API |
标题 |
API概述 |
| UpdateApiMcpServerCore | 更新ApiMcpServerCore | 更新ApiMcpServerCore。 |
| ListApiMcpServerCores | 列出ApiMcpServerCore | 列出资源ApiMcpServerCore。 |
| GetApiMcpServerCore | 查询 ApiMcpServerCore | 查询 ApiMcpServerCore。 |
| DeleteApiMcpServerCore | 删除ApiMcpServerCore | 删除ApiMcpServerCore。 |
| CreateApiMcpServerCore | 创建 API MCP Core服务 | 创建ApiMcpServerCore。 |
ApiMcpServer全局配置
|
API |
标题 |
API概述 |
| UpdateApiMcpServerUserConfig | 修改API MCP Server全局配置 | 修改用户全局API MCP Server配置。 |
| GetApiMcpServerUserConfig | 获取API MCP Server全局配置 | 查询用户全局API MCP Server配置，当前能力包含配置是否开启公网访问及配置在VPC下请求的来源VPC ID白名单。 |
开放元数据
|
API |
标题 |
API概述 |
| ListApiDefinitions | 获取产品的开放元数据 | 获取产品的开放元数据。 |
| GetProductEndpoints | 获取产品的接入点信息 | 获取产品的接入点信息。 |
| GetApiDefinition | 获取产品相关接口的开放元数据 | 获取产品相关接口的开放元数据。 |
| GenerateCLICommand | 动态生成Aliyun CLI命令 | 动态生成Aliyun CLI命令。 |
| ListProducts | 查询阿里云云产品 | 查询阿里云全部云产品，支持通过关键词过滤 |
| GetCodeSample | 获取代码示例 | 获取SDK代码示例 |
| GetSdkDependencies | 获取Sdk的依赖信息 | 获取SDK信息 |
ApiMcpServer
|
API |
标题 |
API概述 |
| CreateApiMcpServer | 创建 API MCP 服务 | 创建 API MCP 服务。 |
| UpdateApiMcpServer | 修改API MCP服务 | 修改API MCP服务。 |
| GetApiMcpServer | 查询API MCP服务详细信息 | 查询API MCP服务详细信息。 |
| DeleteApiMcpServer | 删除 API MCP 服务 | 删除单个API MCP服务。 |
| ListApiMcpServers | 查询API MCP 服务列表 | 查询父账号下所有API MCP服务器的列表。 |
| ApiMcpServerValidateHcl | 验证 Terraform 的 HCL 语法 | 验证 Terraform 的 HCL 语法。 |
| ListApiMcpServerSystemTools | 查询 MCP 服务支持的系统工具 | 查询 MCP 服务支持的系统工具。 |
诊断
|
API |
标题 |
API概述 |
| GetErrorCodeSolutions | 查询报错诊断方案 | 根据提供的错误码获取对应的错误诊断解决方案 |
| GetRequestLog | 查询API调用日志 | 通过 API 返回的Request ID查询请求的日志详情，可用于排查故障。 |
| GetOwnRequestLog | 查询当前账号的API调用日志 | 通过 API 返回的Request ID 查询当前账号调用 OpenAPI 的日志详情，用于故障排查 |
该文章对您有帮助吗？