API概览
最近更新时间: 2024-10-18 10:38:31
API版本
V3
API文档相关接口
| 接口名称 | 接口功能 |
|---|---|
| BuildAPIDoc | 构建 API 文档 |
| CreateAPIDoc | 创建 API 文档 |
| DeleteAPIDoc | 删除 API 文档 |
| DescribeAPIDocDetail | 查询 API 文档详情 |
| DescribeAPIDocs | 查询 API 文档列表 |
| ModifyAPIDoc | 修改 API 文档 |
| ResetAPIDocPassword | 重置API文档密码 |
API相关接口
| 接口名称 | 接口功能 |
|---|---|
| CreateApi | 创建API |
| DeleteApi | 删除API |
| DescribeApi | 查询API详情 |
| DescribeApiUsagePlan | 查询 API 使用计划详情 |
| DescribeApisStatus | 查询 API 接口列表 |
| ModifyApi | 修改API |
| ModifyApiIncrement | 增量更新API接口 |
IP策略相关接口
| 接口名称 | 接口功能 |
|---|---|
| BindIPStrategy | API绑定IP策略 |
| CreateIPStrategy | 创建服务IP策略 |
| DeleteIPStrategy | 删除服务IP策略 |
| DescribeIPStrategy | 查询IP策略详情 |
| DescribeIPStrategyApisStatus | 查询IP策略绑定的API列表 |
| DescribeIPStrategysStatus | 查询服务IP策略列表 |
| ModifyIPStrategy | 修改服务IP策略 |
| UnBindIPStrategy | 服务解绑IP策略 |
使用计划相关接口
| 接口名称 | 接口功能 |
|---|---|
| BindEnvironment | 绑定使用计划到服务或API |
| BindSecretIds | 使用计划绑定密钥 |
| CreateUsagePlan | 创建使用计划 |
| DeleteUsagePlan | 删除使用计划 |
| DemoteServiceUsagePlan | 服务级别使用计划降级 |
| DescribeUsagePlan | 查询使用计划详情 |
| DescribeUsagePlanEnvironments | 查询使用计划绑定环境列表 |
| DescribeUsagePlanSecretIds | 查询使用计划绑定密钥列表 |
| DescribeUsagePlansStatus | 查询使用计划列表 |
| ModifyUsagePlan | 修改使用计划 |
| UnBindEnvironment | 从服务环境解绑使用计划 |
| UnBindSecretIds | 使用计划解绑密钥 |
密钥相关接口
| 接口名称 | 接口功能 |
|---|---|
| CreateApiKey | 创建密钥 |
| DeleteApiKey | 删除密钥 |
| DescribeApiKey | 查询密钥详情 |
| DescribeApiKeysStatus | 查询密钥列表 |
| DisableApiKey | 禁用密钥 |
| EnableApiKey | 启用密钥 |
| UpdateApiKey | 更换密钥 |
应用相关接口
| 接口名称 | 接口功能 |
|---|---|
| BindApiApp | 绑定应用到API |
| CreateApiApp | 创建应用 |
| DeleteApiApp | 删除应用 |
| DescribeApiApp | 搜索应用 |
| DescribeApiAppBindApisStatus | 查询应用绑定的Api列表 |
| DescribeApiAppsStatus | 查询应用列表 |
| DescribeApiBindApiAppsStatus | 查询Api绑定的应用列表 |
| DescribeApiForApiApp | 应用使用者查询API详情 |
| DescribeServiceForApiApp | 应用使用者查询服务详情 |
| ModifyApiApp | 修改应用 |
| UnbindApiApp | 解除应用和API绑定关系 |
| UpdateApiAppKey | 更新应用秘钥 |
插件相关接口
| 接口名称 | 接口功能 |
|---|---|
| AttachPlugin | 插件绑定API |
| CreatePlugin | 创建插件 |
| DeletePlugin | 删除插件 |
| DescribeAllPluginApis | 展示插件相关的API列表 |
| DescribePlugin | 查询插件详情 |
| DescribePluginApis | 查询插件绑定的API列表 |
| DescribePlugins | 查询插件列表和详情 |
| DetachPlugin | 插件解绑API |
| ModifyPlugin | 修改插件 |
文档和SDK相关接口
| 接口名称 | 接口功能 |
|---|---|
| GenerateApiDocument | 生成文档和 SDK |
日志相关接口
| 接口名称 | 接口功能 |
|---|---|
| DescribeLogSearch | 日志搜索服务 |
服务相关接口
| 接口名称 | 接口功能 |
|---|---|
| CreateService | 创建服务 |
| DeleteService | 删除服务 |
| DescribeService | 查询服务详情 |
| DescribeServiceEnvironmentList | 查询服务环境列表 |
| DescribeServiceEnvironmentReleaseHistory | 查询服务环境的发布历史 |
| DescribeServiceReleaseVersion | 查询服务已发布的版本 |
| DescribeServiceUsagePlan | 查询服务使用计划详情 |
| DescribeServicesStatus | 查询服务列表 |
| ModifyService | 修改服务 |
| ReleaseService | 发布服务 |
| UnReleaseService | 下线服务 |
| UpdateService | 更新服务版本 |
自定义域名相关接口
| 接口名称 | 接口功能 |
|---|---|
| BindSubDomain | 服务绑定自定义域名 |
| DeleteServiceSubDomainMapping | 删除自定义域名的路径映射 |
| DescribeServiceSubDomainMappings | 查询自定义域名的路径映射 |
| DescribeServiceSubDomains | 查询自定义域名列表 |
| ModifySubDomain | 服务修改自定义域名 |
| UnBindSubDomain | 服务解绑自定义域名 |
限流策略相关接口
| 接口名称 | 接口功能 |
|---|---|
| DescribeApiEnvironmentStrategy | 展示API绑定的限流策略 |
| DescribeServiceEnvironmentStrategy | 展示服务限流策略 |
| ModifyApiEnvironmentStrategy | 修改API限流策略 |
| ModifyServiceEnvironmentStrategy | 修改服务限流策略 |