{ "name": "tem", "display_name": "弹性微服务", "description": "腾讯云弹性微服务（TEM）相关接口。", "domain": "other", "api_version": "2021-07-01", "endpoint": "tem.tencentcloudapi.com", "actions": [ { "name": "CreateApplication", "description": "创建应用", "status": "online", "parameters": [ { "name": "ApplicationName", "type": "string", "required": true, "description": "应用名", "example": "service-a" }, { "name": "Description", "type": "string", "required": true, "description": "描述", "example": "服务a" }, { "name": "UseDefaultImageService", "type": "integer", "required": false, "description": "是否使用默认镜像服务 1-是，0-否", "example": "0" }, { "name": "RepoType", "type": "integer", "required": false, "description": "如果是绑定仓库，绑定的仓库类型，0-个人版，1-企业版", "example": "0" }, { "name": "InstanceId", "type": "string", "required": false, "description": "企业版镜像服务的实例id", "example": "tr-123" }, { "name": "RepoServer", "type": "string", "required": false, "description": "绑定镜像服务器地址", "example": "tcr.tencent.com" }, { "name": "RepoName", "type": "string", "required": false, "description": "绑定镜像仓库名", "example": "tem-test/repo_xxx" }, { "name": "SourceChannel", "type": "integer", "required": false, "description": "来源渠道", "example": "0" }, { "name": "SubnetList", "type": "array", "required": false, "description": "应用所在子网", "example": "[\"subnet-xxxxxx\"]", "item_type": "string" }, { "name": "CodingLanguage", "type": "string", "required": false, "description": "编程语言 - JAVA - OTHER", "example": "JAVA" }, { "name": "DeployMode", "type": "string", "required": false, "description": "部署方式 - IMAGE - JAR - WAR", "example": "IMAGE" }, { "name": "EnableTracing", "type": "integer", "required": false, "description": "是否开启 Java 应用的 APM 自动上报功能，1 表示启用；0 表示关闭", "example": "1" }, { "name": "UseDefaultImageServiceParameters", "type": "object", "required": false, "description": "使用默认镜像服务额外参数", "example": "无", "children": [ { "name": "EnterpriseInstanceName", "type": "string", "required": false, "description": "企业版实例名", "example": "tcr-demo-xxx" }, { "name": "EnterpriseInstanceChargeType", "type": "integer", "required": false, "description": "企业版收费类型 0 按量收费 1 包年包月", "example": "0" }, { "name": "EnterpriseInstanceType", "type": "string", "required": false, "description": "企业版规格：basic-基础班 ，standard-标准版，premium-高级版", "example": "basic" } ] }, { "name": "Tags", "type": "array", "required": false, "description": "标签", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "标签键", "example": "1" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值", "example": "1" } ] } ], "required": [ "ApplicationName", "Description" ] }, { "name": "CreateApplicationAutoscaler", "description": "创建弹性伸缩策略组合", "status": "online", "parameters": [ { "name": "ApplicationId", "type": "string", "required": true, "description": "服务id", "example": "app-xxxxxx" }, { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境ID", "example": "en-xxxxxx" }, { "name": "Autoscaler", "type": "object", "required": true, "description": "弹性伸缩策略", "example": "无", "children": [ { "name": "MinReplicas", "type": "integer", "required": true, "description": "弹性伸缩最小实例数", "example": "0" }, { "name": "MaxReplicas", "type": "integer", "required": true, "description": "弹性伸缩最大实例数", "example": "2" }, { "name": "HorizontalAutoscaler", "type": "array", "required": false, "description": "指标弹性伸缩策略(指标策略和定时策略必须填写一个)", "example": "{\"HorizontalAutoscaler\":[{\"DoubleThreshold\":50,\"Enabled\":true,\"MaxReplicas\":4,\"Metrics\":\"CPU\",\"MinReplicas\":0}]}", "item_type": "object", "children": [ { "name": "MinReplicas", "type": "integer", "required": false, "description": "最小实例数（可以不传）", "example": "1" }, { "name": "MaxReplicas", "type": "integer", "required": false, "description": "最大实例数（可以不传）", "example": "1" }, { "name": "Metrics", "type": "string", "required": false, "description": "指标度量 CPU（CPU使用率，%） MEMORY（内存使用率，%） CPU_CORE_USED（CPU使用量，core） MEMORY_SIZE_USED(内存使用量，MiB) NETWORK_BANDWIDTH_RECEIVE(网络入带宽，MBps) NETWORK_BANDWIDTH_TRANSMIT(网络出带宽，MBps) NETWORK_TRAFFIC_RECEIVE(网络入流量，MiB/s) NETWORK_TRAFFIC_TRANSMIT(网络出流量，MiB/s) NETWORK_PACKETS_RECEIVE(网络入包量，Count/s) NETWORK_PACKETS_TRANSMIT(网络出包量，Count/s) FS_IOPS_WRITE(磁盘写次数，Count/s) FS_IOP...", "example": "1" }, { "name": "Threshold", "type": "integer", "required": false, "description": "阈值（整数）", "example": "1" }, { "name": "Enabled", "type": "boolean", "required": false, "description": "是否启用", "example": "1" }, { "name": "DoubleThreshold", "type": "float", "required": false, "description": "阈值（小数，优先使用）", "example": "1" } ] }, { "name": "CronHorizontalAutoscaler", "type": "array", "required": false, "description": "定时弹性伸缩策略(指标策略和定时策略必须填写一个)", "example": "{\"CronHorizontalAutoscaler\":[{\"Enabled\":false,\"Name\":\"pk-test\",\"Period\":\"* * *\",\"Priority\":0,\"Schedules\":[{\"StartAt\":\"02:00\",\"TargetReplicas\":1}]}]}", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "定时伸缩策略名称", "example": "1" }, { "name": "Period", "type": "string", "required": false, "description": "策略周期 * * *，三个范围，第一个是天，第二个是月，第三个是周，中间用空格隔开 例子： * * * （每天） * * 0-3 （每周日到周三） 1,11,21 * *（每个月1号，11号，21号）", "example": "* * *" }, { "name": "Schedules", "type": "array", "required": false, "description": "定时伸缩策略明细", "example": "1", "item_type": "object", "children": [ { "name": "StartAt", "type": "string", "required": true, "description": "触发事件，小时分钟，用:分割 例如 00:00（零点零分触发）", "example": "00:00" }, { "name": "TargetReplicas", "type": "integer", "required": false, "description": "目标实例数（不大于50）", "example": "1" } ] }, { "name": "Enabled", "type": "boolean", "required": false, "description": "是否启用", "example": "1" }, { "name": "Priority", "type": "integer", "required": false, "description": "策略优先级，值越大优先级越高，0为最小值", "example": "1" } ] }, { "name": "AutoscalerId", "type": "string", "required": false, "description": "弹性伸缩ID", "example": "scaler-xxxxxx" }, { "name": "AutoscalerName", "type": "string", "required": false, "description": "弹性伸缩名称", "example": "scaler-name" }, { "name": "Description", "type": "string", "required": false, "description": "弹性伸缩描述", "example": "这是一个描述" }, { "name": "CreateDate", "type": "string", "required": false, "description": "创建日期", "example": "2024-10-25 16:36:10" }, { "name": "ModifyDate", "type": "string", "required": false, "description": "修改时间", "example": "2024-10-25 16:36:10" }, { "name": "EnableDate", "type": "string", "required": false, "description": "启用时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "2024-10-25 16:36:10" }, { "name": "Enabled", "type": "boolean", "required": false, "description": "是否启用", "example": "true" } ] }, { "name": "SourceChannel", "type": "integer", "required": false, "description": "来源渠道", "example": "0" } ], "required": [ "ApplicationId", "EnvironmentId", "Autoscaler" ] }, { "name": "CreateApplicationService", "description": "新增访问方式", "status": "online", "parameters": [ { "name": "ApplicationId", "type": "string", "required": true, "description": "服务id", "example": "app-xxxxxx" }, { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境ID", "example": "en-xxxxxx" }, { "name": "Service", "type": "object", "required": true, "description": "访问方式详情", "example": "{\"ServiceName\":\"k8s-svc-test\",\"PortMappingItemList\":[{\"Port\":8080,\"TargetPort\":8080,\"Protocol\":\"TCP\"}],\"Type\":\"CLUSTER\"}", "children": [ { "name": "Type", "type": "string", "required": false, "description": "服务类型：如：EXTERNAL，VPC，CLUSTER", "example": "ClusterIP" }, { "name": "ServiceName", "type": "string", "required": false, "description": "服务名称", "example": "consumer" }, { "name": "ClusterIp", "type": "string", "required": false, "description": "集群内访问vip", "example": "10.0.0.2" }, { "name": "ExternalIp", "type": "string", "required": false, "description": "集群外方位vip", "example": "202.0.0.2" }, { "name": "SubnetId", "type": "string", "required": false, "description": "子网id", "example": "subnet-123" }, { "name": "VpcId", "type": "string", "required": false, "description": "vpc id", "example": "vpc-123" }, { "name": "LoadBalanceId", "type": "string", "required": false, "description": "LoadBalance Id", "example": "clb-123" }, { "name": "Yaml", "type": "string", "required": false, "description": "yaml 内容", "example": "yaml" }, { "name": "Ports", "type": "array", "required": false, "description": "暴露端口列表", "example": "[100,2000,3000]", "item_type": "integer" }, { "name": "PortMappingItemList", "type": "array", "required": false, "description": "端口映射数组", "example": "无", "item_type": "object", "children": [ { "name": "Port", "type": "integer", "required": false, "description": "应用访问端口", "example": "1000" }, { "name": "TargetPort", "type": "integer", "required": false, "description": "应用监听端口", "example": "2000" }, { "name": "Protocol", "type": "string", "required": false, "description": "协议类型", "example": "TCP" } ] }, { "name": "ExternalDomain", "type": "string", "required": false, "description": "clb domain", "example": "lb-xxxx.com" } ] }, { "name": "SourceChannel", "type": "integer", "required": false, "description": "来源渠道", "example": "0" } ], "required": [ "ApplicationId", "EnvironmentId", "Service" ] }, { "name": "CreateConfigData", "description": "创建配置", "status": "online", "parameters": [ { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境 ID", "example": "en-xxxxxx" }, { "name": "Name", "type": "string", "required": true, "description": "配置名", "example": "abc-xxxx" }, { "name": "Data", "type": "array", "required": true, "description": "配置信息", "example": "[{\"Key\":\"key-xxx\",\"Value\":\"val-xxx\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "键", "example": "1" }, { "name": "Value", "type": "string", "required": true, "description": "值", "example": "1" }, { "name": "Type", "type": "string", "required": false, "description": "类型，default 为自定义，reserved 为系统变量，referenced 为引用配置项", "example": "default" }, { "name": "Config", "type": "string", "required": false, "description": "配置名称", "example": "configName" }, { "name": "Secret", "type": "string", "required": false, "description": "加密配置名称", "example": "1" } ] }, { "name": "SourceChannel", "type": "integer", "required": false, "description": "来源渠道", "example": "0" } ], "required": [ "EnvironmentId", "Name", "Data" ] }, { "name": "CreateCosToken", "description": "生成Cos临时密钥", "status": "online", "parameters": [ { "name": "ApplicationId", "type": "string", "required": true, "description": "应用ID", "example": "1" }, { "name": "PkgName", "type": "string", "required": true, "description": "包名", "example": "1" }, { "name": "OptType", "type": "integer", "required": true, "description": "optType 1上传 2查询", "example": "1" }, { "name": "SourceChannel", "type": "integer", "required": false, "description": "来源 channel", "example": "0" }, { "name": "TimeVersion", "type": "string", "required": false, "description": "充当deployVersion入参", "example": "1" } ], "required": [ "ApplicationId", "PkgName", "OptType" ] }, { "name": "CreateEnvironment", "description": "创建环境", "status": "online", "parameters": [ { "name": "EnvironmentName", "type": "string", "required": true, "description": "环境名称", "example": "namespace-a" }, { "name": "Description", "type": "string", "required": false, "description": "环境描述", "example": "命名空间名" }, { "name": "Vpc", "type": "string", "required": false, "description": "私有网络名称", "example": "vpc-1n5javez" }, { "name": "SubnetIds", "type": "array", "required": false, "description": "子网列表", "example": "subnet-xxxx", "item_type": "string" }, { "name": "K8sVersion", "type": "string", "required": false, "description": "K8s version", "example": "1.16.9" }, { "name": "SourceChannel", "type": "integer", "required": false, "description": "来源渠道", "example": "0" }, { "name": "EnableTswTraceService", "type": "boolean", "required": false, "description": "是否开启tsw服务。默认值：false", "example": "true" }, { "name": "Tags", "type": "array", "required": false, "description": "标签", "example": "1", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "标签键", "example": "1" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值", "example": "1" } ] }, { "name": "EnvType", "type": "string", "required": false, "description": "环境类型：test、pre、prod。默认值：prod", "example": "prod" }, { "name": "CreateRegion", "type": "string", "required": false, "description": "创建环境的region", "example": "ap-shanghai" }, { "name": "SetupVpc", "type": "boolean", "required": false, "description": "是否创建私有网络.默认值:true", "example": "false" }, { "name": "SetupPrometheus", "type": "boolean", "required": false, "description": "是否创建 Prometheus 实例。默认值：false", "example": "false" }, { "name": "PrometheusId", "type": "string", "required": false, "description": "prometheus 实例 id", "example": "prom-xxx" }, { "name": "ApmId", "type": "string", "required": false, "description": "apm id", "example": "apm-xxx" } ], "required": [ "EnvironmentName" ] }, { "name": "CreateLogConfig", "description": "创建日志收集配置", "status": "online", "parameters": [ { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境 ID", "example": "en-xxxxxx" }, { "name": "Name", "type": "string", "required": true, "description": "配置名", "example": "abc-xxx" }, { "name": "InputType", "type": "string", "required": true, "description": "收集类型，container_stdout 为标准输出；container_file 为文件；", "example": "container_file" }, { "name": "ApplicationId", "type": "string", "required": true, "description": "应用 ID", "example": "app-xxxxxx" }, { "name": "LogsetId", "type": "string", "required": false, "description": "日志集 ID", "example": "abc-xxxxxx" }, { "name": "TopicId", "type": "string", "required": false, "description": "日志主题 ID", "example": "abc-xxxxxx" }, { "name": "LogType", "type": "string", "required": false, "description": "日志提取模式，minimalist_log 为单行全文；multiline_log 为多行全文；json_log 为 json格式；fullregex_log 为单行正则；multiline_fullregex_log 为多行正则", "example": "minimalist_log" }, { "name": "BeginningRegex", "type": "string", "required": false, "description": "首行正则表达式，当LogType=multiline_log 时生效", "example": "/abc/" }, { "name": "LogPath", "type": "string", "required": false, "description": "收集文件目录，当 InputType=container_file 时生效", "example": "/abc" }, { "name": "FilePattern", "type": "string", "required": false, "description": "收集文件名模式，当 InputType=container_file 时生效", "example": "app_*.log" }, { "name": "ExtractRule", "type": "object", "required": false, "description": "导出规则", "example": "{\"FilterKeys\":[],\"FilterRegex\":[],\"UnMatchUpload\":\"true\",\"UnMatchedKey\":\"LogParseFailure\"}", "children": [ { "name": "BeginningRegex", "type": "string", "required": false, "description": "首行正则表达式", "example": "^ERROR" }, { "name": "Keys", "type": "array", "required": false, "description": "提取结果", "example": "[\"k1\", \"k2\"]", "item_type": "string" }, { "name": "FilterKeys", "type": "array", "required": false, "description": "过滤键", "example": "[\"k1\"]", "item_type": "string" }, { "name": "FilterRegex", "type": "array", "required": false, "description": "过滤值", "example": "[\"v1*\"]", "item_type": "string" }, { "name": "LogRegex", "type": "string", "required": false, "description": "日志正则表达式", "example": "^Info" }, { "name": "TimeKey", "type": "string", "required": false, "description": "时间字段", "example": "time" }, { "name": "TimeFormat", "type": "string", "required": false, "description": "时间格式", "example": "%Y-%m-%d %H:%M:%S" }, { "name": "UnMatchUpload", "type": "string", "required": false, "description": "是否上传解析失败日志", "example": "true" }, { "name": "UnMatchedKey", "type": "string", "required": false, "description": "解析失败日志的键名称", "example": "LogParseFailure" }, { "name": "Backtracking", "type": "string", "required": false, "description": "tracking", "example": "tracking-xxx" }, { "name": "Delimiter", "type": "string", "required": false, "description": "分隔符", "example": ":" } ] } ], "required": [ "EnvironmentId", "Name", "InputType", "ApplicationId" ] }, { "name": "CreateResource", "description": "绑定云资源", "status": "online", "parameters": [ { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境 Id", "example": "en-xxxxxx" }, { "name": "ResourceType", "type": "string", "required": true, "description": "资源类型，目前支持文件系统：CFS；注册中心：TSE_SRE", "example": "CFS" }, { "name": "ResourceId", "type": "string", "required": false, "description": "资源 Id", "example": "cls-xxx" }, { "name": "SourceChannel", "type": "integer", "required": false, "description": "来源渠道", "example": "0" }, { "name": "ResourceFrom", "type": "string", "required": false, "description": "资源来源，目前支持：existing，已有资源；creating，自动创建", "example": "existing" }, { "name": "ResourceConfig", "type": "string", "required": false, "description": "设置 resource 的额外配置", "example": "resource-cfg-xxx" } ], "required": [ "EnvironmentId", "ResourceType" ] }, { "name": "DeleteApplication", "description": "服务删除 - 停止当前运行服务 - 删除服务相关资源 - 删除服务", "status": "online", "parameters": [ { "name": "ApplicationId", "type": "string", "required": true, "description": "服务Id", "example": "app-xxxxxx" }, { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境ID", "example": "en-xxxxxx" }, { "name": "SourceChannel", "type": "integer", "required": false, "description": "来源渠道(用户不需要关心此参数)", "example": "0" }, { "name": "DeleteApplicationIfNoRunningVersion", "type": "boolean", "required": false, "description": "当服务没有任何运行版本时，是否删除此服务", "example": "false" } ], "required": [ "ApplicationId", "EnvironmentId" ] }, { "name": "DeleteApplicationAutoscaler", "description": "删除应用弹性策略组合", "status": "online", "parameters": [ { "name": "ApplicationId", "type": "string", "required": true, "description": "服务id", "example": "app-xxxxxx" }, { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境ID", "example": "en-xxxxxx" }, { "name": "AutoscalerId", "type": "string", "required": true, "description": "弹性伸缩策略ID", "example": "scaler-xxxxxx" }, { "name": "SourceChannel", "type": "integer", "required": false, "description": "来源渠道", "example": "0" } ], "required": [ "ApplicationId", "EnvironmentId", "AutoscalerId" ] }, { "name": "DeleteApplicationService", "description": "删除一条访问方式", "status": "online", "parameters": [ { "name": "ApplicationId", "type": "string", "required": true, "description": "服务id", "example": "app-xxxxxx" }, { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境ID", "example": "en-xxxxxx" }, { "name": "ServiceName", "type": "string", "required": true, "description": "访问方式服务名", "example": "name-xxx" }, { "name": "SourceChannel", "type": "integer", "required": false, "description": "来源渠道", "example": "0" } ], "required": [ "ApplicationId", "EnvironmentId", "ServiceName" ] }, { "name": "DeleteIngress", "description": "删除 Ingress 规则", "status": "online", "parameters": [ { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境ID", "example": "env-xxxxxx" }, { "name": "ClusterNamespace", "type": "string", "required": true, "description": "环境 namespace", "example": "default" }, { "name": "IngressName", "type": "string", "required": true, "description": "ingress 规则名", "example": "ingress-name" }, { "name": "SourceChannel", "type": "integer", "required": false, "description": "来源渠道", "example": "0" } ], "required": [ "EnvironmentId", "ClusterNamespace", "IngressName" ] }, { "name": "DeployApplication", "description": "应用部署", "status": "online", "parameters": [ { "name": "ApplicationId", "type": "string", "required": true, "description": "应用ID", "example": "app-xxxxxx" }, { "name": "InitPodNum", "type": "integer", "required": true, "description": "初始化 pod 数", "example": "1" }, { "name": "CpuSpec", "type": "float", "required": true, "description": "cpu规格 单位：核", "example": "1" }, { "name": "MemorySpec", "type": "float", "required": true, "description": "内存规格 单位：G", "example": "2" }, { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境ID", "example": "en-xxxxxx" }, { "name": "DeployVersion", "type": "string", "required": true, "description": "部署类型为 IMAGE 时，该参数表示镜像 tag。 部署类型为 JAR/WAR 时，该参数表示包版本号。", "example": "v1" }, { "name": "ImgRepo", "type": "string", "required": false, "description": "镜像仓库", "example": "1" }, { "name": "VersionDesc", "type": "string", "required": false, "description": "版本描述信息", "example": "version-desc" }, { "name": "JvmOpts", "type": "string", "required": false, "description": "启动参数", "example": "-Xms128m -XX:MetaspaceSize=128m" }, { "name": "EsInfo", "type": "object", "required": false, "description": "弹性伸缩配置（已废弃，请使用HorizontalAutoscaler设置弹性策略）", "example": "1", "children": [ { "name": "MinAliveInstances", "type": "integer", "required": true, "description": "最小实例数", "example": "1" }, { "name": "MaxAliveInstances", "type": "integer", "required": true, "description": "最大实例数", "example": "5" }, { "name": "EsStrategy", "type": "integer", "required": true, "description": "弹性策略,1:cpu，2:内存", "example": "1" }, { "name": "Threshold", "type": "integer", "required": true, "description": "弹性扩缩容条件值", "example": "50" }, { "name": "VersionId", "type": "string", "required": false, "description": "版本Id", "example": "version-test" } ] }, { "name": "EnvConf", "type": "array", "required": false, "description": "环境变量配置", "example": "1", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "键", "example": "1" }, { "name": "Value", "type": "string", "required": true, "description": "值", "example": "1" }, { "name": "Type", "type": "string", "required": false, "description": "类型，default 为自定义，reserved 为系统变量，referenced 为引用配置项", "example": "default" }, { "name": "Config", "type": "string", "required": false, "description": "配置名称", "example": "configName" }, { "name": "Secret", "type": "string", "required": false, "description": "加密配置名称", "example": "1" } ] }, { "name": "LogConfs", "type": "array", "required": false, "description": "日志配置", "example": "1", "item_type": "string" }, { "name": "StorageConfs", "type": "array", "required": false, "description": "数据卷配置", "example": "1", "item_type": "object", "children": [ { "name": "StorageVolName", "type": "string", "required": true, "description": "存储卷名称", "example": "1" }, { "name": "StorageVolPath", "type": "string", "required": true, "description": "存储卷路径", "example": "1" }, { "name": "StorageVolIp", "type": "string", "required": false, "description": "存储卷IP", "example": "1" } ] }, { "name": "StorageMountConfs", "type": "array", "required": false, "description": "数据卷挂载配置", "example": "1", "item_type": "object", "children": [ { "name": "VolumeName", "type": "string", "required": true, "description": "数据卷名", "example": "1" }, { "name": "MountPath", "type": "string", "required": true, "description": "数据卷绑定路径", "example": "1" } ] }, { "name": "DeployMode", "type": "string", "required": false, "description": "部署类型。 - JAR：通过 jar 包部署 - WAR：通过 war 包部署 - IMAGE：通过镜像部署", "example": "JAR" }, { "name": "PkgName", "type": "string", "required": false, "description": "传入内容为 /jar包名字 的形式。也就是在 jar包名字前增加一个/。 如上传的 jar 包名字为 demo-1.0.0.jar，那么这里传入内容为：/demo-1.0.0.jar 注：jar 包需要通过 tem 页面上传过，tem 后端才能拉到该 jar 包。", "example": "/demo-1.0.0.jar" }, { "name": "JdkVersion", "type": "string", "required": false, "description": "JDK 版本。 - KONA:8：使用 kona jdk 8。 - OPEN:8：使用 open jdk 8。 - KONA:11：使用 kona jdk 11。 - OPEN:11：使用 open jdk 11。", "example": "KONA:8" }, { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "安全组ID s", "example": "1", "item_type": "string" }, { "name": "LogOutputConf", "type": "object", "required": false, "description": "日志输出配置", "example": "1", "children": [ { "name": "OutputType", "type": "string", "required": true, "description": "日志消费端类型", "example": "cls、kafka" }, { "name": "ClsLogsetName", "type": "string", "required": false, "description": "cls日志集", "example": "1" }, { "name": "ClsLogTopicId", "type": "string", "required": false, "description": "cls日志主题", "example": "1" }, { "name": "ClsLogsetId", "type": "string", "required": false, "description": "cls日志集id", "example": "1" }, { "name": "ClsLogTopicName", "type": "string", "required": false, "description": "cls日志名称", "example": "1" } ] }, { "name": "SourceChannel", "type": "integer", "required": false, "description": "来源渠道", "example": "0" }, { "name": "Description", "type": "string", "required": false, "description": "版本描述", "example": "1" }, { "name": "ImageCommand", "type": "string", "required": false, "description": "镜像命令", "example": "cd" }, { "name": "ImageArgs", "type": "array", "required": false, "description": "镜像命令参数", "example": "/home", "item_type": "string" }, { "name": "UseRegistryDefaultConfig", "type": "boolean", "required": false, "description": "是否添加默认注册中心配置", "example": "true" }, { "name": "SettingConfs", "type": "array", "required": false, "description": "挂载配置信息", "example": "[{\"ConfigDataName\":\"cfg-test-1\",\"MountedPath\":\"/data\",\"SecretDataName\":\"\"}]", "item_type": "object", "children": [ { "name": "ConfigDataName", "type": "string", "required": true, "description": "配置名称", "example": "1" }, { "name": "MountedPath", "type": "string", "required": true, "description": "挂载路径", "example": "1" }, { "name": "Data", "type": "array", "required": false, "description": "配置内容", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "键", "example": "1" }, { "name": "Value", "type": "string", "required": true, "description": "值", "example": "1" }, { "name": "Type", "type": "string", "required": false, "description": "类型，default 为自定义，reserved 为系统变量，referenced 为引用配置项", "example": "default" }, { "name": "Config", "type": "string", "required": false, "description": "配置名称", "example": "configName" }, { "name": "Secret", "type": "string", "required": false, "description": "加密配置名称", "example": "1" } ] }, { "name": "SecretDataName", "type": "string", "required": false, "description": "加密配置名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" } ] }, { "name": "Service", "type": "object", "required": false, "description": "应用访问设置", "example": "1", "children": [ { "name": "Name", "type": "string", "required": false, "description": "service name", "example": "name-xxx" }, { "name": "Ports", "type": "array", "required": false, "description": "可用端口", "example": "[8080]", "item_type": "integer" }, { "name": "Yaml", "type": "string", "required": false, "description": "yaml 内容", "example": "apiVersion: v1-xxxxxx" }, { "name": "ApplicationName", "type": "string", "required": false, "description": "服务名", "example": "app-name-xxx" }, { "name": "VersionName", "type": "string", "required": false, "description": "版本名", "example": "version-xxxx" }, { "name": "ClusterIp", "type": "array", "required": false, "description": "内网ip", "example": "172.xx.xx.xx", "item_type": "string" }, { "name": "ExternalIp", "type": "string", "required": false, "description": "外网ip", "example": "10.xx.xx.xx" }, { "name": "Type", "type": "string", "required": false, "description": "访问类型，可选值： - EXTERNAL（公网访问） - VPC（vpc内访问） - CLUSTER（集群内访问）", "example": "VPC" }, { "name": "SubnetId", "type": "string", "required": false, "description": "子网ID，只在类型为vpc访问时才有值", "example": "subnet-xxxxxx" }, { "name": "LoadBalanceId", "type": "string", "required": false, "description": "负载均衡ID，只在外网访问和vpc内访问才有值，默认自动创建", "example": "10.xx.xx.xx" }, { "name": "PortMappings", "type": "array", "required": false, "description": "端口映射", "example": "无", "item_type": "object", "children": [ { "name": "Port", "type": "integer", "required": true, "description": "端口", "example": "1" }, { "name": "TargetPort", "type": "integer", "required": true, "description": "映射端口", "example": "1" }, { "name": "Protocol", "type": "string", "required": true, "description": "协议栈 TCP/UDP", "example": "1" }, { "name": "ServiceName", "type": "string", "required": false, "description": "k8s service名称", "example": "service123" } ] }, { "name": "ServicePortMappingList", "type": "array", "required": false, "description": "每种类型访问配置详情", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": false, "description": "服务类型：如：EXTERNAL，VPC，CLUSTER", "example": "ClusterIP" }, { "name": "ServiceName", "type": "string", "required": false, "description": "服务名称", "example": "consumer" }, { "name": "ClusterIp", "type": "string", "required": false, "description": "集群内访问vip", "example": "10.0.0.2" }, { "name": "ExternalIp", "type": "string", "required": false, "description": "集群外方位vip", "example": "202.0.0.2" }, { "name": "SubnetId", "type": "string", "required": false, "description": "子网id", "example": "subnet-123" }, { "name": "VpcId", "type": "string", "required": false, "description": "vpc id", "example": "vpc-123" }, { "name": "LoadBalanceId", "type": "string", "required": false, "description": "LoadBalance Id", "example": "clb-123" }, { "name": "Yaml", "type": "string", "required": false, "description": "yaml 内容", "example": "yaml" }, { "name": "Ports", "type": "array", "required": false, "description": "暴露端口列表", "example": "[100,2000,3000]", "item_type": "integer" }, { "name": "PortMappingItemList", "type": "array", "required": false, "description": "端口映射数组", "example": "无", "item_type": "object", "children": [ { "name": "Port", "type": "integer", "required": false, "description": "应用访问端口", "example": "1000" }, { "name": "TargetPort", "type": "integer", "required": false, "description": "应用监听端口", "example": "2000" }, { "name": "Protocol", "type": "string", "required": false, "description": "协议类型", "example": "TCP" } ] }, { "name": "ExternalDomain", "type": "string", "required": false, "description": "clb domain", "example": "lb-xxxx.com" } ] }, { "name": "FlushAll", "type": "boolean", "required": false, "description": "刷新复写所有类型", "example": "true" }, { "name": "EnableRegistryNextDeploy", "type": "integer", "required": false, "description": "1: 下次部署自动注入注册中心信息；0：不注入 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "ApplicationId", "type": "string", "required": false, "description": "返回应用id", "example": "app-xxxxxx" }, { "name": "AllIpDone", "type": "boolean", "required": false, "description": "所有服务IP是否已经ready", "example": "false" }, { "name": "ExternalDomain", "type": "string", "required": false, "description": "clb 域名", "example": "lb-xxxx.com" } ] }, { "name": "VersionId", "type": "string", "required": false, "description": "要回滚到的历史版本id", "example": "version-123" }, { "name": "PostStart", "type": "string", "required": false, "description": "启动后执行的脚本", "example": "1" }, { "name": "PreStop", "type": "string", "required": false, "description": "停止前执行的脚本", "example": "1" }, { "name": "Liveness", "type": "object", "required": false, "description": "存活探针配置", "example": "1", "children": [ { "name": "Type", "type": "string", "required": true, "description": "支持的健康检查类型，如 HttpGet，TcpSocket，Exec", "example": "HttpGet" }, { "name": "Protocol", "type": "string", "required": false, "description": "仅当健康检查类型为 HttpGet 时有效，表示协议类型，如 HTTP，HTTPS", "example": "HTTP" }, { "name": "Path", "type": "string", "required": false, "description": "仅当健康检查类型为 HttpGet 时有效，表示请求路径", "example": "/xxx" }, { "name": "Exec", "type": "string", "required": false, "description": "仅当健康检查类型为 Exec 时有效，表示执行的脚本内容", "example": "shell cmd" }, { "name": "Port", "type": "integer", "required": false, "description": "仅当健康检查类型为 HttpGet\\TcpSocket 时有效，表示请求路径", "example": "80" }, { "name": "InitialDelaySeconds", "type": "integer", "required": false, "description": "检查延迟开始时间，单位为秒，默认为 0", "example": "0" }, { "name": "TimeoutSeconds", "type": "integer", "required": false, "description": "超时时间，单位为秒，默认为 1", "example": "1" }, { "name": "PeriodSeconds", "type": "integer", "required": false, "description": "间隔时间，单位为秒，默认为 10", "example": "10" } ] }, { "name": "Readiness", "type": "object", "required": false, "description": "就绪探针配置", "example": "1", "children": [ { "name": "Type", "type": "string", "required": true, "description": "支持的健康检查类型，如 HttpGet，TcpSocket，Exec", "example": "HttpGet" }, { "name": "Protocol", "type": "string", "required": false, "description": "仅当健康检查类型为 HttpGet 时有效，表示协议类型，如 HTTP，HTTPS", "example": "HTTP" }, { "name": "Path", "type": "string", "required": false, "description": "仅当健康检查类型为 HttpGet 时有效，表示请求路径", "example": "/xxx" }, { "name": "Exec", "type": "string", "required": false, "description": "仅当健康检查类型为 Exec 时有效，表示执行的脚本内容", "example": "shell cmd" }, { "name": "Port", "type": "integer", "required": false, "description": "仅当健康检查类型为 HttpGet\\TcpSocket 时有效，表示请求路径", "example": "80" }, { "name": "InitialDelaySeconds", "type": "integer", "required": false, "description": "检查延迟开始时间，单位为秒，默认为 0", "example": "0" }, { "name": "TimeoutSeconds", "type": "integer", "required": false, "description": "超时时间，单位为秒，默认为 1", "example": "1" }, { "name": "PeriodSeconds", "type": "integer", "required": false, "description": "间隔时间，单位为秒，默认为 10", "example": "10" } ] }, { "name": "DeployStrategyConf", "type": "object", "required": false, "description": "分批发布策略配置", "example": "1", "children": [ { "name": "TotalBatchCount", "type": "integer", "required": false, "description": "总分批数", "example": "10" }, { "name": "BetaBatchNum", "type": "integer", "required": false, "description": "beta分批实例数", "example": "5" }, { "name": "DeployStrategyType", "type": "integer", "required": false, "description": "分批策略：0-全自动，1-全手动，2-beta分批，beta批一定是手动的，3-首次发布", "example": "1" }, { "name": "BatchInterval", "type": "integer", "required": false, "description": "每批暂停间隔", "example": "200" }, { "name": "MinAvailable", "type": "integer", "required": false, "description": "最小可用实例数", "example": "1" }, { "name": "Force", "type": "boolean", "required": false, "description": "是否强制发布", "example": "false" } ] }, { "name": "HorizontalAutoscaler", "type": "array", "required": false, "description": "弹性策略（已弃用，请使用弹性伸缩策略组合相关接口）", "example": "1", "item_type": "object", "children": [ { "name": "MinReplicas", "type": "integer", "required": false, "description": "最小实例数（可以不传）", "example": "1" }, { "name": "MaxReplicas", "type": "integer", "required": false, "description": "最大实例数（可以不传）", "example": "1" }, { "name": "Metrics", "type": "string", "required": false, "description": "指标度量 CPU（CPU使用率，%） MEMORY（内存使用率，%） CPU_CORE_USED（CPU使用量，core） MEMORY_SIZE_USED(内存使用量，MiB) NETWORK_BANDWIDTH_RECEIVE(网络入带宽，MBps) NETWORK_BANDWIDTH_TRANSMIT(网络出带宽，MBps) NETWORK_TRAFFIC_RECEIVE(网络入流量，MiB/s) NETWORK_TRAFFIC_TRANSMIT(网络出流量，MiB/s) NETWORK_PACKETS_RECEIVE(网络入包量，Count/s) NETWORK_PACKETS_TRANSMIT(网络出包量，Count/s) FS_IOPS_WRITE(磁盘写次数，Count/s) FS_IOP...", "example": "1" }, { "name": "Threshold", "type": "integer", "required": false, "description": "阈值（整数）", "example": "1" }, { "name": "Enabled", "type": "boolean", "required": false, "description": "是否启用", "example": "1" }, { "name": "DoubleThreshold", "type": "float", "required": false, "description": "阈值（小数，优先使用）", "example": "1" } ] }, { "name": "CronHorizontalAutoscaler", "type": "array", "required": false, "description": "定时弹性策略（已弃用，请使用弹性伸缩策略组合相关接口）", "example": "1", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "定时伸缩策略名称", "example": "1" }, { "name": "Period", "type": "string", "required": false, "description": "策略周期 * * *，三个范围，第一个是天，第二个是月，第三个是周，中间用空格隔开 例子： * * * （每天） * * 0-3 （每周日到周三） 1,11,21 * *（每个月1号，11号，21号）", "example": "* * *" }, { "name": "Schedules", "type": "array", "required": false, "description": "定时伸缩策略明细", "example": "1", "item_type": "object", "children": [ { "name": "StartAt", "type": "string", "required": true, "description": "触发事件，小时分钟，用:分割 例如 00:00（零点零分触发）", "example": "00:00" }, { "name": "TargetReplicas", "type": "integer", "required": false, "description": "目标实例数（不大于50）", "example": "1" } ] }, { "name": "Enabled", "type": "boolean", "required": false, "description": "是否启用", "example": "1" }, { "name": "Priority", "type": "integer", "required": false, "description": "策略优先级，值越大优先级越高，0为最小值", "example": "1" } ] }, { "name": "LogEnable", "type": "integer", "required": false, "description": "是否启用log，1为启用，0为不启用", "example": "1" }, { "name": "ConfEdited", "type": "boolean", "required": false, "description": "（除开镜像配置）配置是否修改", "example": "true" }, { "name": "SpeedUp", "type": "boolean", "required": false, "description": "是否开启应用加速", "example": "true" }, { "name": "StartupProbe", "type": "object", "required": false, "description": "启动探针配置", "example": "1", "children": [ { "name": "Type", "type": "string", "required": true, "description": "支持的健康检查类型，如 HttpGet，TcpSocket，Exec", "example": "HttpGet" }, { "name": "Protocol", "type": "string", "required": false, "description": "仅当健康检查类型为 HttpGet 时有效，表示协议类型，如 HTTP，HTTPS", "example": "HTTP" }, { "name": "Path", "type": "string", "required": false, "description": "仅当健康检查类型为 HttpGet 时有效，表示请求路径", "example": "/xxx" }, { "name": "Exec", "type": "string", "required": false, "description": "仅当健康检查类型为 Exec 时有效，表示执行的脚本内容", "example": "shell cmd" }, { "name": "Port", "type": "integer", "required": false, "description": "仅当健康检查类型为 HttpGet\\TcpSocket 时有效，表示请求路径", "example": "80" }, { "name": "InitialDelaySeconds", "type": "integer", "required": false, "description": "检查延迟开始时间，单位为秒，默认为 0", "example": "0" }, { "name": "TimeoutSeconds", "type": "integer", "required": false, "description": "超时时间，单位为秒，默认为 1", "example": "1" }, { "name": "PeriodSeconds", "type": "integer", "required": false, "description": "间隔时间，单位为秒，默认为 10", "example": "10" } ] }, { "name": "OsFlavour", "type": "string", "required": false, "description": "操作系统版本； 当选择openjdk时，可选参数： - ALPINE - CENTOS 当选择konajdk时，可选参数： - ALPINE - TENCENTOS", "example": "1" }, { "name": "EnablePrometheusConf", "type": "object", "required": false, "description": "metrics业务指标监控配置", "example": "{\"Port\":9090,\"Path:\"/data\"}", "children": [ { "name": "Port", "type": "integer", "required": false, "description": "应用开放的监听端口", "example": "9090" }, { "name": "Path", "type": "string", "required": false, "description": "业务指标暴露的url path", "example": "/metrics" } ] }, { "name": "EnableTracing", "type": "integer", "required": false, "description": "1：开始自动apm采集（skywalking）； 0：关闭apm采集；", "example": "0" }, { "name": "EnableMetrics", "type": "integer", "required": false, "description": "1：开始自动metrics采集（open-telemetry）； 0：关闭metrics采集；", "example": "0" }, { "name": "TcrInstanceId", "type": "string", "required": false, "description": "镜像部署时，选择的tcr实例id", "example": "tcr-123" }, { "name": "RepoServer", "type": "string", "required": false, "description": "镜像部署时，选择的镜像服务器地址", "example": "ccr.ccs.tencentcryun.com" }, { "name": "RepoType", "type": "integer", "required": false, "description": "镜像部署时，仓库类型：0：个人仓库；1：企业版；2：公共仓库；3：tem托管仓库；4：demo仓库", "example": "0" }, { "name": "PostStartEncoded", "type": "string", "required": false, "description": "启动后执行的脚本，base64 编码", "example": "post-start-encoded-xxx" }, { "name": "PreStopEncoded", "type": "string", "required": false, "description": "停止前执行的脚本，base64 编码", "example": "pre-stop-encoded-xxx" } ], "required": [ "ApplicationId", "InitPodNum", "CpuSpec", "MemorySpec", "EnvironmentId", "DeployVersion" ] }, { "name": "DescribeApplicationAutoscalerList", "description": "获取应用弹性策略组合", "status": "online", "parameters": [ { "name": "ApplicationId", "type": "string", "required": true, "description": "服务id", "example": "app-xxxxxx" }, { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境ID", "example": "en-xxxxxx" }, { "name": "SourceChannel", "type": "integer", "required": false, "description": "来源渠道", "example": "0" } ], "required": [ "ApplicationId", "EnvironmentId" ] }, { "name": "DescribeApplicationInfo", "description": "服务基本信息查看", "status": "online", "parameters": [ { "name": "ApplicationId", "type": "string", "required": true, "description": "服务版本ID", "example": "app-xxxxxx" }, { "name": "SourceChannel", "type": "integer", "required": false, "description": "来源渠道", "example": "0" }, { "name": "EnvironmentId", "type": "string", "required": false, "description": "环境ID", "example": "en-xxxxxx" } ], "required": [ "ApplicationId" ] }, { "name": "DescribeApplicationPods", "description": "获取应用实例列表", "status": "online", "parameters": [ { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境id", "example": "en-xxxxxx" }, { "name": "ApplicationId", "type": "string", "required": true, "description": "应用id", "example": "app-xxxxxx" }, { "name": "Limit", "type": "integer", "required": false, "description": "单页条数，默认值20", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页下标，默认值0", "example": "1" }, { "name": "Status", "type": "string", "required": false, "description": "实例状态 - Running - Pending - Error", "example": "Running" }, { "name": "PodName", "type": "string", "required": false, "description": "实例名字", "example": "pod-a" }, { "name": "SourceChannel", "type": "integer", "required": false, "description": "来源渠道", "example": "0" } ], "required": [ "EnvironmentId", "ApplicationId" ] }, { "name": "DescribeApplicationServiceList", "description": "查询应用访问方式列表", "status": "online", "parameters": [ { "name": "EnvironmentId", "type": "string", "required": true, "description": "namespace id", "example": "en-xxxxxx" }, { "name": "ApplicationId", "type": "string", "required": true, "description": "服务ID", "example": "app-xxxxxx" }, { "name": "SourceChannel", "type": "integer", "required": false, "description": "来源渠道", "example": "0" } ], "required": [ "EnvironmentId", "ApplicationId" ] }, { "name": "DescribeApplications", "description": "获取运行服务列表", "status": "online", "parameters": [ { "name": "EnvironmentId", "type": "string", "required": false, "description": "命名空间ID", "example": "en-xxxxxx" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页Limit，默认值：20", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页offset,默认值：0", "example": "0" }, { "name": "SourceChannel", "type": "integer", "required": false, "description": "来源渠道", "example": "0" }, { "name": "ApplicationId", "type": "string", "required": false, "description": "服务id", "example": "app-xxxxxx" }, { "name": "Keyword", "type": "string", "required": false, "description": "搜索关键字", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "查询过滤器", "example": "1", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "查询字段名称", "example": "1" }, { "name": "Value", "type": "array", "required": false, "description": "查询字段值", "example": "1", "item_type": "string" } ] }, { "name": "SortInfo", "type": "object", "required": false, "description": "排序字段", "example": "{}", "children": [ { "name": "Key", "type": "string", "required": false, "description": "排序字段名称", "example": "1" }, { "name": "Type", "type": "integer", "required": false, "description": "0：升序，1：倒序", "example": "0" } ] } ], "required": [] }, { "name": "DescribeApplicationsStatus", "description": "单环境下所有应用状态查看", "status": "online", "parameters": [ { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境ID", "example": "en-xxxxxx" }, { "name": "SourceChannel", "type": "integer", "required": false, "description": "来源渠道", "example": "0" } ], "required": [ "EnvironmentId" ] }, { "name": "DescribeConfigData", "description": "查询配置详情", "status": "online", "parameters": [ { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境 ID", "example": "en-xxxxxx" }, { "name": "Name", "type": "string", "required": true, "description": "配置名", "example": "abc-xxxx" }, { "name": "SourceChannel", "type": "integer", "required": false, "description": "来源渠道", "example": "0" } ], "required": [ "EnvironmentId", "Name" ] }, { "name": "DescribeConfigDataList", "description": "查询配置列表", "status": "online", "parameters": [ { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境 ID", "example": "en-xxxxxx" }, { "name": "SourceChannel", "type": "integer", "required": false, "description": "来源渠道", "example": "0" }, { "name": "ContinueToken", "type": "string", "required": false, "description": "查询游标", "example": "token-xxxxxx" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页 limit", "example": "10" } ], "required": [ "EnvironmentId" ] }, { "name": "DescribeDeployApplicationDetail", "description": "获取分批发布详情", "status": "online", "parameters": [ { "name": "ApplicationId", "type": "string", "required": true, "description": "服务id", "example": "app-xxxxxx" }, { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境id", "example": "en-xxxxxx" }, { "name": "VersionId", "type": "string", "required": false, "description": "版本部署id", "example": "version-123" } ], "required": [ "ApplicationId", "EnvironmentId" ] }, { "name": "DescribeEnvironment", "description": "获取环境基础信息", "status": "online", "parameters": [ { "name": "EnvironmentId", "type": "string", "required": true, "description": "命名空间id", "example": "en-xxxxxx" }, { "name": "SourceChannel", "type": "integer", "required": false, "description": "来源Channel", "example": "0" } ], "required": [ "EnvironmentId" ] }, { "name": "DescribeEnvironmentStatus", "description": "获取环境状态", "status": "online", "parameters": [ { "name": "EnvironmentIds", "type": "array", "required": true, "description": "命名空间id", "example": "en-xxxxxx", "item_type": "string" }, { "name": "SourceChannel", "type": "integer", "required": false, "description": "来源Channel", "example": "0" } ], "required": [ "EnvironmentIds" ] }, { "name": "DescribeEnvironments", "description": "获取环境列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "分页limit，默认：20", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页下标，默认：0", "example": "0" }, { "name": "SourceChannel", "type": "integer", "required": false, "description": "来源source", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "查询过滤器", "example": "1", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "查询字段名称", "example": "1" }, { "name": "Value", "type": "array", "required": false, "description": "查询字段值", "example": "1", "item_type": "string" } ] }, { "name": "SortInfo", "type": "object", "required": false, "description": "排序字段", "example": "{\"Key\":\"UpdateTime\",\"Type\":1}", "children": [ { "name": "Key", "type": "string", "required": false, "description": "排序字段名称", "example": "1" }, { "name": "Type", "type": "integer", "required": false, "description": "0：升序，1：倒序", "example": "0" } ] }, { "name": "EnvironmentId", "type": "string", "required": false, "description": "环境id", "example": "en-xxxxxx" } ], "required": [] }, { "name": "DescribeIngress", "description": "查询 Ingress 规则", "status": "online", "parameters": [ { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境ID", "example": "en-xxxxxx" }, { "name": "ClusterNamespace", "type": "string", "required": true, "description": "环境namespace", "example": "default" }, { "name": "IngressName", "type": "string", "required": true, "description": "ingress 规则名", "example": "name-xxx" }, { "name": "SourceChannel", "type": "integer", "required": false, "description": "来源渠道", "example": "0" } ], "required": [ "EnvironmentId", "ClusterNamespace", "IngressName" ] }, { "name": "DescribeIngresses", "description": "查询 Ingress 规则列表", "status": "online", "parameters": [ { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境 id", "example": "en-xxxxxx" }, { "name": "ClusterNamespace", "type": "string", "required": true, "description": "环境 namespace", "example": "default" }, { "name": "SourceChannel", "type": "integer", "required": false, "description": "来源渠道", "example": "0" }, { "name": "IngressNames", "type": "array", "required": false, "description": "ingress 规则名列表", "example": "[\"aa\"]", "item_type": "string" } ], "required": [ "EnvironmentId", "ClusterNamespace" ] }, { "name": "DescribeLogConfig", "description": "查询日志收集配置详情", "status": "online", "parameters": [ { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境 ID", "example": "en-xxxxxx" }, { "name": "Name", "type": "string", "required": true, "description": "配置名", "example": "abc-xxx" }, { "name": "ApplicationId", "type": "string", "required": true, "description": "应用 ID", "example": "app-xxx" } ], "required": [ "EnvironmentId", "Name", "ApplicationId" ] }, { "name": "DescribePagedLogConfigList", "description": "查询分页的日志收集配置列表", "status": "online", "parameters": [ { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境 ID", "example": "en-xxx" }, { "name": "ApplicationId", "type": "string", "required": false, "description": "应用 ID", "example": "app-xxx" }, { "name": "ApplicationName", "type": "string", "required": false, "description": "应用名", "example": "app-name-xxx" }, { "name": "Name", "type": "string", "required": false, "description": "规则名", "example": "rule-name" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页大小，默认 20", "example": "20" }, { "name": "ContinueToken", "type": "string", "required": false, "description": "翻页游标", "example": "some-token-value" } ], "required": [ "EnvironmentId" ] }, { "name": "DescribeRelatedIngresses", "description": "查询应用关联的 Ingress 规则列表", "status": "online", "parameters": [ { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境 id", "example": "en-xxxxxx" }, { "name": "ClusterNamespace", "type": "string", "required": true, "description": "环境 namespace", "example": "default" }, { "name": "ApplicationId", "type": "string", "required": true, "description": "应用 ID", "example": "app-xxxxxx" }, { "name": "SourceChannel", "type": "integer", "required": false, "description": "来源渠道", "example": "0" } ], "required": [ "EnvironmentId", "ClusterNamespace", "ApplicationId" ] }, { "name": "DestroyConfigData", "description": "销毁配置", "status": "online", "parameters": [ { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境 ID", "example": "en-xxxxxx" }, { "name": "Name", "type": "string", "required": true, "description": "配置名", "example": "abc-xxx" }, { "name": "SourceChannel", "type": "integer", "required": false, "description": "来源渠道", "example": "0" } ], "required": [ "EnvironmentId", "Name" ] }, { "name": "DestroyEnvironment", "description": "销毁环境", "status": "online", "parameters": [ { "name": "EnvironmentId", "type": "string", "required": true, "description": "命名空间ID", "example": "en-xxxxxx" }, { "name": "SourceChannel", "type": "integer", "required": false, "description": "来源渠道", "example": "0" } ], "required": [ "EnvironmentId" ] }, { "name": "DestroyLogConfig", "description": "销毁日志收集配置", "status": "online", "parameters": [ { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境 ID", "example": "en-xxxxxx" }, { "name": "Name", "type": "string", "required": true, "description": "配置名", "example": "name-xxx" }, { "name": "ApplicationId", "type": "string", "required": false, "description": "应用 ID", "example": "app-xxxxxx" } ], "required": [ "EnvironmentId", "Name" ] }, { "name": "DisableApplicationAutoscaler", "description": "关闭应用弹性策略组合", "status": "online", "parameters": [ { "name": "ApplicationId", "type": "string", "required": true, "description": "服务id", "example": "app-xxxxxx" }, { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境ID", "example": "en-xxxxxx" }, { "name": "AutoscalerId", "type": "string", "required": true, "description": "弹性伸缩策略ID", "example": "scaler-xxxxxx" }, { "name": "SourceChannel", "type": "integer", "required": false, "description": "来源渠道", "example": "0" } ], "required": [ "ApplicationId", "EnvironmentId", "AutoscalerId" ] }, { "name": "EnableApplicationAutoscaler", "description": "启用应用弹性策略组合", "status": "online", "parameters": [ { "name": "ApplicationId", "type": "string", "required": true, "description": "服务id", "example": "app-xxxxxx" }, { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境ID", "example": "en-xxxxxx" }, { "name": "AutoscalerId", "type": "string", "required": true, "description": "弹性伸缩策略ID", "example": "scaler-xxxxxx" }, { "name": "SourceChannel", "type": "integer", "required": false, "description": "来源渠道", "example": "0" } ], "required": [ "ApplicationId", "EnvironmentId", "AutoscalerId" ] }, { "name": "GenerateApplicationPackageDownloadUrl", "description": "生成应用程序包预签名下载链接", "status": "online", "parameters": [ { "name": "ApplicationId", "type": "string", "required": true, "description": "应用ID", "example": "app-xxxxxx" }, { "name": "PkgName", "type": "string", "required": true, "description": "包名", "example": "test.jar" }, { "name": "DeployVersion", "type": "string", "required": true, "description": "需要下载的包版本", "example": "v1" }, { "name": "SourceChannel", "type": "integer", "required": false, "description": "来源 channel", "example": "0" } ], "required": [ "ApplicationId", "PkgName", "DeployVersion" ] }, { "name": "ModifyApplicationAutoscaler", "description": "修改弹性伸缩策略组合", "status": "online", "parameters": [ { "name": "ApplicationId", "type": "string", "required": true, "description": "服务id", "example": "app-xxxxxx" }, { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境ID", "example": "en-xxxxxx" }, { "name": "AutoscalerId", "type": "string", "required": true, "description": "弹性伸缩策略ID", "example": "scaler-xxxxxx" }, { "name": "Autoscaler", "type": "object", "required": true, "description": "弹性伸缩策略", "example": "无", "children": [ { "name": "MinReplicas", "type": "integer", "required": true, "description": "弹性伸缩最小实例数", "example": "0" }, { "name": "MaxReplicas", "type": "integer", "required": true, "description": "弹性伸缩最大实例数", "example": "2" }, { "name": "HorizontalAutoscaler", "type": "array", "required": false, "description": "指标弹性伸缩策略(指标策略和定时策略必须填写一个)", "example": "{\"HorizontalAutoscaler\":[{\"DoubleThreshold\":50,\"Enabled\":true,\"MaxReplicas\":4,\"Metrics\":\"CPU\",\"MinReplicas\":0}]}", "item_type": "object", "children": [ { "name": "MinReplicas", "type": "integer", "required": false, "description": "最小实例数（可以不传）", "example": "1" }, { "name": "MaxReplicas", "type": "integer", "required": false, "description": "最大实例数（可以不传）", "example": "1" }, { "name": "Metrics", "type": "string", "required": false, "description": "指标度量 CPU（CPU使用率，%） MEMORY（内存使用率，%） CPU_CORE_USED（CPU使用量，core） MEMORY_SIZE_USED(内存使用量，MiB) NETWORK_BANDWIDTH_RECEIVE(网络入带宽，MBps) NETWORK_BANDWIDTH_TRANSMIT(网络出带宽，MBps) NETWORK_TRAFFIC_RECEIVE(网络入流量，MiB/s) NETWORK_TRAFFIC_TRANSMIT(网络出流量，MiB/s) NETWORK_PACKETS_RECEIVE(网络入包量，Count/s) NETWORK_PACKETS_TRANSMIT(网络出包量，Count/s) FS_IOPS_WRITE(磁盘写次数，Count/s) FS_IOP...", "example": "1" }, { "name": "Threshold", "type": "integer", "required": false, "description": "阈值（整数）", "example": "1" }, { "name": "Enabled", "type": "boolean", "required": false, "description": "是否启用", "example": "1" }, { "name": "DoubleThreshold", "type": "float", "required": false, "description": "阈值（小数，优先使用）", "example": "1" } ] }, { "name": "CronHorizontalAutoscaler", "type": "array", "required": false, "description": "定时弹性伸缩策略(指标策略和定时策略必须填写一个)", "example": "{\"CronHorizontalAutoscaler\":[{\"Enabled\":false,\"Name\":\"pk-test\",\"Period\":\"* * *\",\"Priority\":0,\"Schedules\":[{\"StartAt\":\"02:00\",\"TargetReplicas\":1}]}]}", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "定时伸缩策略名称", "example": "1" }, { "name": "Period", "type": "string", "required": false, "description": "策略周期 * * *，三个范围，第一个是天，第二个是月，第三个是周，中间用空格隔开 例子： * * * （每天） * * 0-3 （每周日到周三） 1,11,21 * *（每个月1号，11号，21号）", "example": "* * *" }, { "name": "Schedules", "type": "array", "required": false, "description": "定时伸缩策略明细", "example": "1", "item_type": "object", "children": [ { "name": "StartAt", "type": "string", "required": true, "description": "触发事件，小时分钟，用:分割 例如 00:00（零点零分触发）", "example": "00:00" }, { "name": "TargetReplicas", "type": "integer", "required": false, "description": "目标实例数（不大于50）", "example": "1" } ] }, { "name": "Enabled", "type": "boolean", "required": false, "description": "是否启用", "example": "1" }, { "name": "Priority", "type": "integer", "required": false, "description": "策略优先级，值越大优先级越高，0为最小值", "example": "1" } ] }, { "name": "AutoscalerId", "type": "string", "required": false, "description": "弹性伸缩ID", "example": "scaler-xxxxxx" }, { "name": "AutoscalerName", "type": "string", "required": false, "description": "弹性伸缩名称", "example": "scaler-name" }, { "name": "Description", "type": "string", "required": false, "description": "弹性伸缩描述", "example": "这是一个描述" }, { "name": "CreateDate", "type": "string", "required": false, "description": "创建日期", "example": "2024-10-25 16:36:10" }, { "name": "ModifyDate", "type": "string", "required": false, "description": "修改时间", "example": "2024-10-25 16:36:10" }, { "name": "EnableDate", "type": "string", "required": false, "description": "启用时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "2024-10-25 16:36:10" }, { "name": "Enabled", "type": "boolean", "required": false, "description": "是否启用", "example": "true" } ] }, { "name": "SourceChannel", "type": "integer", "required": false, "description": "来源渠道", "example": "0" } ], "required": [ "ApplicationId", "EnvironmentId", "AutoscalerId", "Autoscaler" ] }, { "name": "ModifyApplicationInfo", "description": "修改应用基本信息", "status": "online", "parameters": [ { "name": "ApplicationId", "type": "string", "required": true, "description": "应用ID", "example": "app-xxxxxx" }, { "name": "Description", "type": "string", "required": true, "description": "描述", "example": "服务a" }, { "name": "SourceChannel", "type": "integer", "required": false, "description": "来源渠道", "example": "0" }, { "name": "EnableTracing", "type": "integer", "required": false, "description": "是否开启调用链,（此参数已弃用）", "example": "1" } ], "required": [ "ApplicationId", "Description" ] }, { "name": "ModifyApplicationReplicas", "description": "修改应用实例数量", "status": "online", "parameters": [ { "name": "ApplicationId", "type": "string", "required": true, "description": "应用id", "example": "app-xxxxxx" }, { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境ID", "example": "en-xxxxxx" }, { "name": "Replicas", "type": "integer", "required": true, "description": "实例数量", "example": "1" }, { "name": "SourceChannel", "type": "integer", "required": false, "description": "来源渠道", "example": "0" } ], "required": [ "ApplicationId", "EnvironmentId", "Replicas" ] }, { "name": "ModifyApplicationService", "description": "修改服务访问方式列表", "status": "online", "parameters": [ { "name": "ApplicationId", "type": "string", "required": true, "description": "服务id", "example": "app-xxxxxx" }, { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境ID", "example": "en-xxxxxx" }, { "name": "SourceChannel", "type": "integer", "required": false, "description": "来源渠道", "example": "0" }, { "name": "Service", "type": "object", "required": false, "description": "全量访问方式设置", "example": "无", "children": [ { "name": "Name", "type": "string", "required": false, "description": "service name", "example": "name-xxx" }, { "name": "Ports", "type": "array", "required": false, "description": "可用端口", "example": "[8080]", "item_type": "integer" }, { "name": "Yaml", "type": "string", "required": false, "description": "yaml 内容", "example": "apiVersion: v1-xxxxxx" }, { "name": "ApplicationName", "type": "string", "required": false, "description": "服务名", "example": "app-name-xxx" }, { "name": "VersionName", "type": "string", "required": false, "description": "版本名", "example": "version-xxxx" }, { "name": "ClusterIp", "type": "array", "required": false, "description": "内网ip", "example": "172.xx.xx.xx", "item_type": "string" }, { "name": "ExternalIp", "type": "string", "required": false, "description": "外网ip", "example": "10.xx.xx.xx" }, { "name": "Type", "type": "string", "required": false, "description": "访问类型，可选值： - EXTERNAL（公网访问） - VPC（vpc内访问） - CLUSTER（集群内访问）", "example": "VPC" }, { "name": "SubnetId", "type": "string", "required": false, "description": "子网ID，只在类型为vpc访问时才有值", "example": "subnet-xxxxxx" }, { "name": "LoadBalanceId", "type": "string", "required": false, "description": "负载均衡ID，只在外网访问和vpc内访问才有值，默认自动创建", "example": "10.xx.xx.xx" }, { "name": "PortMappings", "type": "array", "required": false, "description": "端口映射", "example": "无", "item_type": "object", "children": [ { "name": "Port", "type": "integer", "required": true, "description": "端口", "example": "1" }, { "name": "TargetPort", "type": "integer", "required": true, "description": "映射端口", "example": "1" }, { "name": "Protocol", "type": "string", "required": true, "description": "协议栈 TCP/UDP", "example": "1" }, { "name": "ServiceName", "type": "string", "required": false, "description": "k8s service名称", "example": "service123" } ] }, { "name": "ServicePortMappingList", "type": "array", "required": false, "description": "每种类型访问配置详情", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": false, "description": "服务类型：如：EXTERNAL，VPC，CLUSTER", "example": "ClusterIP" }, { "name": "ServiceName", "type": "string", "required": false, "description": "服务名称", "example": "consumer" }, { "name": "ClusterIp", "type": "string", "required": false, "description": "集群内访问vip", "example": "10.0.0.2" }, { "name": "ExternalIp", "type": "string", "required": false, "description": "集群外方位vip", "example": "202.0.0.2" }, { "name": "SubnetId", "type": "string", "required": false, "description": "子网id", "example": "subnet-123" }, { "name": "VpcId", "type": "string", "required": false, "description": "vpc id", "example": "vpc-123" }, { "name": "LoadBalanceId", "type": "string", "required": false, "description": "LoadBalance Id", "example": "clb-123" }, { "name": "Yaml", "type": "string", "required": false, "description": "yaml 内容", "example": "yaml" }, { "name": "Ports", "type": "array", "required": false, "description": "暴露端口列表", "example": "[100,2000,3000]", "item_type": "integer" }, { "name": "PortMappingItemList", "type": "array", "required": false, "description": "端口映射数组", "example": "无", "item_type": "object", "children": [ { "name": "Port", "type": "integer", "required": false, "description": "应用访问端口", "example": "1000" }, { "name": "TargetPort", "type": "integer", "required": false, "description": "应用监听端口", "example": "2000" }, { "name": "Protocol", "type": "string", "required": false, "description": "协议类型", "example": "TCP" } ] }, { "name": "ExternalDomain", "type": "string", "required": false, "description": "clb domain", "example": "lb-xxxx.com" } ] }, { "name": "FlushAll", "type": "boolean", "required": false, "description": "刷新复写所有类型", "example": "true" }, { "name": "EnableRegistryNextDeploy", "type": "integer", "required": false, "description": "1: 下次部署自动注入注册中心信息；0：不注入 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "ApplicationId", "type": "string", "required": false, "description": "返回应用id", "example": "app-xxxxxx" }, { "name": "AllIpDone", "type": "boolean", "required": false, "description": "所有服务IP是否已经ready", "example": "false" }, { "name": "ExternalDomain", "type": "string", "required": false, "description": "clb 域名", "example": "lb-xxxx.com" } ] }, { "name": "Data", "type": "object", "required": false, "description": "单条访问方式设置", "example": "无", "children": [ { "name": "Type", "type": "string", "required": false, "description": "服务类型：如：EXTERNAL，VPC，CLUSTER", "example": "ClusterIP" }, { "name": "ServiceName", "type": "string", "required": false, "description": "服务名称", "example": "consumer" }, { "name": "ClusterIp", "type": "string", "required": false, "description": "集群内访问vip", "example": "10.0.0.2" }, { "name": "ExternalIp", "type": "string", "required": false, "description": "集群外方位vip", "example": "202.0.0.2" }, { "name": "SubnetId", "type": "string", "required": false, "description": "子网id", "example": "subnet-123" }, { "name": "VpcId", "type": "string", "required": false, "description": "vpc id", "example": "vpc-123" }, { "name": "LoadBalanceId", "type": "string", "required": false, "description": "LoadBalance Id", "example": "clb-123" }, { "name": "Yaml", "type": "string", "required": false, "description": "yaml 内容", "example": "yaml" }, { "name": "Ports", "type": "array", "required": false, "description": "暴露端口列表", "example": "[100,2000,3000]", "item_type": "integer" }, { "name": "PortMappingItemList", "type": "array", "required": false, "description": "端口映射数组", "example": "无", "item_type": "object", "children": [ { "name": "Port", "type": "integer", "required": false, "description": "应用访问端口", "example": "1000" }, { "name": "TargetPort", "type": "integer", "required": false, "description": "应用监听端口", "example": "2000" }, { "name": "Protocol", "type": "string", "required": false, "description": "协议类型", "example": "TCP" } ] }, { "name": "ExternalDomain", "type": "string", "required": false, "description": "clb domain", "example": "lb-xxxx.com" } ] } ], "required": [ "ApplicationId", "EnvironmentId" ] }, { "name": "ModifyConfigData", "description": "编辑配置", "status": "online", "parameters": [ { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境 ID", "example": "en-xxxxxx" }, { "name": "Name", "type": "string", "required": true, "description": "配置名", "example": "abc-xxxx" }, { "name": "Data", "type": "array", "required": true, "description": "配置信息", "example": "[{\"Key\":\"key-xxx\",\"Value\":\"val-xxx\",\"Type\":\"\",\"Config\":\"\",\"Secret\":\"\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "键", "example": "1" }, { "name": "Value", "type": "string", "required": true, "description": "值", "example": "1" }, { "name": "Type", "type": "string", "required": false, "description": "类型，default 为自定义，reserved 为系统变量，referenced 为引用配置项", "example": "default" }, { "name": "Config", "type": "string", "required": false, "description": "配置名称", "example": "configName" }, { "name": "Secret", "type": "string", "required": false, "description": "加密配置名称", "example": "1" } ] }, { "name": "SourceChannel", "type": "integer", "required": false, "description": "来源渠道", "example": "0" } ], "required": [ "EnvironmentId", "Name", "Data" ] }, { "name": "ModifyEnvironment", "description": "编辑环境", "status": "online", "parameters": [ { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境id", "example": "en-36pm4p8r" }, { "name": "EnvironmentName", "type": "string", "required": false, "description": "环境名称。环境名称不可修改", "example": "namespace-a" }, { "name": "Description", "type": "string", "required": false, "description": "环境描述", "example": "命名空间" }, { "name": "Vpc", "type": "string", "required": false, "description": "私有网络名称", "example": "vpc-1n5javez" }, { "name": "SubnetIds", "type": "array", "required": false, "description": "子网网络", "example": "subnet-m48cb76m", "item_type": "string" }, { "name": "SourceChannel", "type": "integer", "required": false, "description": "来源渠道", "example": "0" }, { "name": "EnvType", "type": "string", "required": false, "description": "环境类型：test、pre、prod", "example": "prod" } ], "required": [ "EnvironmentId" ] }, { "name": "ModifyGatewayIngress", "description": "修改网关的转发配置", "status": "online", "parameters": [ { "name": "EnvironmentId", "type": "string", "required": false, "description": "环境 ID", "example": "en-xxx" }, { "name": "GatewayName", "type": "string", "required": false, "description": "网关名称", "example": "gateway" }, { "name": "GatewayType", "type": "string", "required": false, "description": "网关类型，如 clb", "example": "clb" }, { "name": "Name", "type": "string", "required": false, "description": "转发配置名称", "example": "xxx" }, { "name": "Rules", "type": "array", "required": false, "description": "rules 配置", "example": "{}", "item_type": "object", "children": [ { "name": "Http", "type": "object", "required": true, "description": "ingress rule value", "example": "ingress rule value", "children": [ { "name": "Paths", "type": "array", "required": true, "description": "rule 整体配置", "example": "rulePaths 数组", "item_type": "object", "children": [ { "name": "Path", "type": "string", "required": true, "description": "path 信息", "example": "/xxx" }, { "name": "Backend", "type": "object", "required": true, "description": "backend 配置", "example": "{\"ServiceName\": \"serviceA\", \"ServicePort\": 8080}" } ] } ] }, { "name": "Host", "type": "string", "required": false, "description": "host 地址", "example": "xxx.com" }, { "name": "Protocol", "type": "string", "required": false, "description": "协议，选项为 http， https，默认为 http", "example": "protocol" } ] }, { "name": "Mixed", "type": "boolean", "required": false, "description": "是否混合 https，默认 false，可选值 true 代表有 https 协议监听", "example": "false" }, { "name": "Tls", "type": "array", "required": false, "description": "tls 配置", "example": "{}", "item_type": "object", "children": [ { "name": "Hosts", "type": "array", "required": true, "description": "host 数组, 空数组表示全部域名的默认证书", "example": "[\"xx.com\", \"yyy.com\"]", "item_type": "string" }, { "name": "SecretName", "type": "string", "required": true, "description": "secret name，如使用证书，则填空字符串", "example": "secret" }, { "name": "CertificateId", "type": "string", "required": false, "description": "SSL Certificate Id", "example": "CertificateId" } ] }, { "name": "RewriteType", "type": "string", "required": false, "description": "重定向模式，可选值： - AUTO（自动重定向http到https） - NONE（不使用重定向）", "example": "NONE" } ], "required": [] }, { "name": "ModifyIngress", "description": "此接口没有被使用了 创建或者更新 Ingress 规则", "status": "deprecated", "parameters": [ { "name": "Ingress", "type": "object", "required": true, "description": "Ingress 规则配置", "example": "无", "children": [ { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境ID", "example": "en-xxxxxx" }, { "name": "AddressIPVersion", "type": "string", "required": true, "description": "ip version", "example": "IPV4" }, { "name": "IngressName", "type": "string", "required": true, "description": "ingress name", "example": "ingress name" }, { "name": "Rules", "type": "array", "required": true, "description": "rules 配置", "example": "rules 配置", "item_type": "object", "children": [ { "name": "Http", "type": "object", "required": true, "description": "ingress rule value", "example": "ingress rule value", "children": [ { "name": "Paths", "type": "array", "required": true, "description": "rule 整体配置", "example": "rulePaths 数组", "item_type": "string" } ] }, { "name": "Host", "type": "string", "required": false, "description": "host 地址", "example": "xxx.com" }, { "name": "Protocol", "type": "string", "required": false, "description": "协议，选项为 http， https，默认为 http", "example": "protocol" } ] }, { "name": "ClbId", "type": "string", "required": true, "description": "clb ID", "example": "clb-xxx" }, { "name": "ClusterNamespace", "type": "string", "required": false, "description": "环境namespace", "example": "default" }, { "name": "Tls", "type": "array", "required": false, "description": "tls 配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "tls 配置", "item_type": "object", "children": [ { "name": "Hosts", "type": "array", "required": true, "description": "host 数组, 空数组表示全部域名的默认证书", "example": "[\"xx.com\", \"yyy.com\"]", "item_type": "string" }, { "name": "SecretName", "type": "string", "required": true, "description": "secret name，如使用证书，则填空字符串", "example": "secret" }, { "name": "CertificateId", "type": "string", "required": false, "description": "SSL Certificate Id", "example": "CertificateId" } ] }, { "name": "ClusterId", "type": "string", "required": false, "description": "环境集群ID", "example": "cls-xxx" }, { "name": "Vip", "type": "string", "required": false, "description": "clb ip", "example": "10.10.10.10" }, { "name": "CreateTime", "type": "string", "required": false, "description": "创建时间", "example": "2010-11-11 22:21:11" }, { "name": "Mixed", "type": "boolean", "required": false, "description": "是否混合 https，默认 false，可选值 true 代表有 https 协议监听", "example": "false" }, { "name": "RewriteType", "type": "string", "required": false, "description": "重定向模式，可选值： - AUTO（自动重定向http到https） - NONE（不使用重定向）", "example": "1" }, { "name": "Domain", "type": "string", "required": false, "description": "clb 域名", "example": "lb-xxx" } ] }, { "name": "SourceChannel", "type": "integer", "required": false, "description": "来源渠道", "example": "0" } ], "required": [ "Ingress" ] }, { "name": "ModifyLogConfig", "description": "编辑日志收集配置", "status": "online", "parameters": [ { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境 ID", "example": "en-xxxxxx" }, { "name": "Name", "type": "string", "required": true, "description": "配置名", "example": "abc-xxxx" }, { "name": "Data", "type": "object", "required": true, "description": "日志收集配置信息", "example": "{\"LogsetId\":\"4d43fac5-fc0a-42bf-92a9-ef5b5b245e6a\",\"TopicId\":\"dbebda3e-0a9a-4888-9d5c-642bf2ffa183\",\"InputType\":\"container_stdout\",\"LogType\":\"json_log\",\"ExtractRule\":{\"FilterKeys\":[],\"FilterRegex\":[],\"UnMatchUpload\":\"true\",\"UnMatchedKey\":\"LogParseFailure\"}}", "children": [ { "name": "Name", "type": "string", "required": false, "description": "名称", "example": "ab-xxx" }, { "name": "InputType", "type": "string", "required": false, "description": "收集类型，container_stdout 为标准输出；container_file 为文件；", "example": "container_stdout" }, { "name": "LogsetId", "type": "string", "required": false, "description": "日志集 ID", "example": "4d43fac5-fc0a-42bf-92a9-ef5b5b245e6a" }, { "name": "TopicId", "type": "string", "required": false, "description": "日志主题 ID", "example": "dbebda3e-0a9a-4888-9d5c-642bf2ffa183" }, { "name": "LogType", "type": "string", "required": false, "description": "日志提取模式，minimalist_log 为单行全文；multiline_log 为多行全文； fullregex_log 为单行正则； multiline_fullregex_log 为多行正则； json_log 为 json；", "example": "json_log" }, { "name": "BeginningRegex", "type": "string", "required": false, "description": "首行正则表达式，当 LogType 为多行全文、多行正则时生效", "example": "^ERROR" }, { "name": "LogPath", "type": "string", "required": false, "description": "收集文件目录，当 InputType=container_file 时生效", "example": "/abc" }, { "name": "FilePattern", "type": "string", "required": false, "description": "收集文件名模式，当 InputType=container_file 时生效", "example": "app_*.log" }, { "name": "CreateDate", "type": "string", "required": false, "description": "创建时间", "example": "2022-05-20T14:42:16Z" }, { "name": "ModifyDate", "type": "string", "required": false, "description": "更新时间", "example": "2022-05-20T14:42:16Z" }, { "name": "ApplicationId", "type": "string", "required": false, "description": "应用 ID", "example": "app-xxx" }, { "name": "ApplicationName", "type": "string", "required": false, "description": "应用名", "example": "abc-xxx" }, { "name": "ExtractRule", "type": "object", "required": false, "description": "导出规则", "example": "无", "children": [ { "name": "BeginningRegex", "type": "string", "required": false, "description": "首行正则表达式", "example": "^ERROR" }, { "name": "Keys", "type": "array", "required": false, "description": "提取结果", "example": "[\"k1\", \"k2\"]", "item_type": "string" }, { "name": "FilterKeys", "type": "array", "required": false, "description": "过滤键", "example": "[\"k1\"]", "item_type": "string" }, { "name": "FilterRegex", "type": "array", "required": false, "description": "过滤值", "example": "[\"v1*\"]", "item_type": "string" }, { "name": "LogRegex", "type": "string", "required": false, "description": "日志正则表达式", "example": "^Info" }, { "name": "TimeKey", "type": "string", "required": false, "description": "时间字段", "example": "time" }, { "name": "TimeFormat", "type": "string", "required": false, "description": "时间格式", "example": "%Y-%m-%d %H:%M:%S" }, { "name": "UnMatchUpload", "type": "string", "required": false, "description": "是否上传解析失败日志", "example": "true" }, { "name": "UnMatchedKey", "type": "string", "required": false, "description": "解析失败日志的键名称", "example": "LogParseFailure" }, { "name": "Backtracking", "type": "string", "required": false, "description": "tracking", "example": "tracking-xxx" }, { "name": "Delimiter", "type": "string", "required": false, "description": "分隔符", "example": ":" } ] } ] }, { "name": "ApplicationId", "type": "string", "required": true, "description": "应用 ID", "example": "app-xxxxxx" } ], "required": [ "EnvironmentId", "Name", "Data", "ApplicationId" ] }, { "name": "RestartApplication", "description": "服务重启", "status": "online", "parameters": [ { "name": "ApplicationId", "type": "string", "required": true, "description": "服务id", "example": "app-xxxxxx" }, { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境ID/命名空间ID", "example": "en-xxxxxx" }, { "name": "SourceChannel", "type": "integer", "required": false, "description": "来源渠道", "example": "0" } ], "required": [ "ApplicationId", "EnvironmentId" ] }, { "name": "RestartApplicationPod", "description": "重启应用实例", "status": "online", "parameters": [ { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境id", "example": "en-xxxxxx" }, { "name": "ApplicationId", "type": "string", "required": true, "description": "应用id", "example": "app-xxxxxx" }, { "name": "PodName", "type": "string", "required": true, "description": "名字", "example": "pod-a" }, { "name": "Limit", "type": "integer", "required": false, "description": "单页条数", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页下标", "example": "1" }, { "name": "Status", "type": "string", "required": false, "description": "pod状态", "example": "Running" }, { "name": "SourceChannel", "type": "integer", "required": false, "description": "来源渠道", "example": "0" } ], "required": [ "EnvironmentId", "ApplicationId", "PodName" ] }, { "name": "ResumeDeployApplication", "description": "开始下一批次发布", "status": "online", "parameters": [ { "name": "ApplicationId", "type": "string", "required": true, "description": "需要开始下一批次的服务id", "example": "app-xxxxxx" }, { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境id", "example": "en-xxxxxx" } ], "required": [ "ApplicationId", "EnvironmentId" ] }, { "name": "RevertDeployApplication", "description": "回滚分批发布", "status": "online", "parameters": [ { "name": "ApplicationId", "type": "string", "required": true, "description": "需要回滚的服务id", "example": "app-xxxxxx" }, { "name": "EnvironmentId", "type": "string", "required": true, "description": "需要回滚的服务所在环境id", "example": "en-xxxxxx" } ], "required": [ "ApplicationId", "EnvironmentId" ] }, { "name": "RollingUpdateApplicationByVersion", "description": "更新应用部署版本", "status": "online", "parameters": [ { "name": "ApplicationId", "type": "string", "required": true, "description": "应用ID", "example": "app-xxxxxx" }, { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境ID", "example": "en-xxxxxx" }, { "name": "DeployVersion", "type": "string", "required": true, "description": "更新版本，IMAGE 部署为 tag 值；JAR/WAR 部署 为 Version", "example": "v1" }, { "name": "PackageName", "type": "string", "required": false, "description": "JAR/WAR 包名，仅 JAR/WAR 部署时必填", "example": "package-name-xxx.jar" }, { "name": "From", "type": "string", "required": false, "description": "请求来源平台，含 IntelliJ，Coding", "example": "IntelliJ" }, { "name": "DeployStrategyType", "type": "string", "required": false, "description": "部署策略，AUTO 为全自动；BETA 为小批量验证后自动；MANUAL 为全手动；", "example": "AUTO" }, { "name": "TotalBatchCount", "type": "integer", "required": false, "description": "发布批次数", "example": "2" }, { "name": "BatchInterval", "type": "integer", "required": false, "description": "批次间隔时间", "example": "60" }, { "name": "BetaBatchNum", "type": "integer", "required": false, "description": "小批量验证批次的实例数", "example": "1" }, { "name": "MinAvailable", "type": "integer", "required": false, "description": "发布过程中保障的最小可用实例数", "example": "1" }, { "name": "Force", "type": "boolean", "required": false, "description": "是否强制发布", "example": "force" } ], "required": [ "ApplicationId", "EnvironmentId", "DeployVersion" ] }, { "name": "StopApplication", "description": "服务停止", "status": "online", "parameters": [ { "name": "ApplicationId", "type": "string", "required": true, "description": "服务id", "example": "app-xxxxxx" }, { "name": "EnvironmentId", "type": "string", "required": true, "description": "环境ID/命名空间ID", "example": "en-xxxxxx" }, { "name": "SourceChannel", "type": "integer", "required": false, "description": "来源渠道", "example": "0" } ], "required": [ "ApplicationId", "EnvironmentId" ] } ] }