API概览

最近更新时间: 2024-09-11 15:05:04

API版本

V3

其他接口

接口名称 接口功能
CreateTaskFlow 创建工作流
DescribeBasicResourceUsage TSF基本资源信息概览
DescribeContainerEvents 获取容器事件列表
DescribePodInstances 获取部署组实例列表
DownloadMultipartPkg 分片下载程序包
SearchContainerStdoutLog 查询容器标准输出日志
TerminateTaskFlowBatch 停止一个工作流批次

分布式任务调度相关接口

接口名称 接口功能
ContinueRunFailedTaskBatch 续跑任务批次
CreateTask 创建任务
DeleteTask 删除任务
DescribeFlowLastBatchState 查询工作流最近一个批次的执行状态
DescribeTaskDetail 查询任务详情
DescribeTaskLastStatus 查看任务最近执行批次状态
DisableTask 停用任务
DisableTaskFlow 停用工作流
EnableTask 启用任务
EnableTaskFlow 启用工作流
ExecuteTask 手动执行一次任务。
ExecuteTaskFlow 执行一次工作流
ModifyTask 修改任务
RedoTask 重新执行任务
RedoTaskBatch 重新执行任务批次
RedoTaskExecute 重新执行任务的一次执行
RedoTaskFlowBatch 重新执行工作流批次
StopTaskBatch 停止执行中的任务批次
StopTaskExecute 停止正在执行的任务

命名空间相关接口

接口名称 接口功能
CreateNamespace 创建命名空间
DeleteNamespace 删除命名空间
DescribeSimpleNamespaces 查询简单命名空间列表

应用相关接口

接口名称 接口功能
CreateApplication 创建应用
DeleteApplication 删除应用
DescribeApplication 获取应用详情
DescribeApplicationAttribute 获取应用列表其它字段
DescribeApplications 获取应用列表
DescribeSimpleApplications 查询简单应用列表

微服务网关相关接口

接口名称 接口功能
BindApiGroup 网关与API分组批量绑定
BindPlugin 批量绑定插件
ChangeApiUsableStatus 启用或禁用API
CreateAllGatewayApiAsync 一键导入API分组
CreateApiGroup 创建API分组
CreateApiRateLimitRule 创建API限流规则
CreateGatewayApi 批量导入API至api分组
CreatePathRewrites 创建路径重写
CreateUnitRule 创建单元化规则
CreateWildCardGatewayApi 创建通配符API
DeleteApiGroup 删除Api分组
DeletePathRewrites 删除路径重写
DeleteUnitNamespaces 删除单元化命名空间
DeleteUnitRule 删除单元化规则
DescribeApiGroup 查询API分组
DescribeApiGroups 查询API 分组信息列表
DescribeApiRateLimitRules 查询API限流规则
DescribeApiUseDetail 查询网关API监控明细数据
DescribeEnabledUnitRule 查询生效的单元化规则
DescribeGatewayAllGroupApis 查询网关所有分组下Api列表
DescribeGatewayMonitorOverview 查询网关监控概览
DescribeGroupBindedGateways 查询某个API分组已绑定的网关部署组信息列表
DescribeGroupGateways 查询某个网关绑定的API 分组信息列表
DescribeGroupUseDetail 查询网关分组监控明细数据
DescribeGroupsWithPlugin 查询某个插件下绑定或未绑定的API分组
DescribePathRewrite 查询路径重写
DescribePathRewrites 查询路径重写列表
DescribePluginInstances 查询网关分组或API绑定(或未绑定)的插件列表
DescribeUnitApiUseDetail 网关调用监控统计查询类
DescribeUnitNamespaces 查询单元化命名空间列表
DescribeUnitRule 查询单元化规则详情
DescribeUnitRules 查询单元化规则列表
DescribeUsableUnitNamespaces 查询可用于被导入的命名空间列表
DisableUnitRoute 禁用单元化路由
DisableUnitRule 禁用单元化规则
DraftApiGroup 下线Api分组
EnableUnitRoute 启用单元化路由
EnableUnitRule 启用单元化规则
ModifyPathRewrite 修改路径重写
ReleaseApiGroup 发布Api分组
UnbindApiGroup API分组批量与网关解绑
UpdateApiGroup 更新Api分组
UpdateApiRateLimitRule 更新API限流规则
UpdateApiRateLimitRules 批量更新API限流规则
UpdateApiTimeouts 更新API超时
UpdateGatewayApi 更新API
UpdateUnitRule 更新单元化规则

服务治理相关接口

接口名称 接口功能
CreateLane 创建泳道
CreateLaneRule 创建泳道规则
DeleteLane 删除泳道
DescribeLaneRules 查询泳道规则列表
DescribeLanes 查询泳道列表
ModifyLane 更新泳道信息
ModifyLaneRule 更新泳道规则

服务相关接口

接口名称 接口功能
CreateMicroservice 新增微服务
DeleteMicroservice 删除微服务
DescribeApiDetail 查询API详情
DescribeApiVersions 查询API版本
DescribeCreateGatewayApiStatus 查询一键导入API分组任务的状态
DescribeMicroservice 查询微服务详情
DescribeMicroservices 获取微服务列表
DescribeMsApiList 查询服务API列表
ModifyMicroservice 修改微服务详情

程序包相关接口

接口名称 接口功能
CreateRepository 创建仓库
DeletePkgs 批量删除包
DeleteRepository 删除仓库
DescribeDownloadInfo 获取下载程序包信息
DescribePkgs 获取某个应用的程序包信息列表
DescribeRepositories 查询仓库列表
DescribeRepository 查询仓库信息
DescribeUploadInfo 获取上传程序包信息
ModifyUploadInfo 更新上传程序包信息
UpdateRepository 更新仓库信息

部署组相关接口

接口名称 接口功能
CreateContainGroup 创建容器部署组
CreateGroup 创建虚拟机部署组
CreateSecret 创建镜像凭证
CreateServerlessGroup 创建Serverless部署组
DeleteContainerGroup 删除容器部署组
DeleteGroup 删除虚拟机部署组
DeleteServerlessGroup 删除部署组
DeployContainerGroup 部署容器应用
DeployGroup 部署虚拟机部署组应用
DeployServerlessGroup 部署Serverless应用
DescribeContainerGroupDetail 查询容器部署组详情
DescribeContainerGroups 容器部署组列表
DescribeGroup 查询虚拟机部署组详情
DescribeGroupInstances 查询虚拟机部署组云主机列表
DescribeGroups 获取虚拟机部署组列表
DescribeSecretList 获取凭证列表
DescribeSecretNames 获取凭证名称列表
DescribeServerlessGroup 查询Serverless部署组明细
DescribeServerlessGroups 查询Serverless部署组列表
DescribeSimpleGroups 查询简单部署组列表
ExpandGroup 虚拟机部署组添加实例
ModifyContainerGroup 修改容器部署组
ModifyContainerReplicas 修改容器部署组实例数
ShrinkGroup 缩容虚拟机部署组
ShrinkInstances 虚拟机部署组下线实例
StartContainerGroup 启动容器部署组
StartGroup 启动虚拟机部署组
StopContainerGroup 停止容器部署组
StopGroup 停止虚拟机部署组
UpdateHealthCheckSettings 更新健康检查配置

配置管理相关接口

接口名称 接口功能
CreateConfig 创建配置项
CreatePublicConfig 创建公共配置项
DeleteConfig 删除配置项
DeletePublicConfig 删除公共配置项
DescribeConfig 查询配置
DescribeConfigReleaseLogs 查询配置发布历史
DescribeConfigReleases 查询配置发布信息
DescribeConfigSummary 查询配置汇总列表
DescribeConfigs 查询配置项列表
DescribePublicConfig 查询公共配置(单条)
DescribePublicConfigReleaseLogs 查询公共配置发布历史
DescribePublicConfigReleases 查询公共配置发布信息
DescribePublicConfigSummary 查询公共配置汇总列表
DescribePublicConfigs 查询公共配置项列表
DescribeReleasedConfig 查询group发布的配置
ReleaseConfig 发布配置
ReleasePublicConfig 发布公共配置
RevocationConfig 撤回已发布的配置
RevocationPublicConfig 撤回已发布的公共配置
RollbackConfig 回滚配置

镜像相关接口

接口名称 接口功能
DeleteImageTags 批量删除镜像版本
DescribeImageRepository 镜像仓库列表
DescribeImageTags 镜像版本列表

集群相关接口

接口名称 接口功能
AddClusterInstances 集群添加云主机
AddInstances 集群导入云主机
CreateCluster 创建集群
DescribeClusterInstances 查询集群实例
DescribeSimpleClusters 查询简单集群列表
RemoveInstances 移除云主机