{ "name": "tsf", "display_name": "TSF-应用管理\u0026Consul", "description": "介绍如何使用API对腾讯微服务平台TSF进行操作，包括部署组、程序包管理等。", "domain": "other", "api_version": "2018-03-26", "endpoint": "tsf.tencentcloudapi.com", "actions": [ { "name": "AddClusterInstances", "description": "添加云主机节点至TSF集群", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID，按照【集群ID】进行过滤，可通过调用[DescribeClusters](https://cloud.tencent.com/document/product/649/85857)查询已创建的集群列表或登录控制台进行查看；也可以调用[CreateCluster](https://cloud.tencent.com/document/product/649/36049)创建新的集群。仅在集群下无部署组、命名空间、云主机时可以删除。", "example": "cluster-4zu6vmes" }, { "name": "InstanceIdList", "type": "array", "required": true, "description": "云主机ID列表，可通过调用[DescribeInstances](https://cloud.tencent.com/document/api/213/15728)查询已创建的云主机列表或登录控制台进行查看；也可以调用[RunInstances](https://cloud.tencent.com/document/api/213/15730)创建新的云主机。", "example": "[\"ins-4zu6vmes\",\"ins-4zu6vabe\"]", "item_type": "string" }, { "name": "OsName", "type": "string", "required": false, "description": "操作系统名称", "example": "centos 7.5" }, { "name": "ImageId", "type": "string", "required": false, "description": "操作系统镜像ID", "example": "img-4zu6vmes" }, { "name": "Password", "type": "string", "required": false, "description": "重装系统密码设置", "example": "4zu6vmes" }, { "name": "KeyId", "type": "string", "required": false, "description": "重装系统，关联密钥设置", "example": "skey-4zu6vmes" }, { "name": "SgId", "type": "string", "required": false, "description": "安全组设置", "example": "sg-4ae4pzgg" }, { "name": "InstanceImportMode", "type": "string", "required": false, "description": "云主机导入方式，虚拟机集群必填，容器集群不填写此字段，R：重装TSF系统镜像，M：手动安装agent", "example": "R" }, { "name": "OsCustomizeType", "type": "string", "required": false, "description": "镜像定制类型", "example": "DOCKER_CUSTOMIZE：表示容器定制版。 GENERAL：表示普通版本，默认值。" }, { "name": "FeatureIdList", "type": "array", "required": false, "description": "镜像特征ID列表", "example": "[\"feature-24aq56bg\"]", "item_type": "string" }, { "name": "InstanceAdvancedSettings", "type": "object", "required": false, "description": "实例额外需要设置参数信息", "example": "无", "children": [ { "name": "MountTarget", "type": "string", "required": true, "description": "数据盘挂载点, 默认不挂载数据盘. 已格式化的 ext3，ext4，xfs 文件系统的数据盘将直接挂载，其他文件系统或未格式化的数据盘将自动格式化为ext4 并挂载，请注意备份数据! 无数据盘或有多块数据盘的云主机此设置不生效。 注意，注意，多盘场景请使用下方的DataDisks数据结构，设置对应的云盘类型、云盘大小、挂载路径、是否格式化等信息。 注意：此字段可能返回 null，表示\ufffd...", "example": "ext4" }, { "name": "DockerGraphPath", "type": "string", "required": true, "description": "dockerd --graph 指定值, 默认为 /var/lib/docker 注意：此字段可能返回 null，表示取不到有效值。", "example": "/var/lib/docker" } ] }, { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "安全组 ID 列表", "example": "[\"sg-4ae4pzgg\", \"sg-4ae4pzgh\"]", "item_type": "string" } ], "required": [ "ClusterId", "InstanceIdList" ] }, { "name": "AddInstances", "description": "添加云主机节点至TSF集群", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID，按照【集群ID】进行过滤，可通过调用[DescribeClusters](https://cloud.tencent.com/document/product/649/85857)查询已创建的集群列表或登录控制台进行查看；也可以调用[CreateCluster](https://cloud.tencent.com/document/product/649/36049)创建新的集群。仅在集群下无部署组、命名空间、云主机时可以删除。", "example": "cls-6a79x94v" }, { "name": "InstanceIdList", "type": "array", "required": true, "description": "云主机ID列表，可通过调用[DescribeInstances](https://cloud.tencent.com/document/api/213/15728)查询已创建的云主机列表或登录控制台进行查看；也可以调用[RunInstances](https://cloud.tencent.com/document/api/213/15730)创建新的云主机。", "example": "[\"ins-6a79x94v\"]", "item_type": "string" }, { "name": "OsName", "type": "string", "required": false, "description": "操作系统名称", "example": "centos" }, { "name": "ImageId", "type": "string", "required": false, "description": "操作系统镜像ID", "example": "img-6a79x94v" }, { "name": "Password", "type": "string", "required": false, "description": "重装系统密码设置", "example": "passxxxxx" }, { "name": "KeyId", "type": "string", "required": false, "description": "重装系统，关联密钥设置", "example": "key-xxxxxx" }, { "name": "SgId", "type": "string", "required": false, "description": "安全组设置", "example": "sg-6a79x94v" }, { "name": "InstanceImportMode", "type": "string", "required": false, "description": "云主机导入方式，虚拟机集群必填，容器集群不填写此字段，R：重装TSF系统镜像，M：手动安装agent", "example": "R" }, { "name": "SecurityGroupIds", "type": "string", "required": false, "description": "安全组id", "example": "[\"sg-6a79x94v\"]" } ], "required": [ "ClusterId", "InstanceIdList" ] }, { "name": "AssociateBusinessLogConfig", "description": "关联日志配置项到应用", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "部署组ID 可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/product/649/36068)或[DescribeGroups](https://cloud.tencent.com/document/product/649/36065)查询已创建的部署组列表或登录[控制台](https://console.cloud.tencent.com/tsf/app-detail?rid=1\u0026id=application-yo7kp9dv\u0026tab=publish\u0026subTab=group)进行查看", "example": "group-6a79x94v" }, { "name": "ConfigIdList", "type": "array", "required": false, "description": "日志配置项ID列表 可通过调用[DescribeBusinessLogConfigs](https://cloud.tencent.com/document/product/649/75777)查询已创建的日志配置项列表或登录[控制台](https://console.cloud.tencent.com/tsf/observable/log?rid=1)进行查看", "example": "[\"config-6a79x94v\"]", "item_type": "string" } ], "required": [ "GroupId" ] }, { "name": "AssociateConfigWithGroup", "description": "关联投递配置到部署组", "status": "online", "parameters": [ { "name": "ConfigId", "type": "string", "required": true, "description": "配置项ID 可通过调用[DescribeBusinessLogConfigs](https://cloud.tencent.com/document/product/649/75777)查询已创建的日志配置项列表或登录[控制台](https://console.cloud.tencent.com/tsf/observable/log?rid=1)进行查看", "example": "send-data-to-kafka-6a79x94v" }, { "name": "Groups", "type": "array", "required": false, "description": "部署组信息", "example": "无", "item_type": "object", "children": [ { "name": "GroupId", "type": "string", "required": true, "description": "部署组ID 可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/product/649/36068)或[DescribeGroups](https://cloud.tencent.com/document/product/649/36065)查询已创建的部署组列表或登录[控制台](https://console.cloud.tencent.com/tsf/app-detail?rid=1\u0026id=application-yo7kp9dv\u0026tab=publish\u0026subTab=group)进行查看。", "example": "group-6a79x94v" }, { "name": "GroupName", "type": "string", "required": true, "description": "部署组名称", "example": "group-demo" }, { "name": "ClusterType", "type": "string", "required": true, "description": "集群类型，C：容器集群，V：虚拟机集群", "example": "C" }, { "name": "ClusterId", "type": "string", "required": false, "description": "集群ID 可通过[DescribeClusters](https://cloud.tencent.com/document/product/649/85857)查询已经创建的集群列表，也可以通过登录[控制台](https://console.cloud.tencent.com/tsf/resource?rid=1)查看。", "example": "cls-6a79x94v" }, { "name": "ClusterName", "type": "string", "required": false, "description": "集群名称", "example": "k8s-cls" }, { "name": "NamespaceName", "type": "string", "required": false, "description": "命名空间名称", "example": "my-namespace" }, { "name": "AssociateTime", "type": "string", "required": false, "description": "绑定时间，格式yyyy-MM-dd HH:mm:ss", "example": "2020-12-23 12:34:34" } ] }, { "name": "SelectAll", "type": "integer", "required": false, "description": "是否选择全部投递，1 表示全部，0或不填表示非全部", "example": "1" }, { "name": "NamespaceId", "type": "string", "required": false, "description": "命名空间ID 可通过[DescribeSimpleNamespaces](https://cloud.tencent.com/document/product/649/36096)查询已经创建的命名空间，也可以通过登录[控制台](https://console.cloud.tencent.com/tsf/resource?rid=1\u0026tab=namespace)查看", "example": "namespace-6a79x94v" }, { "name": "ClusterId", "type": "string", "required": false, "description": "集群ID 可通过[DescribeClusters](https://cloud.tencent.com/document/product/649/85857)查询已经创建的集群列表，也可以通过登录[控制台](https://console.cloud.tencent.com/tsf/resource?rid=1)查看", "example": "cls-6a79x94v" }, { "name": "SearchWord", "type": "string", "required": false, "description": "模糊搜索关键词", "example": "config-template" } ], "required": [ "ConfigId" ] }, { "name": "BindApiGroup", "description": "网关与API分组批量绑定", "status": "online", "parameters": [ { "name": "GroupGatewayList", "type": "array", "required": true, "description": "分组绑定网关列表", "example": "[{\"GatewayDeployGroupId\":\"group-yo99lney\",\"GroupId\":\"grp-djvzrdih\"}]", "item_type": "object", "children": [ { "name": "GatewayDeployGroupId", "type": "string", "required": true, "description": "网关部署组ID", "example": "group-xoydmy26" }, { "name": "GroupId", "type": "string", "required": true, "description": "分组id", "example": "grp-57at58po" } ] } ], "required": [ "GroupGatewayList" ] }, { "name": "BindPlugin", "description": "插件与网关分组/API批量绑定", "status": "online", "parameters": [ { "name": "PluginInstanceList", "type": "array", "required": true, "description": "分组/API绑定插件列表", "example": "无", "item_type": "object", "children": [ { "name": "PluginId", "type": "string", "required": true, "description": "插件id", "example": "pgn-ete4dvco" }, { "name": "ScopeType", "type": "string", "required": true, "description": "插件绑定到的对象类型:group/api/all", "example": "group" }, { "name": "ScopeValue", "type": "string", "required": true, "description": "插件绑定到的对象主键值，例如分组的ID/API的ID", "example": "grp-y7j1qhk3" }, { "name": "MicroserviceId", "type": "string", "required": false, "description": "创建关联的服务id，关联envoy网关时使用", "example": "ms-by8o5kgv" }, { "name": "GatewayInstanceId", "type": "string", "required": false, "description": "网关id", "example": "gw-ins-anrptnkf" } ] } ], "required": [ "PluginInstanceList" ] }, { "name": "ChangeApiUsableStatus", "description": "启用或禁用API", "status": "online", "parameters": [ { "name": "ApiId", "type": "string", "required": true, "description": "API ID", "example": "api-m42wysh0" }, { "name": "UsableStatus", "type": "string", "required": true, "description": "切换状态，enabled/disabled", "example": "enabled" } ], "required": [ "ApiId", "UsableStatus" ] }, { "name": "ContinueRunFailedTaskBatch", "description": "分布式任务调度 TCT 已到达 EOMS 节点，进行产品下线处理。退市公告https://cloud.tencent.com/announce/detail/2053 对执行失败的任务批次执行续跑", "status": "deprecated", "parameters": [ { "name": "BatchId", "type": "string", "required": true, "description": "任务批次ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)页面点击任务ID进入执行记录页，第一列即为任务批次ID，在[任务执行记录](https://console.cloud.tencent.com/tsf/tct?rid=1\u0026tab=task)页能查看所有任务批次ID。", "example": "batch-6a79x94v" } ], "required": [ "BatchId" ] }, { "name": "CreateAllGatewayApiAsync", "description": "一键导入API分组", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "API分组ID", "example": "grp-notmqbpe" }, { "name": "MicroserviceId", "type": "string", "required": true, "description": "微服务ID", "example": "ms-y5w8n5e9" }, { "name": "NamespaceId", "type": "string", "required": false, "description": "命名空间ID", "example": "namespace-v3gw3lna" } ], "required": [ "GroupId", "MicroserviceId" ] }, { "name": "CreateApiGroup", "description": "创建API分组", "status": "online", "parameters": [ { "name": "GroupName", "type": "string", "required": true, "description": "分组名称, 不能包含中文", "example": "grp_user" }, { "name": "GroupContext", "type": "string", "required": true, "description": "分组上下文", "example": "/grp_user" }, { "name": "AuthType", "type": "string", "required": false, "description": "鉴权类型。secret： 密钥鉴权； none:无鉴权", "example": "none" }, { "name": "Description", "type": "string", "required": false, "description": "备注", "example": "This is desc" }, { "name": "GroupType", "type": "string", "required": false, "description": "分组类型,默认ms。 ms： 微服务分组； external:外部Api分组", "example": "ms" }, { "name": "GatewayInstanceId", "type": "string", "required": false, "description": "网关实体ID", "example": "gw-ins-szesmg28" }, { "name": "NamespaceNameKey", "type": "string", "required": false, "description": "命名空间参数key值", "example": "TSF-NamespaceName" }, { "name": "ServiceNameKey", "type": "string", "required": false, "description": "微服务名参数key值", "example": "TSF-ServiceName" }, { "name": "NamespaceNameKeyPosition", "type": "string", "required": false, "description": "命名空间参数位置，path，header或query，默认是path", "example": "path" }, { "name": "ServiceNameKeyPosition", "type": "string", "required": false, "description": "微服务名参数位置，path，header或query，默认是path", "example": "path" } ], "required": [ "GroupName", "GroupContext" ] }, { "name": "CreateApiRateLimitRule", "description": "创建API限流规则", "status": "online", "parameters": [ { "name": "ApiId", "type": "string", "required": true, "description": "Api Id", "example": "api-8c7538te" }, { "name": "MaxQps", "type": "integer", "required": true, "description": "qps值", "example": "10000" }, { "name": "UsableStatus", "type": "string", "required": false, "description": "开启/禁用，enabled/disabled, 不传默认开启", "example": "enabled" } ], "required": [ "ApiId", "MaxQps" ] }, { "name": "CreateApiRateLimitRuleWithDetailResp", "description": "创建API限流规则,并返回规则信息", "status": "online", "parameters": [ { "name": "ApiId", "type": "string", "required": true, "description": "Api Id", "example": "api-7h13jx9z" }, { "name": "MaxQps", "type": "integer", "required": true, "description": "qps值", "example": "20" }, { "name": "UsableStatus", "type": "string", "required": false, "description": "开启/禁用，enabled/disabled, 不传默认开启", "example": "enabled" } ], "required": [ "ApiId", "MaxQps" ] }, { "name": "CreateApplication", "description": "创建应用", "status": "online", "parameters": [ { "name": "ApplicationName", "type": "string", "required": true, "description": "应用名称，最长60字符", "example": "application-user" }, { "name": "ApplicationType", "type": "string", "required": true, "description": "应用类型，V：虚拟机应用；C：容器应用；S：serverless应用", "example": "C" }, { "name": "MicroserviceType", "type": "string", "required": true, "description": "应用微服务类型，M：service mesh应用；N：普通应用；G：网关应用", "example": "N" }, { "name": "ApplicationDesc", "type": "string", "required": false, "description": "应用描述", "example": "应用描述" }, { "name": "ApplicationRuntimeType", "type": "string", "required": false, "description": "应用runtime类型", "example": "Java 8" }, { "name": "ProgramId", "type": "string", "required": false, "description": "【数据集ID】。可通过调用[DescribePrograms](https://cloud.tencent.com/document/product/649/73477)查询已创建的数据集列表或登录[控制台](https://console.cloud.tencent.com/tsf/privilege?rid=1\u0026tab=program\u0026roleId=role-a26486wy)进行查看；也可以调用[CreateProgram](https://cloud.tencent.com/document/product/649/108544)创建新的数据集。", "example": "program-6a79x94v" }, { "name": "ServiceConfigList", "type": "array", "required": false, "description": "服务配置信息列表", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "服务名", "example": "java-demo" }, { "name": "Ports", "type": "array", "required": true, "description": "端口信息列表", "example": "无", "item_type": "object", "children": [ { "name": "TargetPort", "type": "integer", "required": true, "description": "服务端口", "example": "8080" }, { "name": "Protocol", "type": "string", "required": true, "description": "端口协议，TCP或者UDP", "example": "TCP" } ] }, { "name": "HealthCheck", "type": "object", "required": false, "description": "健康检查配置", "example": "无", "children": [ { "name": "Path", "type": "string", "required": false, "description": "健康检查路径", "example": "/health" } ] } ] }, { "name": "IgnoreCreateImageRepository", "type": "boolean", "required": false, "description": "忽略创建镜像仓库", "example": "true" }, { "name": "ProgramIdList", "type": "array", "required": false, "description": "数据集id列表", "example": "[\"program-6a79x94v\"]", "item_type": "string" }, { "name": "ApmInstanceId", "type": "string", "required": false, "description": "apm业务系统id", "example": "apm-6a79x94v" }, { "name": "ProgramLanguage", "type": "string", "required": false, "description": "编程语言: Java；C/C++；Python；Go；Other", "example": "Java" }, { "name": "FrameworkType", "type": "string", "required": false, "description": "开发框架-SpringCloud/Dubbo/Go-GRPC/Other", "example": "SpringCloud" }, { "name": "ServiceGovernanceConfig", "type": "object", "required": false, "description": "注册配置治理", "example": "无", "children": [ { "name": "EnableGovernance", "type": "boolean", "required": false, "description": "是否开启服务注册治理", "example": "true" }, { "name": "GovernanceType", "type": "string", "required": false, "description": "服务治理类型（枚举：SHARE表示共享型、EXCLUSIVE表示独占型）", "example": "SHARE" }, { "name": "ExclusiveInstances", "type": "array", "required": false, "description": "独享实例列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "CenterType", "type": "string", "required": false, "description": "配置中心类型[注册中心Registration、配置中心Configuration]", "example": "Registration" }, { "name": "InstanceId", "type": "string", "required": false, "description": "实例id，通过[北极星控制台](https://console.cloud.tencent.com/tse/governance)获取", "example": "ins-6a79x94v" }, { "name": "InstanceType", "type": "string", "required": false, "description": "实例类型，例如北极星Polaris", "example": "Polaris" }, { "name": "InstanceName", "type": "string", "required": false, "description": "实例名称", "example": "Polaris-Config" }, { "name": "RegionId", "type": "string", "required": false, "description": "实例地域id，通过[北极星控制台](https://console.cloud.tencent.com/tse/governance)获取", "example": "7" }, { "name": "InstanceNamespaceId", "type": "string", "required": false, "description": "实例命名空间ID，通过[北极星控制台](https://console.cloud.tencent.com/tse/governance)获取", "example": "namespace-6a79x94v" }, { "name": "GroupId", "type": "string", "required": false, "description": "部署组Id 注意：此字段可能返回 null，表示取不到有效值。", "example": "group-6a73eg5v" }, { "name": "CreateTime", "type": "integer", "required": false, "description": "创建时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "1757324401000" }, { "name": "UpdateTime", "type": "integer", "required": false, "description": "更新时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "1757324863000" } ] } ] }, { "name": "CreateSameNameImageRepository", "type": "boolean", "required": false, "description": "是否创建并关联同名镜像仓库", "example": "true" } ], "required": [ "ApplicationName", "ApplicationType", "MicroserviceType" ] }, { "name": "CreateCluster", "description": "创建集群", "status": "online", "parameters": [ { "name": "ClusterName", "type": "string", "required": true, "description": "集群名称", "example": "DEMO-DOCKER" }, { "name": "ClusterType", "type": "string", "required": true, "description": "指定集群类型，目前支持： - `V`：虚拟机集群 - `C`：容器集群 - `S`：Serverless 集群", "example": "C" }, { "name": "VpcId", "type": "string", "required": true, "description": "私有网络ID，可通过调用[DescribeVpcEx](https://cloud.tencent.com/document/api/215/1372)查询已创建的私有网络列表或登录控制台进行查看；也可以调用[CreateVpc](https://cloud.tencent.com/document/api/215/1309)创建新的私有网络。", "example": "vpc-6a79x94v" }, { "name": "ClusterCIDR", "type": "string", "required": false, "description": "分配给集群容器和服务IP的CIDR", "example": "172.16.0.0/16" }, { "name": "ClusterDesc", "type": "string", "required": false, "description": "集群备注", "example": "desc" }, { "name": "TsfRegionId", "type": "string", "required": false, "description": "集群所属TSF地域", "example": "ap-guangzhou" }, { "name": "TsfZoneId", "type": "string", "required": false, "description": "集群所属TSF可用区", "example": "100004" }, { "name": "SubnetId", "type": "string", "required": false, "description": "私有网络子网ID", "example": "id" }, { "name": "ClusterVersion", "type": "string", "required": false, "description": "集群版本", "example": "1.18" }, { "name": "MaxNodePodNum", "type": "integer", "required": false, "description": "集群中每个Node上最大的Pod数量。取值范围4～256。不为2的幂值时会向上取最接近的2的幂值。", "example": "128" }, { "name": "MaxClusterServiceNum", "type": "integer", "required": false, "description": "集群最大的service数量。取值范围32～32768，不为2的幂值时会向上取最接近的2的幂值。", "example": "32" }, { "name": "ProgramId", "type": "string", "required": false, "description": "需要绑定的数据集ID", "example": "program-6a79x94v" }, { "name": "KuberneteApiServer", "type": "string", "required": false, "description": "api地址", "example": "https://10.10.1.2:6443" }, { "name": "KuberneteNativeType", "type": "string", "required": false, "description": "K : kubeconfig, S : service account (公有云不支持通过kubeconfig和service account的方式创建集群)", "example": "K" }, { "name": "KuberneteNativeSecret", "type": "string", "required": false, "description": "Kubernetes 原生 Secret 资源对象", "example": "mock-secret" }, { "name": "ProgramIdList", "type": "array", "required": false, "description": "需要绑定的数据集ID。该参数可以通过调用 [DescribePrograms](https://cloud.tencent.com/document/product/649/73477) 的返回值中的 ProgramId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/privilege?tab=program\u0026roleId=role-yrle4doy)查看；也可以调用[CreateProgram](https://cloud.tencent.com/document/product/649/108544)创建新的数据集。", "example": "[\"program-6a79x94v\"]", "item_type": "string" }, { "name": "EnableLogCollection", "type": "boolean", "required": false, "description": "是否开启cls日志功能", "example": "false" } ], "required": [ "ClusterName", "ClusterType", "VpcId" ] }, { "name": "CreateConfig", "description": "创建配置项", "status": "online", "parameters": [ { "name": "ConfigName", "type": "string", "required": true, "description": "配置项名称，最多支持60个字符，只能包含字母、数字及分隔符（“-”、“_”），且不能以分隔符开头或结尾。", "example": "config_app" }, { "name": "ConfigVersion", "type": "string", "required": true, "description": "配置项版本，只能包含小写字母、数字及分隔符(\"-\"，\".\")，且必须以小写字母或数字开头、以小写字母或数字结尾，中间不能有连续的\"-\"或\".\"。", "example": "v1" }, { "name": "ConfigValue", "type": "string", "required": true, "description": "配置项值。", "example": "config: enabled" }, { "name": "ApplicationId", "type": "string", "required": true, "description": "应用ID。该参数可以通过调用 [DescribeApplications](https://cloud.tencent.com/document/product/649/36090) 的返回值中的 ApplicationId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/app)查看；也可以调用[CreateApplication](https://cloud.tencent.com/document/product/649/36094)创建新的应用。", "example": "application-5yr26r9a" }, { "name": "ConfigVersionDesc", "type": "string", "required": false, "description": "配置项版本描述，最多支持200个字符。", "example": "This is desc" }, { "name": "ConfigType", "type": "string", "required": false, "description": "配置项值类型，固定值。", "example": "application" }, { "name": "EncodeWithBase64", "type": "boolean", "required": false, "description": "Base64编码的配置项。 - true：开启 - false：关闭", "example": "true" }, { "name": "ProgramIdList", "type": "array", "required": false, "description": "需要绑定的数据集ID。该参数可以通过调用 [DescribePrograms](https://cloud.tencent.com/document/product/649/73477) 的返回值中的 ProgramId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/privilege?tab=program\u0026roleId=role-yrle4doy)查看；也可以调用[CreateProgram](https://cloud.tencent.com/document/product/649/108544)创建新的数据集。", "example": "[\"program-6a79x94v\"]", "item_type": "string" } ], "required": [ "ConfigName", "ConfigVersion", "ConfigValue", "ApplicationId" ] }, { "name": "CreateConfigTemplate", "description": "创建参数模板", "status": "online", "parameters": [ { "name": "ConfigTemplateName", "type": "string", "required": true, "description": "配置模板名称，最多支持60个字符，只能包含字母、数字及分隔符（“-”），且不能以分隔符开头或结尾。", "example": "config_temp_app" }, { "name": "ConfigTemplateType", "type": "string", "required": true, "description": "配置模板对应的微服务框架。 - Ribbon：Ribbon类型配置模板 - Hystrix：Hystrix类型配置模板 - Zuul：Zuul类型配置模板 - customize：自定义类型配置模板", "example": "Ribbon" }, { "name": "ConfigTemplateValue", "type": "string", "required": true, "description": "配置模板数据。", "example": "ribbon.ReadTimeout: 5000" }, { "name": "ConfigTemplateDesc", "type": "string", "required": false, "description": "配置模板描述，最多支持200个字符。", "example": "This is desc" }, { "name": "ProgramIdList", "type": "array", "required": false, "description": "需要绑定的数据集ID。该参数可以通过调用 [DescribePrograms](https://cloud.tencent.com/document/product/649/73477) 的返回值中的 ProgramId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/privilege?tab=program\u0026roleId=role-yrle4doy)查看；也可以调用[CreateProgram](https://cloud.tencent.com/document/product/649/108544)创建新的数据集。", "example": "[\"program-6a79x94v\"]", "item_type": "string" } ], "required": [ "ConfigTemplateName", "ConfigTemplateType", "ConfigTemplateValue" ] }, { "name": "CreateConfigTemplateWithDetailResp", "description": "创建参数模板，并返回模板详细信息", "status": "online", "parameters": [ { "name": "ConfigTemplateName", "type": "string", "required": true, "description": "配置模板名称，最多支持60个字符，只能包含字母、数字及分隔符（“-”），且不能以分隔符开头或结尾。", "example": "config_app" }, { "name": "ConfigTemplateType", "type": "string", "required": true, "description": "配置模板对应的微服务框架。- Ribbon：Ribbon类型配置模板- Hystrix：Hystrix类型配置模板- Zuul：Zuul类型配置模板- customize：自定义类型配置模板。", "example": "Ribbon" }, { "name": "ConfigTemplateValue", "type": "string", "required": true, "description": "配置模板数据。", "example": "#请求处理超时时间ribbon.ReadTimeout: 5000#请求连接超时时间ribbon.ConnectTimeout: 2000#同一实例最大重试次数，不包括首次调用ribbon.MaxAutoRetries: 0" }, { "name": "ConfigTemplateDesc", "type": "string", "required": false, "description": "配置模板描述，最多支持200个字符。", "example": "This is desc" }, { "name": "ProgramIdList", "type": "array", "required": false, "description": "需要绑定的数据集ID。该参数可以通过调用 [DescribePrograms](https://cloud.tencent.com/document/product/649/73477) 的返回值中的 ProgramId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/privilege?tab=program\u0026roleId=role-yrle4doy)查看；也可以调用[CreateProgram](https://cloud.tencent.com/document/product/649/108544)创建新的数据集。", "example": "[\"program-6a79x94v\"]", "item_type": "string" } ], "required": [ "ConfigTemplateName", "ConfigTemplateType", "ConfigTemplateValue" ] }, { "name": "CreateConfigWithDetailResp", "description": "创建配置项，返回详细信息", "status": "online", "parameters": [ { "name": "ConfigName", "type": "string", "required": true, "description": "配置项名称，最多支持60个字符，只能包含字母、数字及分隔符（“-”、“_”），且不能以分隔符开头或结尾。", "example": "app_config" }, { "name": "ConfigVersion", "type": "string", "required": true, "description": "配置项版本，只能包含小写字母、数字及分隔符(\"-\"，\".\")，且必须以小写字母或数字开头、以小写字母或数字结尾，中间不能有连续的\"-\"或\".\"。", "example": "v1.0" }, { "name": "ConfigValue", "type": "string", "required": true, "description": "配置项值。", "example": "api.invok.limit: 5000" }, { "name": "ApplicationId", "type": "string", "required": true, "description": "应用ID。该参数可以通过调用 [DescribeApplications](https://cloud.tencent.com/document/product/649/36090) 的返回值中的 ApplicationId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/app)查看；也可以调用[CreateApplication](https://cloud.tencent.com/document/product/649/36094)创建新的应用。", "example": "application-gyq2xry5" }, { "name": "ConfigVersionDesc", "type": "string", "required": false, "description": "配置项版本描述，最多支持200个字符。", "example": "This is desc" }, { "name": "ConfigType", "type": "string", "required": false, "description": "配置项值类型，固定值。", "example": "application" }, { "name": "EncodeWithBase64", "type": "boolean", "required": false, "description": "Base64编码的配置项。 - true：开启 - false：关闭", "example": "true" }, { "name": "ProgramIdList", "type": "array", "required": false, "description": "需要绑定的数据集ID。该参数可以通过调用 [DescribePrograms](https://cloud.tencent.com/document/product/649/73477) 的返回值中的 ProgramId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/privilege?tab=program\u0026roleId=role-yrle4doy)查看；也可以调用[CreateProgram](https://cloud.tencent.com/document/product/649/108544)创建新的数据集。", "example": "[\"program-6a79x94v\"]", "item_type": "string" } ], "required": [ "ConfigName", "ConfigVersion", "ConfigValue", "ApplicationId" ] }, { "name": "CreateContainGroup", "description": "（已废弃，请使用 CreateGroup 和 DeployContainerGroup 创建和部署容器部署组）创建容器部署组", "status": "online", "parameters": [ { "name": "ApplicationId", "type": "string", "required": true, "description": "分组所属【应用ID】，可通过调用[DescribeApplications](https://cloud.tencent.com/document/product/649/36090)查询已创建的应用列表或登录[控制台](https://console.cloud.tencent.com/tsf/app?rid=1)进行查看；也可以调用[CreateApplication](https://cloud.tencent.com/document/product/649/36094)创建新的应用。", "example": "application-6a79x94v" }, { "name": "NamespaceId", "type": "string", "required": true, "description": "分组所属【命名空间ID】，可通过调用[DescribeSimpleNamespaces](https://cloud.tencent.com/document/product/649/36096)查询已创建的命名空间列表或登录[控制台](https://console.cloud.tencent.com/tsf/resource?rid=1\u0026tab=namespace)进行查看；也可以调用[CreateNamespace](https://cloud.tencent.com/document/product/649/36098)创建新的命名空间。", "example": "namespace-6a79x94v" }, { "name": "GroupName", "type": "string", "required": true, "description": "分组名称字段，长度1~60，字母或下划线开头，可包含字母数字下划线", "example": "consumer" }, { "name": "InstanceNum", "type": "integer", "required": true, "description": "实例数量", "example": "2" }, { "name": "AccessType", "type": "integer", "required": true, "description": "0:公网 1:集群内访问 2：NodePort", "example": "2" }, { "name": "ProtocolPorts", "type": "array", "required": true, "description": "数组对象，见下方定义", "example": "无", "item_type": "object", "children": [ { "name": "Protocol", "type": "string", "required": true, "description": "TCP UDP", "example": "TCP" }, { "name": "Port", "type": "integer", "required": true, "description": "服务端口", "example": "8080" }, { "name": "TargetPort", "type": "integer", "required": true, "description": "容器端口", "example": "8080" }, { "name": "NodePort", "type": "integer", "required": false, "description": "主机端口", "example": "30090" }, { "name": "Name", "type": "string", "required": false, "description": "端口名称", "example": "port-0" } ] }, { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cls-6a79x94v" }, { "name": "CpuLimit", "type": "string", "required": false, "description": "最大分配 CPU 核数，对应 K8S limit", "example": "0.2" }, { "name": "MemLimit", "type": "string", "required": false, "description": "最大分配内存 MiB 数，对应 K8S limit", "example": "512" }, { "name": "GroupComment", "type": "string", "required": false, "description": "分组备注字段，长度应不大于200字符", "example": "部署组备注信息" }, { "name": "UpdateType", "type": "integer", "required": false, "description": "更新方式：0:快速更新 1:滚动更新", "example": "1" }, { "name": "UpdateIvl", "type": "integer", "required": false, "description": "滚动更新必填，更新间隔", "example": "30" }, { "name": "CpuRequest", "type": "string", "required": false, "description": "初始分配的 CPU 核数，对应 K8S request", "example": "0.25" }, { "name": "MemRequest", "type": "string", "required": false, "description": "初始分配的内存 MiB 数，对应 K8S request", "example": "128" }, { "name": "GroupResourceType", "type": "string", "required": false, "description": "部署组资源类型；DEF 表示默认资源类型", "example": "\"DEF\": 使用时需要去掉双引号" }, { "name": "SubnetId", "type": "string", "required": false, "description": "分组所属【子网ID】，可前往私有网络[控制台](https://console.cloud.tencent.com/vpc/subnet?rid=1\u0026unVpcId=vpc-6bs8ytjd)进行获取", "example": "subnet-6a79x94v" }, { "name": "AgentCpuRequest", "type": "string", "required": false, "description": "agent 容器分配的 CPU 核数，对应 K8S 的 request", "example": "0.1" }, { "name": "AgentCpuLimit", "type": "string", "required": false, "description": "agent 容器最大的 CPU 核数，对应 K8S 的 limit", "example": "0.2" }, { "name": "AgentMemRequest", "type": "string", "required": false, "description": "agent 容器分配的内存 MiB 数，对应 K8S 的 request", "example": "32" }, { "name": "AgentMemLimit", "type": "string", "required": false, "description": "agent 容器最大的内存 MiB 数，对应 K8S 的 limit", "example": "128" }, { "name": "IstioCpuRequest", "type": "string", "required": false, "description": "istioproxy 容器分配的 CPU 核数，对应 K8S 的 request", "example": "0.1" }, { "name": "IstioCpuLimit", "type": "string", "required": false, "description": "istioproxy 容器最大的 CPU 核数，对应 K8S 的 limit", "example": "0.2" }, { "name": "IstioMemRequest", "type": "string", "required": false, "description": "istioproxy 容器分配的内存 MiB 数，对应 K8S 的 request", "example": "32" }, { "name": "IstioMemLimit", "type": "string", "required": false, "description": "istioproxy 容器最大的内存 MiB 数，对应 K8S 的 limit", "example": "128" } ], "required": [ "ApplicationId", "NamespaceId", "GroupName", "InstanceNum", "AccessType", "ProtocolPorts", "ClusterId" ] }, { "name": "CreateFileConfig", "description": "创建文件配置项", "status": "online", "parameters": [ { "name": "ConfigName", "type": "string", "required": true, "description": "配置项名称，最多支持60个字符，只能包含字母、数字及分隔符（“-”、“_”），且不能以分隔符开头或结尾。", "example": "config_app" }, { "name": "ConfigVersion", "type": "string", "required": true, "description": "配置项版本，只能包含小写字母、数字及分隔符(\"-\"，\".\")，且必须以小写字母或数字开头、以小写字母或数字结尾，中间不能有连续的\"-\"或\".\"。", "example": "v1" }, { "name": "ConfigFileName", "type": "string", "required": true, "description": "配置项文件名，最多支持60个字符，只能包含英文、数字、\"-\"（英文）、\"_\"（英文）、\".\"（英文）。", "example": "conf.txt" }, { "name": "ConfigFileValue", "type": "string", "required": true, "description": "配置项文件内容（原始内容编码需要 utf-8 格式，如果 ConfigFileCode 为 gbk，后台会进行转换）", "example": "config=enabled" }, { "name": "ApplicationId", "type": "string", "required": true, "description": "配置项关联应用ID，该参数可以通过调用 [DescribeApplications](https://cloud.tencent.com/document/product/649/36090) 的返回值中的 ApplicationId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/app)查看；也可以调用[CreateApplication](https://cloud.tencent.com/document/product/649/36094)创建新的应用。", "example": "application-5yr26r9a" }, { "name": "ConfigFilePath", "type": "string", "required": true, "description": "发布路径。", "example": "/root" }, { "name": "ConfigVersionDesc", "type": "string", "required": false, "description": "配置项版本描述，最多支持200个字符。", "example": "This is desc" }, { "name": "ConfigFileCode", "type": "string", "required": false, "description": "配置项文件编码，utf-8 或 gbk。注：如果选择 gbk，需要新版本 tsf-consul-template （公有云虚拟机需要使用 1.32 tsf-agent，容器需要从文档中获取最新的 tsf-consul-template-docker.tar.gz）的支持。", "example": "utf-8" }, { "name": "ConfigPostCmd", "type": "string", "required": false, "description": "后置命令。", "example": "sh start.sh" }, { "name": "EncodeWithBase64", "type": "boolean", "required": false, "description": "Base64编码的配置项。 - true：开启 - false：关闭", "example": "true" }, { "name": "ProgramIdList", "type": "array", "required": false, "description": "需要绑定的数据集ID。该参数可以通过调用 [DescribePrograms](https://cloud.tencent.com/document/product/649/73477) 的返回值中的 ProgramId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/privilege?tab=program\u0026roleId=role-yrle4doy)查看；也可以调用[CreateProgram](https://cloud.tencent.com/document/product/649/108544)创建新的数据集。", "example": "[\"program-6a79x94v\"]", "item_type": "string" } ], "required": [ "ConfigName", "ConfigVersion", "ConfigFileName", "ConfigFileValue", "ApplicationId", "ConfigFilePath" ] }, { "name": "CreateFileConfigWithDetailResp", "description": "创建文件配置项，返回详细信息。", "status": "online", "parameters": [ { "name": "ConfigName", "type": "string", "required": true, "description": "配置名称，最多支持60个字符，只能包含字母、数字及分隔符（“-”、“_”），且不能以分隔符开头或结尾。", "example": "consumer-config" }, { "name": "ConfigVersion", "type": "string", "required": true, "description": "配置项版本，只能包含小写字母、数字及分隔符(\"-\"，\".\")，且必须以小写字母或数字开头、以小写字母或数字结尾，中间不能有连续的\"-\"或\".\"。", "example": "v1" }, { "name": "ConfigFileName", "type": "string", "required": true, "description": "配置项文件名，不超过60个字符，只能包含英文、数字、\"-\"（英文）、\"_\"（英文）、\".\"（英文）。", "example": "config.txt" }, { "name": "ConfigFileValue", "type": "string", "required": true, "description": "配置项文件内容（原始内容编码需要 utf-8 格式，如果 ConfigFileCode 为 gbk，后台会进行转换）。", "example": "config=enabled" }, { "name": "ApplicationId", "type": "string", "required": true, "description": "配置项关联应用ID。该参数可以通过调用 [DescribeApplications](https://cloud.tencent.com/document/product/649/36090) 的返回值中的 ApplicationId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/app)查看；也可以调用[CreateApplication](https://cloud.tencent.com/document/product/649/36094)创建新的应用。", "example": "application-dapbkdgy" }, { "name": "ConfigFilePath", "type": "string", "required": true, "description": "发布路径。", "example": "/root" }, { "name": "ConfigVersionDesc", "type": "string", "required": false, "description": "配置项版本描述，最多支持200个字符。", "example": "This is desc" }, { "name": "ConfigFileCode", "type": "string", "required": false, "description": "配置项文件编码，utf-8 或 gbk。注：如果选择 gbk，需要新版本 tsf-consul-template （公有云虚拟机需要使用 1.32 tsf-agent，容器需要从文档中获取最新的 tsf-consul-template-docker.tar.gz）的支持。", "example": "utf-8" }, { "name": "ConfigPostCmd", "type": "string", "required": false, "description": "后置命令。", "example": "/usr/bin/bash" }, { "name": "EncodeWithBase64", "type": "boolean", "required": false, "description": "Base64编码的配置项", "example": "true" }, { "name": "ProgramIdList", "type": "array", "required": false, "description": "需要绑定的数据集ID。该参数可以通过调用 [DescribePrograms](https://cloud.tencent.com/document/product/649/73477) 的返回值中的 ProgramId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/privilege?tab=program\u0026roleId=role-yrle4doy)查看；也可以调用[CreateProgram](https://cloud.tencent.com/document/product/649/108544)创建新的数据集。", "example": "[\"program-6a79x94v\"]", "item_type": "string" } ], "required": [ "ConfigName", "ConfigVersion", "ConfigFileName", "ConfigFileValue", "ApplicationId", "ConfigFilePath" ] }, { "name": "CreateGatewayApi", "description": "批量导入API至api分组(也支持新建API到分组)", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "API 分组ID", "example": "grp-djvzrdih" }, { "name": "ApiList", "type": "array", "required": true, "description": "Api信息", "example": "无", "item_type": "object", "children": [ { "name": "NamespaceId", "type": "string", "required": true, "description": "命名空间Id，若为外部API,为固定值：\"namespace-external\"", "example": "namespace-96a79v5b" }, { "name": "MicroserviceId", "type": "string", "required": true, "description": "服务Id，若为外部API,为固定值：\"ms-external\"", "example": "ms-by8o5kgv" }, { "name": "Path", "type": "string", "required": true, "description": "API path", "example": "/echo" }, { "name": "Method", "type": "string", "required": true, "description": "Api 请求", "example": "GET" }, { "name": "PathMapping", "type": "string", "required": true, "description": "请求映射", "example": "/echo" }, { "name": "Host", "type": "string", "required": false, "description": "api所在服务host,限定外部Api填写。格式: `http://127.0.0.1:8080`", "example": "www.qq.com" }, { "name": "Description", "type": "string", "required": false, "description": "api描述信息", "example": "This is desc" } ] }, { "name": "ProgramIdList", "type": "array", "required": false, "description": "无", "example": "[\"program-6a79x94v\"]", "item_type": "string" } ], "required": [ "GroupId", "ApiList" ] }, { "name": "CreateGroup", "description": "创建虚拟机部署组", "status": "online", "parameters": [ { "name": "ApplicationId", "type": "string", "required": true, "description": "部署组所属的【应用ID】，可通过调用[DescribeApplications](https://cloud.tencent.com/document/product/649/36090)查询已创建的应用列表或登录[控制台](https://console.cloud.tencent.com/tsf/app?rid=1)进行查看；也可以调用[CreateApplication](https://cloud.tencent.com/document/product/649/36094)创建新的应用。", "example": "application-6a79x94v" }, { "name": "NamespaceId", "type": "string", "required": true, "description": "部署组所属【命名空间ID】，可通过调用[DescribeSimpleNamespaces](https://cloud.tencent.com/document/product/649/36096)查询已创建的命名空间列表或登录[控制台](https://console.cloud.tencent.com/tsf/resource?rid=1\u0026tab=namespace)进行查看；也可以调用[CreateNamespace](https://cloud.tencent.com/document/product/649/36098)创建新的命名空间。", "example": "namespace-6a79x94v" }, { "name": "GroupName", "type": "string", "required": true, "description": "部署组名称", "example": "demo" }, { "name": "ClusterId", "type": "string", "required": true, "description": "部署组所属的【集群ID】，可通过调用[DescribeClusters](https://cloud.tencent.com/document/product/649/85857)查询已创建的集群列表或登录[控制台](https://console.cloud.tencent.com/tsf/resource?rid=1\u0026tab=docker)进行查看；也可以调用[CreateCluster](https://cloud.tencent.com/document/product/649/36049)创建新的集群。", "example": "cluster-6a79x94v" }, { "name": "GroupDesc", "type": "string", "required": false, "description": "部署组描述", "example": "This is desc" }, { "name": "GroupResourceType", "type": "string", "required": false, "description": "部署组资源类型；DEF 表示默认资源类型", "example": "\"DEF\": 使用时需要去掉双引号" }, { "name": "Alias", "type": "string", "required": false, "description": "部署组备注", "example": "备注" }, { "name": "Tags", "type": "array", "required": false, "description": "标签列表", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "标签键", "example": "name" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值", "example": "tsf" } ] }, { "name": "K8sNamespaceName", "type": "string", "required": false, "description": "k8s命名空间名称", "example": "default" } ], "required": [ "ApplicationId", "NamespaceId", "GroupName", "ClusterId" ] }, { "name": "CreateLane", "description": "创建泳道配置", "status": "online", "parameters": [ { "name": "LaneName", "type": "string", "required": true, "description": "泳道配置名称，最多支持60个字符，只能包含字母、数字及分隔符（“-”），且不能以分隔符开头或结尾。", "example": "app_lane" }, { "name": "Remark", "type": "string", "required": true, "description": "泳道配置备注，最多支持200个字符。", "example": "This is desc" }, { "name": "LaneGroupList", "type": "array", "required": true, "description": "泳道部署组信息。", "example": "无", "item_type": "object", "children": [ { "name": "GroupId", "type": "string", "required": true, "description": "部署组ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "group-py5436a4" }, { "name": "Entrance", "type": "boolean", "required": true, "description": "是否入口应用 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "LaneGroupId", "type": "string", "required": false, "description": "泳道部署组ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "lane-g-a7or5ebv" }, { "name": "LaneId", "type": "string", "required": false, "description": "泳道ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "lane-y9647wgy" }, { "name": "GroupName", "type": "string", "required": false, "description": "部署组名 注意：此字段可能返回 null，表示取不到有效值。", "example": "group_app" }, { "name": "ApplicationId", "type": "string", "required": false, "description": "应用ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "application-byxz6gal" }, { "name": "ApplicationName", "type": "string", "required": false, "description": "应用名 注意：此字段可能返回 null，表示取不到有效值。", "example": "app_provider" }, { "name": "NamespaceId", "type": "string", "required": false, "description": "命名空间ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "namespace-6ymbn3vg" }, { "name": "NamespaceName", "type": "string", "required": false, "description": "命名空间名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "ns_app" }, { "name": "CreateTime", "type": "integer", "required": false, "description": "创建时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "1732784732000" }, { "name": "UpdateTime", "type": "integer", "required": false, "description": "更新时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "1732784732000" }, { "name": "ClusterType", "type": "string", "required": false, "description": "集群类型 注意：此字段可能返回 null，表示取不到有效值。", "example": "V" } ] }, { "name": "ProgramIdList", "type": "array", "required": false, "description": "需要绑定的数据集ID。该参数可以通过调用 [DescribePrograms](https://cloud.tencent.com/document/product/649/73477) 的返回值中的 ProgramId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/privilege?tab=program\u0026roleId=role-yrle4doy)查看；也可以调用[CreateProgram](https://cloud.tencent.com/document/product/649/108544)创建新的数据集。", "example": "[\"program-6a79x94v\"]", "item_type": "string" } ], "required": [ "LaneName", "Remark", "LaneGroupList" ] }, { "name": "CreateLaneRule", "description": "创建灰度发布规则", "status": "online", "parameters": [ { "name": "RuleName", "type": "string", "required": true, "description": "灰度发布规则名称，最多支持60个字符，支持中英文字符。", "example": "app_rule" }, { "name": "Remark", "type": "string", "required": true, "description": "灰度发布规则备注，最多支持200个字符。", "example": "This is desc" }, { "name": "RuleTagList", "type": "array", "required": true, "description": "灰度发布规则标签列表。", "example": "无", "item_type": "object", "children": [ { "name": "TagId", "type": "string", "required": false, "description": "标签ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "lane-t-nalb72vq" }, { "name": "TagName", "type": "string", "required": false, "description": "标签名 注意：此字段可能返回 null，表示取不到有效值。", "example": "user" }, { "name": "TagOperator", "type": "string", "required": false, "description": "标签操作符 注意：此字段可能返回 null，表示取不到有效值。", "example": "EQUAL" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "LaneRuleId", "type": "string", "required": false, "description": "泳道规则ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "lane-r-by8n9xyk" }, { "name": "CreateTime", "type": "integer", "required": false, "description": "创建时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "1732784732000" }, { "name": "UpdateTime", "type": "integer", "required": false, "description": "更新时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "1732784732000" } ] }, { "name": "RuleTagRelationship", "type": "string", "required": true, "description": "灰度发布规则标签关系。 - RELEATION_AND：与 - RELEATION_OR：或", "example": "RELEATION_AND" }, { "name": "LaneId", "type": "string", "required": true, "description": "泳道配置ID。该参数可以通过调用 [DescribeLanes](https://cloud.tencent.com/document/product/649/44504) 的返回值中的 LaneId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?tab=grayscale\u0026subTab=lane)查看；也可以调用[CreateLane](https://cloud.tencent.com/document/product/649/44508)创建新的泳道配置。", "example": "lane-y9o6w958" }, { "name": "ProgramIdList", "type": "array", "required": false, "description": "需要绑定的数据集ID。该参数可以通过调用 [DescribePrograms](https://cloud.tencent.com/document/product/649/73477) 的返回值中的 ProgramId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/privilege?tab=program\u0026roleId=role-yrle4doy)查看；也可以调用[CreateProgram](https://cloud.tencent.com/document/product/649/108544)创建新的数据集。", "example": "[\"program-6a79x94v\"]", "item_type": "string" } ], "required": [ "RuleName", "Remark", "RuleTagList", "RuleTagRelationship", "LaneId" ] }, { "name": "CreateMicroservice", "description": "新增微服务", "status": "online", "parameters": [ { "name": "NamespaceId", "type": "string", "required": true, "description": "命名空间ID。该参数可以通过调用 [DescribeSimpleNamespaces](https://cloud.tencent.com/document/api/649/36096) 的返回值中的 NamespaceId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/resource?tab=namespace)查看；也可以调用[CreateNamespace](https://cloud.tencent.com/document/product/649/36098)创建新的命名空间。", "example": "namespace-v3gw3lna" }, { "name": "MicroserviceName", "type": "string", "required": true, "description": "微服务名称。该参数可以通过调用 [DescribeMicroservices](https://cloud.tencent.com/document/product/649/36084) 的返回值中的 MicroserviceName 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?tab=service)查看；也可以调用[CreateMicroserviceWithDetailResp](https://cloud.tencent.com/document/product/649/85860)创建新的微服务。", "example": "provider-app" }, { "name": "MicroserviceDesc", "type": "string", "required": false, "description": "微服务备注信息，最多支持200个字符。", "example": "This is desc" } ], "required": [ "NamespaceId", "MicroserviceName" ] }, { "name": "CreateMicroserviceWithDetailResp", "description": "新增微服务返回ID", "status": "online", "parameters": [ { "name": "NamespaceId", "type": "string", "required": true, "description": "命名空间ID。该参数可以通过调用 [DescribeSimpleNamespaces](https://cloud.tencent.com/document/api/649/36096) 的返回值中的 NamespaceId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/resource?tab=namespace)查看；也可以调用[CreateNamespace](https://cloud.tencent.com/document/product/649/36098)创建新的命名空间。", "example": "namespace-vw8oox6v" }, { "name": "MicroserviceName", "type": "string", "required": true, "description": "微服务名称，最多支持128个字符。", "example": "provider-demo" }, { "name": "MicroserviceDesc", "type": "string", "required": false, "description": "微服务描述信息，最多支持200个字符。", "example": "[\"program-6a79x94v\"]" } ], "required": [ "NamespaceId", "MicroserviceName" ] }, { "name": "CreateNamespace", "description": "创建命名空间", "status": "online", "parameters": [ { "name": "NamespaceName", "type": "string", "required": true, "description": "命名空间名称", "example": "tsf" }, { "name": "ClusterId", "type": "string", "required": false, "description": "集群ID，按照【集群ID】进行过滤，可通过调用[DescribeClusters](https://cloud.tencent.com/document/product/649/85857)查询已创建的集群列表或登录控制台进行查看；也可以调用[CreateCluster](https://cloud.tencent.com/document/product/649/36049)创建新的集群。仅在集群下无部署组、命名空间、云主机时可以删除。", "example": "cluster-6a79x94v" }, { "name": "NamespaceDesc", "type": "string", "required": false, "description": "命名空间描述", "example": "这是一段命名空间描述信息" }, { "name": "NamespaceResourceType", "type": "string", "required": false, "description": "命名空间资源类型；DEF：表示默认资源类型；GW：表示网关资源类型", "example": "\"DEF\": 使用时需要去掉双引号" }, { "name": "NamespaceType", "type": "string", "required": false, "description": "命名空间类型；DEF 表示默认普通命名空间；GLOBAL 表示全局命名空间", "example": "\"DEF\": 使用时需要去掉双引号" }, { "name": "NamespaceId", "type": "string", "required": false, "description": "命名空间ID，按照【命名空间ID】进行过滤，可通过调用[DescribeNamespaces](https://cloud.tencent.com/document/product/649/36096)查询已创建的命名空间列表或登录控制台进行查看；也可以调用[CreateNamespace](https://cloud.tencent.com/document/product/649/36098)创建新命名空间。", "example": "namespace-6a79x94v" }, { "name": "IsHaEnable", "type": "string", "required": false, "description": "是否开启高可用，1 表示开启，0 表示不开启", "example": "1" }, { "name": "ProgramId", "type": "string", "required": false, "description": "需要绑定的数据集ID，可通过调用[DescribePrograms](https://cloud.tencent.com/document/api/649/73477)查询已创建的数据集列表或登录控制台进行查看；也可以调用[CreateProgram](https://cloud.tencent.com/document/api/649/108544)创建新的数据集。", "example": "program-6a79x94v" }, { "name": "ProgramIdList", "type": "array", "required": false, "description": "需要绑定的数据集ID列表，可通过调用[DescribePrograms](https://cloud.tencent.com/document/api/649/73477)查询已创建的数据集列表或登录控制台进行查看；也可以调用[CreateProgram](https://cloud.tencent.com/document/api/649/108544)创建新的数据集。", "example": "[\"program-6a79x94v\"]", "item_type": "string" }, { "name": "CreateK8sNamespaceFlag", "type": "boolean", "required": false, "description": "是否创建k8s命名空间标识", "example": "true" } ], "required": [ "NamespaceName" ] }, { "name": "CreatePathRewrites", "description": "创建路径重写", "status": "online", "parameters": [ { "name": "PathRewrites", "type": "object", "required": true, "description": "路径重写列表", "example": "[{\"GatewayGroupId\":\"group-yo476mrv\",\"Regex\":\"/user\",\"Replacement\":\"/provider\",\"Blocked\":\"N\",\"Order\":1}]", "children": [ { "name": "GatewayGroupId", "type": "string", "required": true, "description": "网关部署组ID", "example": "group-ldap5yok" }, { "name": "Regex", "type": "string", "required": true, "description": "正则表达式", "example": "/consumer" }, { "name": "Replacement", "type": "string", "required": true, "description": "替换的内容", "example": "/provider" }, { "name": "Blocked", "type": "string", "required": true, "description": "是否屏蔽映射后路径，Y: 是 N: 否", "example": "N" }, { "name": "Order", "type": "integer", "required": true, "description": "规则顺序，越小优先级越高", "example": "1" } ] } ], "required": [ "PathRewrites" ] }, { "name": "CreatePathRewritesWithDetailResp", "description": "创建路径重写，并返回路径重写规则信息", "status": "online", "parameters": [ { "name": "PathRewrites", "type": "array", "required": true, "description": "路径重写列表", "example": "[{\"GatewayGroupId\":\"group-ldap5yok\",\"Regex\":\"/consumer\",\"Replacement\":\"/provider\",\"Blocked\":\"N\",\"Order\":1}]", "item_type": "object", "children": [ { "name": "GatewayGroupId", "type": "string", "required": true, "description": "网关部署组ID", "example": "group-ldap5yok" }, { "name": "Regex", "type": "string", "required": true, "description": "正则表达式", "example": "/consumer" }, { "name": "Replacement", "type": "string", "required": true, "description": "替换的内容", "example": "/provider" }, { "name": "Blocked", "type": "string", "required": true, "description": "是否屏蔽映射后路径，Y: 是 N: 否", "example": "N" }, { "name": "Order", "type": "integer", "required": true, "description": "规则顺序，越小优先级越高", "example": "1" } ] } ], "required": [ "PathRewrites" ] }, { "name": "CreateProgram", "description": "创建数据集", "status": "online", "parameters": [ { "name": "ProgramName", "type": "string", "required": true, "description": "数据集名称", "example": "TSF-MOCK-PROGRAM" }, { "name": "ProgramDesc", "type": "string", "required": false, "description": "数据集描述", "example": "这是一段数据集描述" }, { "name": "ProgramItemList", "type": "array", "required": false, "description": "数据项列表，传入null或空数组时不新增", "example": "无", "item_type": "object", "children": [ { "name": "ProgramItemId", "type": "string", "required": false, "description": "数据项ID，调用[DescribePrograms](https://console.cloud.tencent.com/tsf/privilege?rid=1\u0026tab=program)接口查询已创建的数据集或登陆控制台进行查看；也可以通过调用[CreateProgram](https://cloud.tencent.com/document/api/649/108544)创建新的数据集。", "example": "prog-item-6a79x94v" }, { "name": "Resource", "type": "object", "required": false, "description": "资源", "example": "无", "children": [ { "name": "ResourceId", "type": "string", "required": false, "description": "资源ID，调用[DescribeResources](https://console.cloud.tencent.com/tsf/privilege-program-create?rid=1)接口，查看接口返回的ResourceId", "example": "resource-6a79x94v" }, { "name": "ResourceCode", "type": "string", "required": false, "description": "资源编码，枚举值描述【cluster（集群）、namespace（命名空间）、config（应用配置）】", "example": "FindOne" }, { "name": "ResourceName", "type": "string", "required": false, "description": "资源名称", "example": "FindOne" }, { "name": "ServiceCode", "type": "string", "required": false, "description": "资源所属产品编码，枚举值描述【tsf】", "example": "tsf" }, { "name": "ResourceAction", "type": "string", "required": false, "description": "选取资源使用的Action，枚举值描述【DescribeSimpleCluster（查询简单集群列表）、DescribeTaskRecords（查询任务列表）】", "example": "FindOne" }, { "name": "IdField", "type": "string", "required": false, "description": "资源数据查询的ID字段名，调用[DescribeResources](https://console.cloud.tencent.com/tsf/privilege-program-create?rid=1)接口，查看接口返回的IdField", "example": "ResourceId" }, { "name": "NameField", "type": "string", "required": false, "description": "资源数据查询的名称字段名", "example": "ResourceName" }, { "name": "SelectIdsField", "type": "string", "required": false, "description": "资源数据查询的ID过滤字段名", "example": "Ids" }, { "name": "CreationTime", "type": "integer", "required": false, "description": "创建时间，时间戳格式【Long】", "example": "1279033108" }, { "name": "LastUpdateTime", "type": "integer", "required": false, "description": "最后更新时间，时间戳格式【Long】", "example": "1803792739" }, { "name": "DeleteFlag", "type": "boolean", "required": false, "description": "删除标识", "example": "false" }, { "name": "ResourceDesc", "type": "string", "required": false, "description": "资源描述", "example": "this is a desc" }, { "name": "CanSelectAll", "type": "boolean", "required": false, "description": "是否可以选择全部", "example": "false" }, { "name": "SearchWordField", "type": "string", "required": false, "description": "资源数据查询的模糊查询字段名", "example": "ResourceCode" }, { "name": "Index", "type": "integer", "required": false, "description": "排序，枚举值描述【10、20、77】", "example": "1" } ] }, { "name": "ValueList", "type": "array", "required": false, "description": "数据值列表", "example": "[\"1\"]", "item_type": "string" }, { "name": "IsAll", "type": "boolean", "required": false, "description": "全选标识，true: 全选；false: 非全选", "example": "true" }, { "name": "CreationTime", "type": "integer", "required": false, "description": "创建时间，时间戳格式【Long】", "example": "174594239000" }, { "name": "LastUpdateTime", "type": "integer", "required": false, "description": "最后更新时间，时间戳格式【Long】，单位毫秒", "example": "174594239000" }, { "name": "DeleteFlag", "type": "boolean", "required": false, "description": "删除标识，true: 可删除；false: 不可删除", "example": "false" }, { "name": "ProgramId", "type": "string", "required": false, "description": "数据集ID，调用[DescribePrograms](https://console.cloud.tencent.com/tsf/privilege?rid=1\u0026tab=program)查询接口获取", "example": "[\"program-6a79x94v\"]" } ] } ], "required": [ "ProgramName" ] }, { "name": "CreatePublicConfig", "description": "创建公共配置项", "status": "online", "parameters": [ { "name": "ConfigName", "type": "string", "required": true, "description": "配置名称，最长60个字符，只能包含字母、数字及分隔符（“-”、“_”），且不能以分隔符开头或结尾。", "example": "config_pub_app" }, { "name": "ConfigVersion", "type": "string", "required": true, "description": "配置版本，只能包含小写字母、数字及分隔符(\"-\"，\".\")，且必须以小写字母或数字开头、以小写字母或数字结尾，中间不能有连续的\"-\"或\".\"。", "example": "v1" }, { "name": "ConfigValue", "type": "string", "required": true, "description": "配置项值，总是接收yaml格式的内容。", "example": "config: enabled" }, { "name": "ConfigVersionDesc", "type": "string", "required": false, "description": "配置项版本描述，最多支持200个字符。", "example": "This is desc" }, { "name": "ConfigType", "type": "string", "required": false, "description": "配置项类型，固定值。", "example": "public" }, { "name": "EncodeWithBase64", "type": "boolean", "required": false, "description": "Base64编码的配置项。 - true：开启 - false：关闭", "example": "true" }, { "name": "ProgramIdList", "type": "array", "required": false, "description": "需要绑定的数据集ID。该参数可以通过调用 [DescribePrograms](https://cloud.tencent.com/document/product/649/73477) 的返回值中的 ProgramId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/privilege?tab=program\u0026roleId=role-yrle4doy)查看；也可以调用[CreateProgram](https://cloud.tencent.com/document/product/649/108544)创建新的数据集。", "example": "[\"program-6a79x94v\"]", "item_type": "string" } ], "required": [ "ConfigName", "ConfigVersion", "ConfigValue" ] }, { "name": "CreatePublicConfigWithDetailResp", "description": "创建公共配置项，并返回配置项详细信息。", "status": "online", "parameters": [ { "name": "ConfigName", "type": "string", "required": true, "description": "配置项名称，最多支持60个字符，只能包含字母、数字及分隔符（“-”、“_”），且不能以分隔符开头或结尾。", "example": "app-config" }, { "name": "ConfigVersion", "type": "string", "required": true, "description": "配置项版本，最多支持60个字符，只能包含小写字母、数字及分隔符(\"-\",\".\")，且必须以小写字母或数字开头、以小写字母或数字结尾，中间不能有连续的\"-\"或\".\"。", "example": "v1" }, { "name": "ConfigValue", "type": "string", "required": true, "description": "配置项值，总是接收yaml格式的内容。", "example": "config: enabled" }, { "name": "ConfigVersionDesc", "type": "string", "required": false, "description": "配置项版本描述，最多支持200个字符。", "example": "This is desc" }, { "name": "ConfigType", "type": "string", "required": false, "description": "配置项类型，固定值。", "example": "public" }, { "name": "EncodeWithBase64", "type": "boolean", "required": false, "description": "Base64编码的配置项。 - true：开启 - false：关闭", "example": "true" }, { "name": "ProgramIdList", "type": "array", "required": false, "description": "需要绑定的数据集ID。该参数可以通过调用 [DescribePrograms](https://cloud.tencent.com/document/product/649/73477) 的返回值中的 ProgramId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/privilege?tab=program\u0026roleId=role-yrle4doy)查看；也可以调用[CreateProgram](https://cloud.tencent.com/document/product/649/108544)创建新的数据集。", "example": "[\"program-6a79x94v\"]", "item_type": "string" } ], "required": [ "ConfigName", "ConfigVersion", "ConfigValue" ] }, { "name": "CreateRepository", "description": "创建仓库", "status": "online", "parameters": [ { "name": "RepositoryName", "type": "string", "required": true, "description": "仓库名称", "example": "mockName" }, { "name": "RepositoryType", "type": "string", "required": true, "description": "仓库类型（默认仓库：default，私有仓库：private）", "example": "private" }, { "name": "BucketName", "type": "string", "required": true, "description": "仓库所在桶名称，[存储桶概述和创建](https://cloud.tencent.com/document/product/436/13312)", "example": "tsf_mockBucket" }, { "name": "BucketRegion", "type": "string", "required": true, "description": "仓库所在桶地域，[存储桶概述和创建](https://cloud.tencent.com/document/product/436/13312)", "example": "ap-nanjing" }, { "name": "Directory", "type": "string", "required": false, "description": "目录", "example": "/v1" }, { "name": "RepositoryDesc", "type": "string", "required": false, "description": "仓库描述", "example": "this is a desc" } ], "required": [ "RepositoryName", "RepositoryType", "BucketName", "BucketRegion" ] }, { "name": "CreateTask", "description": "分布式任务调度 TCT 已到达 EOMS 节点，进行产品下线处理。退市公告https://cloud.tencent.com/announce/detail/2053 创建任务", "status": "deprecated", "parameters": [ { "name": "TaskName", "type": "string", "required": true, "description": "任务名称，任务长度64字符", "example": "task-test" }, { "name": "TaskContent", "type": "string", "required": true, "description": "任务内容，长度限制65536个字节", "example": "com.example.task.simpleTask" }, { "name": "ExecuteType", "type": "string", "required": true, "description": "任务执行方式，unicast：随机单节点执行，broadcast：广播执行，shard：分片执行", "example": "unicast" }, { "name": "TaskType", "type": "string", "required": true, "description": "任务类型。当前只支持一种任务类型。枚举值，java：Java类任务", "example": "java" }, { "name": "TimeOut", "type": "integer", "required": true, "description": "任务超时时间，取值大于0，单位：毫秒（ms）", "example": "30000" }, { "name": "GroupId", "type": "string", "required": true, "description": "部署组ID。在[应用管理](https://console.cloud.tencent.com/tsf/app?rid=1)，点击应用ID进入应用部署页查看部署组ID。", "example": "group-6a79x94v" }, { "name": "TaskRule", "type": "object", "required": false, "description": "触发规则", "example": "无", "children": [ { "name": "RuleType", "type": "string", "required": true, "description": "触发规则类型，枚举值。一共3个值，Cron：定时触发，Repeat：周期触发，WorkFlow：工作流触发", "example": "Cron" }, { "name": "Expression", "type": "string", "required": false, "description": "Cron类型规则，cron表达式。", "example": "0 0/1 * * * ?" }, { "name": "RepeatInterval", "type": "integer", "required": false, "description": "时间间隔， 单位毫秒 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" } ] }, { "name": "RetryCount", "type": "integer", "required": false, "description": "重试次数，0 \u003c= RetryCount\u003c= 10", "example": "0" }, { "name": "RetryInterval", "type": "integer", "required": false, "description": "重试间隔， 0 \u003c= RetryInterval \u003c= 600000， 时间单位 ms", "example": "0" }, { "name": "ShardCount", "type": "integer", "required": false, "description": "分片数量，仅当任务执行方式为分片执行时需要设置该值，取值范围2~1000", "example": "0" }, { "name": "ShardArguments", "type": "array", "required": false, "description": "分片参数", "example": "无", "item_type": "object", "children": [ { "name": "ShardKey", "type": "integer", "required": false, "description": "分片参数 KEY，整形, 范围 [1,1000]", "example": "32" }, { "name": "ShardValue", "type": "string", "required": false, "description": "分片参数 VALUE 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" } ] }, { "name": "SuccessOperator", "type": "string", "required": false, "description": "判断任务成功的操作符", "example": "GTE" }, { "name": "SuccessRatio", "type": "string", "required": false, "description": "判断任务成功率的阈值，如100", "example": "100" }, { "name": "AdvanceSettings", "type": "object", "required": false, "description": "高级设置", "example": "无", "children": [ { "name": "SubTaskConcurrency", "type": "integer", "required": false, "description": "子任务单机并发数限制，默认值为2", "example": "2" } ] }, { "name": "TaskArgument", "type": "string", "required": false, "description": "任务参数，长度限制10000个字符", "example": "taskArgumentTest" }, { "name": "ProgramIdList", "type": "array", "required": false, "description": "数据集列表", "example": "[\"program-6a79x94v\"]", "item_type": "string" } ], "required": [ "TaskName", "TaskContent", "ExecuteType", "TaskType", "TimeOut", "GroupId" ] }, { "name": "CreateTaskFlow", "description": "分布式任务调度 TCT 已到达 EOMS 节点，进行产品下线处理。退市公告https://cloud.tencent.com/announce/detail/2053 创建工作流", "status": "deprecated", "parameters": [ { "name": "FlowName", "type": "string", "required": true, "description": "工作流名称", "example": "exec-6g4rq8z6" }, { "name": "TriggerRule", "type": "object", "required": true, "description": "触发方式", "example": "无", "children": [ { "name": "RuleType", "type": "string", "required": true, "description": "触发规则类型，枚举值。一共3个值，Cron：定时触发，Repeat：周期触发，WorkFlow：工作流触发", "example": "Cron" }, { "name": "Expression", "type": "string", "required": false, "description": "Cron类型规则，cron表达式。", "example": "0 0/1 * * * ?" }, { "name": "RepeatInterval", "type": "integer", "required": false, "description": "时间间隔， 单位毫秒 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" } ] }, { "name": "FlowEdges", "type": "array", "required": true, "description": "工作流任务节点列表", "example": "无", "item_type": "object", "children": [ { "name": "NodeId", "type": "string", "required": false, "description": "节点 ID，节点类型为任务时为任务ID，节点类型为逻辑节点\"且\"时为 AND，为逻辑节点\"或\"时为 OR，节点类型为头节点时为字符串\"head\"", "example": "head" }, { "name": "ChildNodeId", "type": "string", "required": false, "description": "子节点 ID，节点类型为任务时为任务ID，节点类型为逻辑节点\"且\"时为 AND，为逻辑节点\"或\"时为 OR", "example": "task-x8orm34b" }, { "name": "CoreNode", "type": "string", "required": false, "description": "是否核心任务,Y/N", "example": "N" }, { "name": "EdgeType", "type": "string", "required": false, "description": "边类型，上下游任务依赖触发关系。一共2个值，Y：成功触发，N：失败触发", "example": "Y" }, { "name": "NodeType", "type": "string", "required": false, "description": "任务节点类型，一共有4种类型，AND：逻辑节点且，OR：逻辑节点或，TASK：任务节点，START：头节点", "example": "START" }, { "name": "PositionX", "type": "string", "required": false, "description": "X轴坐标位置", "example": "12" }, { "name": "PositionY", "type": "string", "required": false, "description": "Y轴坐标位置", "example": "32" }, { "name": "GraphId", "type": "string", "required": false, "description": "图 ID，新建工作流时自动生成，不需要填写，查看工作流图时后端返回", "example": "graph-2p7d984g" }, { "name": "FlowId", "type": "string", "required": false, "description": "工作流 ID，新建工作流时自动生成，不需要填写，查看工作流图时后端返回", "example": "flow-2p7d984g" }, { "name": "NodeName", "type": "string", "required": false, "description": "节点名称", "example": "head" }, { "name": "TaskId", "type": "string", "required": false, "description": "任务ID，新建工作流时不需要填写，查看工作流图时后端返回", "example": "task-x8orm34b" }, { "name": "TaskLogId", "type": "string", "required": false, "description": "任务历史ID，新建工作流时不需要填写，查看工作流图时后端返回", "example": "tlog-x8orm34b" } ] }, { "name": "TimeOut", "type": "integer", "required": true, "description": "工作流执行超时时间，单位：毫秒", "example": "3000" }, { "name": "ProgramIdList", "type": "array", "required": false, "description": "数据集列表", "example": "[\"program-6a79x94v\"]", "item_type": "string" } ], "required": [ "FlowName", "TriggerRule", "FlowEdges", "TimeOut" ] }, { "name": "CreateUnitNamespaces", "description": "批量创建单元化命名空间", "status": "online", "parameters": [ { "name": "GatewayInstanceId", "type": "string", "required": true, "description": "网关实体ID", "example": "gw-ins-01" }, { "name": "UnitNamespaceList", "type": "array", "required": false, "description": "单元化命名空间对象列表", "example": "namespace-01", "item_type": "object", "children": [ { "name": "NamespaceId", "type": "string", "required": true, "description": "命名空间ID", "example": "namespace-evjx6qyb" }, { "name": "NamespaceName", "type": "string", "required": true, "description": "命名空间Name", "example": "ns_app" }, { "name": "Id", "type": "string", "required": false, "description": "单元化命名空间ID", "example": "unit-ns-5boraz9n" }, { "name": "GatewayInstanceId", "type": "string", "required": false, "description": "网关实体ID", "example": "gw-ins-1lvbnrcc" }, { "name": "CreatedTime", "type": "string", "required": false, "description": "创建时间", "example": "2023-10-24 19:24:25" }, { "name": "UpdatedTime", "type": "string", "required": false, "description": "更新时间", "example": "2023-10-24 19:24:25" } ] } ], "required": [ "GatewayInstanceId" ] }, { "name": "CreateUnitRule", "description": "创建单元化规则", "status": "online", "parameters": [ { "name": "GatewayInstanceId", "type": "string", "required": true, "description": "网关实体ID", "example": "gw-ins-szesmg28" }, { "name": "Name", "type": "string", "required": true, "description": "规则名称", "example": "unit_provider" }, { "name": "Description", "type": "string", "required": false, "description": "规则描述", "example": "This is desc" }, { "name": "UnitRuleItemList", "type": "array", "required": false, "description": "规则项列表", "example": "[{\"Relationship\":\"AND\",\"DestNamespaceId\":\"namespace-vk5blxnv\",\"DestNamespaceName\":\"heihuli-global_default\",\"Name\":\"Rule1\",\"Description\":\"this is desc\",\"UnitRuleTagList\":[{\"TagType\":\"U\",\"TagField\":\"user\",\"TagOperator\":\"IN\",\"TagValue\":\"1\"}]}]", "item_type": "object", "children": [ { "name": "Relationship", "type": "string", "required": true, "description": "逻辑关系：AND/OR", "example": "AND" }, { "name": "DestNamespaceId", "type": "string", "required": true, "description": "目的地命名空间ID", "example": "namespace-6ymbkkvg" }, { "name": "DestNamespaceName", "type": "string", "required": true, "description": "目的地命名空间名称", "example": "ns_app" }, { "name": "Name", "type": "string", "required": true, "description": "规则项名称", "example": "unit_rule_app" }, { "name": "Id", "type": "string", "required": false, "description": "规则项ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "unit-item-1h36x2yt" }, { "name": "UnitRuleId", "type": "string", "required": false, "description": "单元化规则ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "unit-rl-8hsa450s" }, { "name": "Priority", "type": "integer", "required": false, "description": "规则顺序，越小优先级越高：默认为0 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "Description", "type": "string", "required": false, "description": "规则描述 注意：此字段可能返回 null，表示取不到有效值。", "example": "This is desc" }, { "name": "UnitRuleTagList", "type": "array", "required": false, "description": "规则标签列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "[{\"Id\":\"unit-tag-vmhijoic\",\"UnitRuleItemId\":\"unit-item-ghpuh9rn\",\"TagType\":\"U\",\"TagField\":\"user\",\"TagOperator\":\"IN\",\"TagValue\":\"1\",\"ItemIndex\":1,\"CreatedTime\":\"2024-12-23 11:14:17\",\"UpdatedTime\":\"2024-12-23 11:14:17\"}]", "item_type": "object", "children": [ { "name": "TagType", "type": "string", "required": true, "description": "标签类型 : U(用户标签)/S(系统标签)", "example": "U" }, { "name": "TagField", "type": "string", "required": true, "description": "标签名", "example": "userId" }, { "name": "TagOperator", "type": "string", "required": true, "description": "操作符:IN/NOT_IN/EQUAL/NOT_EQUAL/REGEX", "example": "EQUAL" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值", "example": "1" }, { "name": "UnitRuleItemId", "type": "string", "required": false, "description": "单元化规则项ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "unit-item-uaji5qpr" }, { "name": "Id", "type": "string", "required": false, "description": "规则ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "unit-tag-6zpb4xrv" } ] }, { "name": "ItemIndex", "type": "integer", "required": false, "description": "规则项索引 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "CreatedTime", "type": "string", "required": false, "description": "创建时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "2024-12-23 11:14:17" }, { "name": "UpdatedTime", "type": "string", "required": false, "description": "修改时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "2024-12-23 11:14:17" } ] } ], "required": [ "GatewayInstanceId", "Name" ] }, { "name": "CreateUnitRuleWithDetailResp", "description": "创建单元化规则, 并返回详细信息", "status": "online", "parameters": [ { "name": "GatewayInstanceId", "type": "string", "required": true, "description": "网关实体ID", "example": "gw-ins-szesmg28" }, { "name": "Name", "type": "string", "required": true, "description": "规则名称", "example": "unit_provider" }, { "name": "Description", "type": "string", "required": false, "description": "规则描述", "example": "This is desc" }, { "name": "UnitRuleItemList", "type": "array", "required": false, "description": "规则项列表", "example": "[{\"Relationship\":\"AND\",\"DestNamespaceId\":\"namespace-vk5blxnv\",\"DestNamespaceName\":\"heihuli-global_default\",\"Name\":\"Rule1\",\"Description\":\"this is desc\",\"UnitRuleTagList\":[{\"TagType\":\"U\",\"TagField\":\"user\",\"TagOperator\":\"IN\",\"TagValue\":\"1\"}]}]", "item_type": "object", "children": [ { "name": "Relationship", "type": "string", "required": true, "description": "逻辑关系：AND/OR", "example": "AND" }, { "name": "DestNamespaceId", "type": "string", "required": true, "description": "目的地命名空间ID", "example": "namespace-6ymbkkvg" }, { "name": "DestNamespaceName", "type": "string", "required": true, "description": "目的地命名空间名称", "example": "ns_app" }, { "name": "Name", "type": "string", "required": true, "description": "规则项名称", "example": "unit_rule_app" }, { "name": "Id", "type": "string", "required": false, "description": "规则项ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "unit-item-1h36x2yt" }, { "name": "UnitRuleId", "type": "string", "required": false, "description": "单元化规则ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "unit-rl-8hsa450s" }, { "name": "Priority", "type": "integer", "required": false, "description": "规则顺序，越小优先级越高：默认为0 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "Description", "type": "string", "required": false, "description": "规则描述 注意：此字段可能返回 null，表示取不到有效值。", "example": "This is desc" }, { "name": "UnitRuleTagList", "type": "array", "required": false, "description": "规则标签列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "[{\"Id\":\"unit-tag-vmhijoic\",\"UnitRuleItemId\":\"unit-item-ghpuh9rn\",\"TagType\":\"U\",\"TagField\":\"user\",\"TagOperator\":\"IN\",\"TagValue\":\"1\",\"ItemIndex\":1,\"CreatedTime\":\"2024-12-23 11:14:17\",\"UpdatedTime\":\"2024-12-23 11:14:17\"}]", "item_type": "object", "children": [ { "name": "TagType", "type": "string", "required": true, "description": "标签类型 : U(用户标签)/S(系统标签)", "example": "U" }, { "name": "TagField", "type": "string", "required": true, "description": "标签名", "example": "userId" }, { "name": "TagOperator", "type": "string", "required": true, "description": "操作符:IN/NOT_IN/EQUAL/NOT_EQUAL/REGEX", "example": "EQUAL" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值", "example": "1" }, { "name": "UnitRuleItemId", "type": "string", "required": false, "description": "单元化规则项ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "unit-item-uaji5qpr" }, { "name": "Id", "type": "string", "required": false, "description": "规则ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "unit-tag-6zpb4xrv" } ] }, { "name": "ItemIndex", "type": "integer", "required": false, "description": "规则项索引 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "CreatedTime", "type": "string", "required": false, "description": "创建时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "2024-12-23 11:14:17" }, { "name": "UpdatedTime", "type": "string", "required": false, "description": "修改时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "2024-12-23 11:14:17" } ] } ], "required": [ "GatewayInstanceId", "Name" ] }, { "name": "DeleteApiGroup", "description": "删除Api分组", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "API 分组ID", "example": "grp-glt0lr13" } ], "required": [ "GroupId" ] }, { "name": "DeleteApiRateLimitRule", "description": "删除API限流规则", "status": "online", "parameters": [ { "name": "RuleId", "type": "string", "required": true, "description": "限流规则ID", "example": "rule-597fkjfv" } ], "required": [ "RuleId" ] }, { "name": "DeleteApplication", "description": "删除应用", "status": "online", "parameters": [ { "name": "ApplicationId", "type": "string", "required": true, "description": "应用ID，可通过调用[DescribeApplications](https://cloud.tencent.com/document/api/649/36090)查询已创建的应用列表或登录控制台进行查看；也可以调用[CreateApplication](https://cloud.tencent.com/document/api/649/36094)创建新的应用。", "example": "application-6a79x94v" }, { "name": "SyncDeleteImageRepository", "type": "boolean", "required": false, "description": "是否删除镜像仓库", "example": "true" } ], "required": [ "ApplicationId" ] }, { "name": "DeleteCluster", "description": "删除集群", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID，按照【集群ID】进行过滤，可通过调用[DescribeClusters](https://cloud.tencent.com/document/product/649/85857)查询已创建的集群列表或登录控制台进行查看；也可以调用[CreateCluster](https://cloud.tencent.com/document/product/649/36049)创建新的集群。仅在集群下无部署组、命名空间、云主机时可以删除。", "example": "cls-6a79x94v" }, { "name": "Unbind", "type": "boolean", "required": false, "description": "是否只解绑，不删除容器集群，默认不传则删除容器集群。", "example": "false" } ], "required": [ "ClusterId" ] }, { "name": "DeleteConfig", "description": "删除配置项", "status": "online", "parameters": [ { "name": "ConfigId", "type": "string", "required": true, "description": "配置ID。该参数可以通过调用 [DescribeConfigs](https://cloud.tencent.com/document/product/649/38340) 的返回值中的 ConfigId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=app)配置详情-配置版本页查看；也可以调用[CreateConfig](https://cloud.tencent.com/document/product/649/38348)创建新的配置。", "example": "dcfg-a7rl7w4v" } ], "required": [ "ConfigId" ] }, { "name": "DeleteConfigTemplate", "description": "删除模板", "status": "online", "parameters": [ { "name": "ConfigTemplateId", "type": "string", "required": true, "description": "配置模板ID。该参数可以通过调用 [DescribeConfigTemplate](https://cloud.tencent.com/document/product/649/85856) 的返回值中的 ConfigTemplateId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=template)查看；也可以调用[CreateConfigTemplate](https://cloud.tencent.com/document/product/649/85861)创建新的配置模板。", "example": "dcfg_temp-2js8kh" } ], "required": [ "ConfigTemplateId" ] }, { "name": "DeleteContainerGroup", "description": "删除容器部署组", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "部署组ID，可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/api/649/36068)查询已创建的部署组列表或登录控制台进行查看；也可以调用[CreateContainGroup](https://cloud.tencent.com/document/api/649/36075)创建新的部署组。", "example": "group-s892j3s" } ], "required": [ "GroupId" ] }, { "name": "DeleteFileConfig", "description": "删除文件配置项", "status": "online", "parameters": [ { "name": "ConfigId", "type": "string", "required": true, "description": "文件配置项ID。该参数可以通过调用 [DescribeFileConfigs](https://cloud.tencent.com/document/product/649/58593) 的返回值中的 ConfigId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=file)-详情页查看；也可以调用[CreateFileConfig](https://cloud.tencent.com/document/product/649/58594)创建新的文件配置。", "example": "dcfg-f-aeonjd6y" } ], "required": [ "ConfigId" ] }, { "name": "DeleteGatewayApi", "description": "批量删除API", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "分组ID", "example": "grp-notmqbpe" }, { "name": "ApiList", "type": "array", "required": true, "description": "Api ID 数组", "example": "[\"api-8c7538te\"]", "item_type": "string" } ], "required": [ "GroupId", "ApiList" ] }, { "name": "DeleteGroup", "description": "删除容器部署组", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "部署组ID，可通过调用[DescribeGroups](https://cloud.tencent.com/document/api/649/36065)查询已创建的部署组列表或登录控制台进行查看；也可以调用[CreateGroup](https://cloud.tencent.com/document/api/649/36074)创建新的部署组。", "example": "group-6a79x94v" } ], "required": [ "GroupId" ] }, { "name": "DeleteImageTags", "description": "批量删除镜像版本", "status": "online", "parameters": [ { "name": "ImageTags", "type": "array", "required": true, "description": "需要删除的镜像版本列表，可通过调用[DescribeImageTags](https://cloud.tencent.com/document/api/649/36052)查询已创建的镜像版本列表或登录控制台进行查看。", "example": "无", "item_type": "object", "children": [ { "name": "RepoName", "type": "string", "required": true, "description": "仓库名，如/tsf/nginx", "example": "/tsf/nginx" }, { "name": "TagName", "type": "string", "required": true, "description": "版本号:如V1", "example": "latest" } ] }, { "name": "RepoType", "type": "string", "required": false, "description": "企业: tcr ；个人: personal或者不填", "example": "personal" } ], "required": [ "ImageTags" ] }, { "name": "DeleteLane", "description": "删除泳道配置", "status": "online", "parameters": [ { "name": "LaneId", "type": "string", "required": true, "description": "泳道配置ID。该参数可以通过调用 [DescribeLanes](https://cloud.tencent.com/document/product/649/44504) 的返回值中的 LaneId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?tab=grayscale\u0026subTab=lane)查看；也可以调用[CreateLane](https://cloud.tencent.com/document/product/649/44508)创建新的泳道配置。", "example": "lane-y9o6w958" } ], "required": [ "LaneId" ] }, { "name": "DeleteLaneRule", "description": "删除灰度发布规则", "status": "online", "parameters": [ { "name": "RuleId", "type": "string", "required": true, "description": "灰度发布规则ID。该参数可以通过调用 [DescribeLaneRules](https://cloud.tencent.com/document/product/649/44505) 的返回值中的 RuleId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?tab=grayscale\u0026subTab=lanerule)查看；也可以调用[CreateLaneRule](https://cloud.tencent.com/document/product/649/44507)创建新的泳道规则。", "example": "lane-r-f1dk0g1" } ], "required": [ "RuleId" ] }, { "name": "DeleteMicroservice", "description": "删除微服务", "status": "online", "parameters": [ { "name": "MicroserviceId", "type": "string", "required": true, "description": "微服务ID。该参数可以通过调用 [DescribeMicroservices](https://cloud.tencent.com/document/product/649/36084) 的返回值中的 MicroserviceId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?tab=service)查看；也可以调用[CreateMicroserviceWithDetailResp](https://cloud.tencent.com/document/product/649/85860)创建新的微服务。", "example": "ms-vzg9kzj3" } ], "required": [ "MicroserviceId" ] }, { "name": "DeleteNamespace", "description": "删除命名空间", "status": "online", "parameters": [ { "name": "NamespaceId", "type": "string", "required": true, "description": "命名空间ID，按照【命名空间ID】进行过滤，可通过调用[DescribeNamespaces](https://cloud.tencent.com/document/product/649/36096)查询已创建的命名空间列表或登录控制台进行查看；也可以调用[CreateNamespace](https://cloud.tencent.com/document/product/649/36098)创建新命名空间。", "example": "namespace-6a79x94v" }, { "name": "ClusterId", "type": "string", "required": false, "description": "集群ID，按照【集群ID】进行过滤，可通过调用[DescribeClusters](https://cloud.tencent.com/document/product/649/85857)查询已创建的集群列表或登录控制台进行查看；也可以调用[CreateCluster](https://cloud.tencent.com/document/product/649/36049)创建新的集群。仅在集群下无部署组、命名空间、云主机时可以删除。", "example": "cls-6a79x94v" } ], "required": [ "NamespaceId" ] }, { "name": "DeletePathRewrites", "description": "删除路径重写", "status": "online", "parameters": [ { "name": "PathRewriteIds", "type": "array", "required": true, "description": "路径重写规则IDs", "example": "[\"rewrite-qv3rrlnv\"]", "item_type": "string" } ], "required": [ "PathRewriteIds" ] }, { "name": "DeletePkgs", "description": "从软件仓库批量删除程序包。 一次最多支持删除1000个包，数量超过1000，返回UpperDeleteLimit错误。", "status": "online", "parameters": [ { "name": "ApplicationId", "type": "string", "required": true, "description": "应用ID，通过调用DescribeApplications接口[获取应用列表](https://cloud.tencent.com/document/api/649/36090)从而获取应用ID，或登录[控制台](https://console.cloud.tencent.com/tsf/app?rid=1)进行查看，调用CreateApplication接口[创建应用](https://cloud.tencent.com/document/product/649/36094)时的返回值", "example": "application-6a79x94v" }, { "name": "PkgIds", "type": "array", "required": true, "description": "软件包ID所形成的列表，软件包ID可通过调用DescribeUploadInfo接口时[获取上传程序包信息](https://cloud.tencent.com/document/api/649/36078)返回的COS上传信息获取，登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看", "example": "[\"pkg-6a79x94v\"]", "item_type": "string" }, { "name": "RepositoryType", "type": "string", "required": false, "description": "程序包仓库类型（允许值：\"public-demo\"TSF公共demo仓库, \"private\"自定义仓库, \"default\"TSF公共仓库）", "example": "private" }, { "name": "RepositoryId", "type": "string", "required": false, "description": "仓库ID，可通过调用[仓库信息查询类](https://cloud.tencent.com/document/api/649/45925)接口时出参中的RepositoryId，或登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看", "example": "application-6a79x94v" } ], "required": [ "ApplicationId", "PkgIds" ] }, { "name": "DeletePublicConfig", "description": "删除公共配置项", "status": "online", "parameters": [ { "name": "ConfigId", "type": "string", "required": true, "description": "配置ID。该参数可以通过调用 [DescribePublicConfigs](https://cloud.tencent.com/document/product/649/38335) 的返回值中的 ConfigId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=public)配置详情-配置版本页查看；也可以调用[CreatePublicConfig](https://cloud.tencent.com/document/product/649/38347)创建新的配置。", "example": "dcfg-p-vzk36rov" } ], "required": [ "ConfigId" ] }, { "name": "DeleteRepository", "description": "删除仓库", "status": "online", "parameters": [ { "name": "RepositoryId", "type": "string", "required": true, "description": "删除对应仓库ID，可通过调用[仓库信息查询类](https://cloud.tencent.com/document/api/649/45925)接口时出参中的RepositoryId，或登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看", "example": "application-6a79x94v" } ], "required": [ "RepositoryId" ] }, { "name": "DeleteServerlessGroup", "description": "serverless 能力已下线。下线对应接口。 删除Serverless部署组", "status": "deprecated", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "groupId，分组唯一标识" } ], "required": [ "GroupId" ] }, { "name": "DeleteTask", "description": "分布式任务调度 TCT 已到达 EOMS 节点，进行产品下线处理。退市公告https://cloud.tencent.com/announce/detail/2053 删除任务", "status": "deprecated", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页第一列和任务基本信息页查看任务ID。", "example": "task-6a79x94v" } ], "required": [ "TaskId" ] }, { "name": "DeleteUnitNamespaces", "description": "删除单元化命名空间", "status": "online", "parameters": [ { "name": "GatewayInstanceId", "type": "string", "required": true, "description": "网关实体ID", "example": "gw-ins-szesmg28" }, { "name": "UnitNamespaceList", "type": "array", "required": true, "description": "单元化命名空间ID数组", "example": "[\"unit-ns-5mvrkoz2\"]", "item_type": "string" } ], "required": [ "GatewayInstanceId", "UnitNamespaceList" ] }, { "name": "DeleteUnitRule", "description": "删除单元化规则", "status": "online", "parameters": [ { "name": "Id", "type": "string", "required": true, "description": "规则ID", "example": "unit-rl-cgd3l6jo" } ], "required": [ "Id" ] }, { "name": "DeployContainerApplication", "description": "部署容器应用-更新", "status": "online", "parameters": [ { "name": "ApplicationId", "type": "string", "required": true, "description": "应用ID", "example": "application-9yn765ea" }, { "name": "ObservabilityConfig", "type": "object", "required": false, "description": "可观测配置", "example": "无", "children": [ { "name": "BusinessLogConfigIdList", "type": "array", "required": false, "description": "日志配置项ID列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"apm-busi-log-cfg-lba2povk\", \"apm-busi-log-cfg-2vz5nm9v\"]", "item_type": "string" }, { "name": "BusinessLogDeliveryConfigIdList", "type": "array", "required": false, "description": "投递配置项ID列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"send-data-to-kafka-nyg9o3wa\"]", "item_type": "string" } ] }, { "name": "ClusterId", "type": "string", "required": false, "description": "集群ID", "example": "cls-23iwxs1y" }, { "name": "GroupId", "type": "string", "required": false, "description": "部署组ID，分组唯一标识", "example": "group-zvwpn3wy" }, { "name": "Envs", "type": "array", "required": false, "description": "业务容器的环境变量参数", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "环境变量名称", "example": "foo" }, { "name": "Value", "type": "string", "required": false, "description": "环境变量值", "example": "bar" }, { "name": "ValueFrom", "type": "object", "required": false, "description": "k8s ValueFrom 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "FieldRef", "type": "object", "required": false, "description": "k8s env 的 FieldRef", "example": "无", "children": [ { "name": "FieldPath", "type": "string", "required": false, "description": "k8s 的 FieldPath", "example": "metadata.name" } ] }, { "name": "ResourceFieldRef", "type": "object", "required": false, "description": "k8s env 的 ResourceFieldRef 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Resource", "type": "string", "required": false, "description": "k8s 的 Resource", "example": "limits.cpu" } ] }, { "name": "ConfigMapKeyRef", "type": "object", "required": false, "description": "k8s env的configMapKeyRef", "example": "无", "children": [ { "name": "Name", "type": "string", "required": false, "description": "名称", "example": "name-mock" }, { "name": "Key", "type": "string", "required": false, "description": "Key值", "example": "key-mock" } ] }, { "name": "SecretKeyRef", "type": "object", "required": false, "description": "k8s env 的 secretKeyRef", "example": "无", "children": [ { "name": "Name", "type": "string", "required": false, "description": "名称", "example": "name-mock" }, { "name": "Key", "type": "string", "required": false, "description": "Key值", "example": "key-mock" } ] } ] } ] }, { "name": "VolumeMountInfoList", "type": "array", "required": false, "description": "业务容器的挂载信息", "example": "无", "item_type": "object", "children": [ { "name": "VolumeMountName", "type": "string", "required": true, "description": "挂载数据卷名称", "example": "config-name" }, { "name": "VolumeMountPath", "type": "string", "required": true, "description": "挂载路径", "example": "/host" }, { "name": "VolumeMountSubPath", "type": "string", "required": false, "description": "挂载子路径", "example": "/tsf" }, { "name": "ReadOrWrite", "type": "string", "required": false, "description": "读写，1：读 2：读写", "example": "2" } ] }, { "name": "LifeCycleHookList", "type": "array", "required": false, "description": "业务主容器生命周期钩子列表", "example": "无", "item_type": "object", "children": [ { "name": "HookType", "type": "string", "required": false, "description": "生命周期函数类型：PostStart|PreStop 注意：此字段可能返回 null，表示取不到有效值。", "example": "postStart" }, { "name": "ExecMode", "type": "string", "required": false, "description": "函数执行方式：execCommand|httpGet|none 注意：此字段可能返回 null，表示取不到有效值。", "example": "httpGet" }, { "name": "ExecCommandContent", "type": "string", "required": false, "description": "execCommand函数执行内容 注意：此字段可能返回 null，表示取不到有效值。", "example": "/bin/sh\\n-c\\nsleep 35" }, { "name": "HttpGetOption", "type": "object", "required": false, "description": "HttpGet执行内容 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Host", "type": "string", "required": false, "description": "主机地址 注意：此字段可能返回 null，表示取不到有效值。", "example": "tencent.com" }, { "name": "Path", "type": "string", "required": false, "description": "路径 注意：此字段可能返回 null，表示取不到有效值。", "example": "/tmp" }, { "name": "Port", "type": "string", "required": false, "description": "端口 注意：此字段可能返回 null，表示取不到有效值。", "example": "7998" }, { "name": "Scheme", "type": "string", "required": false, "description": "协议：HTTP｜HTTPS 注意：此字段可能返回 null，表示取不到有效值。", "example": "HTTP" } ] } ] }, { "name": "AdditionalContainerList", "type": "array", "required": false, "description": "附属容器列表", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "容器名 注意：此字段可能返回 null，表示取不到有效值。", "example": "consumer" }, { "name": "ContainerId", "type": "string", "required": false, "description": "容器ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "0f675d42546fc" }, { "name": "Status", "type": "string", "required": false, "description": "容器状态 注意：此字段可能返回 null，表示取不到有效值。", "example": "Waiting" }, { "name": "Reason", "type": "string", "required": false, "description": "容器的Reason 注意：此字段可能返回 null，表示取不到有效值。", "example": "ContainerCreating" }, { "name": "Image", "type": "string", "required": false, "description": "镜像地址 注意：此字段可能返回 null，表示取不到有效值。", "example": "ccr.ccs.tencentyun.com/tsf_700001067584/test-ns" }, { "name": "IsBusinessMainContainer", "type": "boolean", "required": false, "description": "是否为业务主容器 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "Server", "type": "string", "required": false, "description": "镜像Server 注意：此字段可能返回 null，表示取不到有效值。", "example": "ccr.ccs.tencentyun.com" }, { "name": "RepoName", "type": "string", "required": false, "description": "镜像名 注意：此字段可能返回 null，表示取不到有效值。", "example": "tsf_700001067584/test-ns" }, { "name": "RepoType", "type": "string", "required": false, "description": "仓库类型 注意：此字段可能返回 null，表示取不到有效值。", "example": "personal" }, { "name": "TcrRepoInfo", "type": "object", "required": false, "description": "TCR 仓库信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Region", "type": "string", "required": false, "description": "地域（填数字）", "example": "ap-guangzhou" }, { "name": "RegistryId", "type": "string", "required": false, "description": "实例id", "example": "reg-6a79x94v" }, { "name": "RegistryName", "type": "string", "required": false, "description": "实例名", "example": "/tsf" }, { "name": "Namespace", "type": "string", "required": false, "description": "命名空间", "example": "tsf_1083080xxxx" }, { "name": "RepoName", "type": "string", "required": false, "description": "仓库名", "example": "/tsf/nginx" } ] }, { "name": "SecretName", "type": "string", "required": false, "description": "容器访问凭证名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "qcloudregistry" }, { "name": "TagName", "type": "string", "required": false, "description": "镜像版本号 注意：此字段可能返回 null，表示取不到有效值。", "example": "v1" }, { "name": "HealthCheckSettings", "type": "object", "required": false, "description": "健康检查 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "LivenessProbe", "type": "object", "required": false, "description": "存活健康检查 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "ActionType", "type": "string", "required": true, "description": "健康检查方法。HTTP：通过 HTTP 接口检查；CMD：通过执行命令检查；TCP：通过建立 TCP 连接检查。 注意：此字段可能返回 null，表示取不到有效值。", "example": "HTTP" }, { "name": "InitialDelaySeconds", "type": "integer", "required": false, "description": "容器延时启动健康检查的时间，单位秒。 注意：此字段可能返回 null，表示取不到有效值。", "example": "180" }, { "name": "TimeoutSeconds", "type": "integer", "required": false, "description": "每次健康检查响应的最大超时时间，单位秒。 注意：此字段可能返回 null，表示取不到有效值。", "example": "30" }, { "name": "PeriodSeconds", "type": "integer", "required": false, "description": "进行健康检查的时间间隔，单位秒。 注意：此字段可能返回 null，表示取不到有效值。", "example": "30" }, { "name": "SuccessThreshold", "type": "integer", "required": false, "description": "表示后端容器从失败到成功的连续健康检查成功次数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "FailureThreshold", "type": "integer", "required": false, "description": "表示后端容器从成功到失败的连续健康检查成功次数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "3" }, { "name": "Scheme", "type": "string", "required": false, "description": "HTTP 健康检查方法使用的检查协议。支持HTTP、HTTPS。 注意：此字段可能返回 null，表示取不到有效值。", "example": "HTTP" }, { "name": "Port", "type": "integer", "required": false, "description": "健康检查端口，范围 1~65535 。 注意：此字段可能返回 null，表示取不到有效值。", "example": "8080" }, { "name": "Path", "type": "string", "required": false, "description": "HTTP 健康检查接口的请求路径。 注意：此字段可能返回 null，表示取不到有效值。", "example": "/health" }, { "name": "Command", "type": "array", "required": false, "description": "执行命令检查方式，执行的命令。 注意：此字段可能返回 null，表示取不到有效值。", "example": "sh health.sh", "item_type": "string" }, { "name": "Type", "type": "string", "required": false, "description": "TSF_DEFAULT：tsf 默认就绪探针。K8S_NATIVE：k8s 原生探针。不填默认为 k8s 原生探针。 注意：此字段可能返回 null，表示取不到有效值。", "example": "K8S_NATIVE" } ] }, { "name": "ReadinessProbe", "type": "object", "required": false, "description": "就绪健康检查 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "ActionType", "type": "string", "required": true, "description": "健康检查方法。HTTP：通过 HTTP 接口检查；CMD：通过执行命令检查；TCP：通过建立 TCP 连接检查。 注意：此字段可能返回 null，表示取不到有效值。", "example": "HTTP" }, { "name": "InitialDelaySeconds", "type": "integer", "required": false, "description": "容器延时启动健康检查的时间，单位秒。 注意：此字段可能返回 null，表示取不到有效值。", "example": "180" }, { "name": "TimeoutSeconds", "type": "integer", "required": false, "description": "每次健康检查响应的最大超时时间，单位秒。 注意：此字段可能返回 null，表示取不到有效值。", "example": "30" }, { "name": "PeriodSeconds", "type": "integer", "required": false, "description": "进行健康检查的时间间隔，单位秒。 注意：此字段可能返回 null，表示取不到有效值。", "example": "30" }, { "name": "SuccessThreshold", "type": "integer", "required": false, "description": "表示后端容器从失败到成功的连续健康检查成功次数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "FailureThreshold", "type": "integer", "required": false, "description": "表示后端容器从成功到失败的连续健康检查成功次数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "3" }, { "name": "Scheme", "type": "string", "required": false, "description": "HTTP 健康检查方法使用的检查协议。支持HTTP、HTTPS。 注意：此字段可能返回 null，表示取不到有效值。", "example": "HTTP" }, { "name": "Port", "type": "integer", "required": false, "description": "健康检查端口，范围 1~65535 。 注意：此字段可能返回 null，表示取不到有效值。", "example": "8080" }, { "name": "Path", "type": "string", "required": false, "description": "HTTP 健康检查接口的请求路径。 注意：此字段可能返回 null，表示取不到有效值。", "example": "/health" }, { "name": "Command", "type": "array", "required": false, "description": "执行命令检查方式，执行的命令。 注意：此字段可能返回 null，表示取不到有效值。", "example": "sh health.sh", "item_type": "string" }, { "name": "Type", "type": "string", "required": false, "description": "TSF_DEFAULT：tsf 默认就绪探针。K8S_NATIVE：k8s 原生探针。不填默认为 k8s 原生探针。 注意：此字段可能返回 null，表示取不到有效值。", "example": "K8S_NATIVE" } ] } ] }, { "name": "CpuRequest", "type": "string", "required": false, "description": "容器Cpu request 注意：此字段可能返回 null，表示取不到有效值。", "example": "0.25" }, { "name": "CpuLimit", "type": "string", "required": false, "description": "容器Cpu limit 注意：此字段可能返回 null，表示取不到有效值。", "example": "0.5" }, { "name": "MemRequest", "type": "string", "required": false, "description": "容器Mem request 注意：此字段可能返回 null，表示取不到有效值。", "example": "120" }, { "name": "MemLimit", "type": "string", "required": false, "description": "容器Mem Limit 注意：此字段可能返回 null，表示取不到有效值。", "example": "1280" }, { "name": "Envs", "type": "array", "required": false, "description": "环境变量参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "环境变量名称", "example": "foo" }, { "name": "Value", "type": "string", "required": false, "description": "环境变量值", "example": "bar" }, { "name": "ValueFrom", "type": "object", "required": false, "description": "k8s ValueFrom 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "FieldRef", "type": "object", "required": false, "description": "k8s env 的 FieldRef", "example": "无" }, { "name": "ResourceFieldRef", "type": "object", "required": false, "description": "k8s env 的 ResourceFieldRef 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "ConfigMapKeyRef", "type": "object", "required": false, "description": "k8s env的configMapKeyRef", "example": "无" }, { "name": "SecretKeyRef", "type": "object", "required": false, "description": "k8s env 的 secretKeyRef", "example": "无" } ] } ] }, { "name": "UserEnvs", "type": "array", "required": false, "description": "环境变量参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "环境变量名称", "example": "foo" }, { "name": "Value", "type": "string", "required": false, "description": "环境变量值", "example": "bar" }, { "name": "ValueFrom", "type": "object", "required": false, "description": "k8s ValueFrom 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "FieldRef", "type": "object", "required": false, "description": "k8s env 的 FieldRef", "example": "无" }, { "name": "ResourceFieldRef", "type": "object", "required": false, "description": "k8s env 的 ResourceFieldRef 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "ConfigMapKeyRef", "type": "object", "required": false, "description": "k8s env的configMapKeyRef", "example": "无" }, { "name": "SecretKeyRef", "type": "object", "required": false, "description": "k8s env 的 secretKeyRef", "example": "无" } ] } ] }, { "name": "JvmOpts", "type": "string", "required": false, "description": "JVM参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "-Xms128m -Xmx512m -XX:MetaspaceSize=128m -XX:MaxMetaspaceSize=512m" }, { "name": "VolumeMountInfoList", "type": "array", "required": false, "description": "挂载信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "VolumeMountName", "type": "string", "required": true, "description": "挂载数据卷名称", "example": "config-name" }, { "name": "VolumeMountPath", "type": "string", "required": true, "description": "挂载路径", "example": "/host" }, { "name": "VolumeMountSubPath", "type": "string", "required": false, "description": "挂载子路径", "example": "/tsf" }, { "name": "ReadOrWrite", "type": "string", "required": false, "description": "读写，1：读 2：读写", "example": "2" } ] }, { "name": "InitContainerEnable", "type": "boolean", "required": false, "description": "是否为初始化容器 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" }, { "name": "LifeCycleHookList", "type": "array", "required": false, "description": "生命周期钩子 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "HookType", "type": "string", "required": false, "description": "生命周期函数类型：PostStart|PreStop 注意：此字段可能返回 null，表示取不到有效值。", "example": "postStart" }, { "name": "ExecMode", "type": "string", "required": false, "description": "函数执行方式：execCommand|httpGet|none 注意：此字段可能返回 null，表示取不到有效值。", "example": "httpGet" }, { "name": "ExecCommandContent", "type": "string", "required": false, "description": "execCommand函数执行内容 注意：此字段可能返回 null，表示取不到有效值。", "example": "/bin/sh\\n-c\\nsleep 35" }, { "name": "HttpGetOption", "type": "object", "required": false, "description": "HttpGet执行内容 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Host", "type": "string", "required": false, "description": "主机地址 注意：此字段可能返回 null，表示取不到有效值。", "example": "tencent.com" }, { "name": "Path", "type": "string", "required": false, "description": "路径 注意：此字段可能返回 null，表示取不到有效值。", "example": "/tmp" }, { "name": "Port", "type": "string", "required": false, "description": "端口 注意：此字段可能返回 null，表示取不到有效值。", "example": "7998" }, { "name": "Scheme", "type": "string", "required": false, "description": "协议：HTTP｜HTTPS 注意：此字段可能返回 null，表示取不到有效值。", "example": "HTTP" } ] } ] }, { "name": "PrivilegeContainerEnable", "type": "boolean", "required": false, "description": "是否为特权容器 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" }, { "name": "RunCommand", "type": "string", "required": false, "description": "运行命令 注意：此字段可能返回 null，表示取不到有效值。", "example": "/bin/sh" }, { "name": "RunArg", "type": "string", "required": false, "description": "运行参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "-c\\nwhile true; do echo hello; sleep 10; done" }, { "name": "ContainerName", "type": "string", "required": false, "description": "容器名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "group-nygeogpv-docker" } ] }, { "name": "VolumeInfoList", "type": "array", "required": false, "description": "容器卷信息", "example": "无", "item_type": "object", "children": [ { "name": "VolumeType", "type": "string", "required": true, "description": "数据卷类型", "example": "emptyDir" }, { "name": "VolumeName", "type": "string", "required": true, "description": "数据卷名称", "example": "config-path" }, { "name": "VolumeConfig", "type": "string", "required": false, "description": "数据卷配置", "example": "/host" }, { "name": "ConfigMapOptions", "type": "array", "required": false, "description": "-", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "-", "example": "key-mock" }, { "name": "Path", "type": "string", "required": false, "description": "-", "example": "/config" }, { "name": "Mode", "type": "string", "required": false, "description": "-", "example": "hostPath" } ] }, { "name": "EmptyDirOption", "type": "object", "required": false, "description": "-", "example": "无", "children": [ { "name": "EnableMemory", "type": "boolean", "required": false, "description": "-", "example": "false" }, { "name": "StorageCapacity", "type": "integer", "required": false, "description": "-", "example": "64" }, { "name": "StorageUnit", "type": "string", "required": false, "description": "-", "example": "12" }, { "name": "SizeLimit", "type": "string", "required": false, "description": "-", "example": "32" } ] }, { "name": "VolumeClaimTemplateOption", "type": "object", "required": false, "description": "数据卷PVC声明模板", "example": "无", "children": [ { "name": "StorageClass", "type": "string", "required": false, "description": "StorageClass名称", "example": "cbs" }, { "name": "AccessModes", "type": "array", "required": false, "description": "访问模式", "example": "ReadWriteOnce", "item_type": "string" }, { "name": "StorageRequest", "type": "integer", "required": false, "description": "卷空间的预占声明", "example": "20" } ] } ] }, { "name": "ServiceSettingList", "type": "array", "required": false, "description": "Service访问配置列表", "example": "无", "item_type": "object", "children": [ { "name": "AccessType", "type": "integer", "required": true, "description": "0:公网, 1:集群内访问, 2：NodePort, 3: VPC 内网访问", "example": "2" }, { "name": "ProtocolPorts", "type": "array", "required": true, "description": "容器端口映射", "example": "无", "item_type": "object", "children": [ { "name": "Protocol", "type": "string", "required": true, "description": "TCP UDP", "example": "TCP" }, { "name": "Port", "type": "integer", "required": true, "description": "服务端口", "example": "8080" }, { "name": "TargetPort", "type": "integer", "required": true, "description": "容器端口", "example": "8080" }, { "name": "NodePort", "type": "integer", "required": false, "description": "主机端口", "example": "30090" }, { "name": "Name", "type": "string", "required": false, "description": "端口名称", "example": "port-0" } ] }, { "name": "SubnetId", "type": "string", "required": false, "description": "子网ID", "example": "subnet-d15zonly" }, { "name": "DisableService", "type": "boolean", "required": false, "description": "是否创建 k8s service，默认为 false", "example": "false" }, { "name": "HeadlessService", "type": "boolean", "required": false, "description": "service 是否为 headless 类型", "example": "false" }, { "name": "AllowDeleteService", "type": "boolean", "required": false, "description": "当为 true 且 DisableService 也为 true 时，会删除之前创建的 service，请小心使用", "example": "false" }, { "name": "OpenSessionAffinity", "type": "boolean", "required": false, "description": "开启SessionAffinity，true为开启，false为不开启，默认为false", "example": "false" }, { "name": "SessionAffinityTimeoutSeconds", "type": "integer", "required": false, "description": "SessionAffinity会话时间，默认10800", "example": "10800" }, { "name": "ServiceName", "type": "string", "required": false, "description": "服务名称", "example": "svc-name" }, { "name": "ExternalTrafficStrategy", "type": "string", "required": false, "description": "外部流量策略", "example": "Local" }, { "name": "ExternalTrafficPolicy", "type": "string", "required": false, "description": "外部流量策略", "example": "Local" }, { "name": "LoadBalancerProvisioner", "type": "string", "required": false, "description": "负载均衡提供者", "example": "tgw" }, { "name": "LoadBalancingType", "type": "string", "required": false, "description": "负载均衡类型，Intranet表示内网，Internet表示外网", "example": "Intranet" }, { "name": "ClusterIp", "type": "string", "required": false, "description": "k8s负载均衡内网vip", "example": "192.168.21.2" }, { "name": "DisableServiceInt", "type": "integer", "required": false, "description": "禁用服务Int记录", "example": "0" }, { "name": "OpenSessionAffinityInt", "type": "integer", "required": false, "description": "开启SessionAffinity Int记录", "example": "0" }, { "name": "HeadlessServiceInt", "type": "integer", "required": false, "description": "开启HeadlessService int记录", "example": "0" }, { "name": "Name", "type": "string", "required": false, "description": "服务名称", "example": "svc-name" }, { "name": "VpcId", "type": "string", "required": false, "description": "VPC网络ID", "example": "vpcid" }, { "name": "LoadBalancingIp", "type": "string", "required": false, "description": "负载均衡VIP", "example": "loadbalanceIp" }, { "name": "LoadBalancerId", "type": "string", "required": false, "description": "负载均衡id", "example": "loadbalanceId" }, { "name": "ExistingLoadBalancerId", "type": "string", "required": false, "description": "已存在的负载均衡id", "example": "existingLoadbalancerId" } ] }, { "name": "Alias", "type": "string", "required": false, "description": "备注", "example": "consumer app" }, { "name": "GroupName", "type": "string", "required": false, "description": "部署组名称", "example": "consumer-app" }, { "name": "Tags", "type": "array", "required": false, "description": "标签列表", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "标签键", "example": "name" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值", "example": "tsf" } ] }, { "name": "ContainerKind", "type": "string", "required": false, "description": "容器类型", "example": "Deployment" }, { "name": "Server", "type": "string", "required": false, "description": "业务容器的 镜像Server ccr.ccs.tencentyun.com", "example": "ccr.ccs.tencentyun.com" }, { "name": "RepoName", "type": "string", "required": false, "description": "业务容器的镜像名", "example": "tsf_700001025656/test-sts-1" }, { "name": "RepoType", "type": "string", "required": false, "description": "仓库类型", "example": "personal" }, { "name": "TcrRepoInfo", "type": "object", "required": false, "description": "TCR仓库信息", "example": "无", "children": [ { "name": "Region", "type": "string", "required": false, "description": "地域（填数字）", "example": "ap-guangzhou" }, { "name": "RegistryId", "type": "string", "required": false, "description": "实例id", "example": "reg-6a79x94v" }, { "name": "RegistryName", "type": "string", "required": false, "description": "实例名", "example": "/tsf" }, { "name": "Namespace", "type": "string", "required": false, "description": "命名空间", "example": "tsf_1083080xxxx" }, { "name": "RepoName", "type": "string", "required": false, "description": "仓库名", "example": "/tsf/nginx" } ] }, { "name": "SecretName", "type": "string", "required": false, "description": "容器访问凭证名称", "example": "qcloudregistry" }, { "name": "TagName", "type": "string", "required": false, "description": "业务容器的镜像版本号", "example": "v1" }, { "name": "HealthCheckSettings", "type": "object", "required": false, "description": "健康检查", "example": "无", "children": [ { "name": "LivenessProbe", "type": "object", "required": false, "description": "存活健康检查 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "ActionType", "type": "string", "required": true, "description": "健康检查方法。HTTP：通过 HTTP 接口检查；CMD：通过执行命令检查；TCP：通过建立 TCP 连接检查。 注意：此字段可能返回 null，表示取不到有效值。", "example": "HTTP" }, { "name": "InitialDelaySeconds", "type": "integer", "required": false, "description": "容器延时启动健康检查的时间，单位秒。 注意：此字段可能返回 null，表示取不到有效值。", "example": "180" }, { "name": "TimeoutSeconds", "type": "integer", "required": false, "description": "每次健康检查响应的最大超时时间，单位秒。 注意：此字段可能返回 null，表示取不到有效值。", "example": "30" }, { "name": "PeriodSeconds", "type": "integer", "required": false, "description": "进行健康检查的时间间隔，单位秒。 注意：此字段可能返回 null，表示取不到有效值。", "example": "30" }, { "name": "SuccessThreshold", "type": "integer", "required": false, "description": "表示后端容器从失败到成功的连续健康检查成功次数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "FailureThreshold", "type": "integer", "required": false, "description": "表示后端容器从成功到失败的连续健康检查成功次数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "3" }, { "name": "Scheme", "type": "string", "required": false, "description": "HTTP 健康检查方法使用的检查协议。支持HTTP、HTTPS。 注意：此字段可能返回 null，表示取不到有效值。", "example": "HTTP" }, { "name": "Port", "type": "integer", "required": false, "description": "健康检查端口，范围 1~65535 。 注意：此字段可能返回 null，表示取不到有效值。", "example": "8080" }, { "name": "Path", "type": "string", "required": false, "description": "HTTP 健康检查接口的请求路径。 注意：此字段可能返回 null，表示取不到有效值。", "example": "/health" }, { "name": "Command", "type": "array", "required": false, "description": "执行命令检查方式，执行的命令。 注意：此字段可能返回 null，表示取不到有效值。", "example": "sh health.sh", "item_type": "string" }, { "name": "Type", "type": "string", "required": false, "description": "TSF_DEFAULT：tsf 默认就绪探针。K8S_NATIVE：k8s 原生探针。不填默认为 k8s 原生探针。 注意：此字段可能返回 null，表示取不到有效值。", "example": "K8S_NATIVE" } ] }, { "name": "ReadinessProbe", "type": "object", "required": false, "description": "就绪健康检查 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "ActionType", "type": "string", "required": true, "description": "健康检查方法。HTTP：通过 HTTP 接口检查；CMD：通过执行命令检查；TCP：通过建立 TCP 连接检查。 注意：此字段可能返回 null，表示取不到有效值。", "example": "HTTP" }, { "name": "InitialDelaySeconds", "type": "integer", "required": false, "description": "容器延时启动健康检查的时间，单位秒。 注意：此字段可能返回 null，表示取不到有效值。", "example": "180" }, { "name": "TimeoutSeconds", "type": "integer", "required": false, "description": "每次健康检查响应的最大超时时间，单位秒。 注意：此字段可能返回 null，表示取不到有效值。", "example": "30" }, { "name": "PeriodSeconds", "type": "integer", "required": false, "description": "进行健康检查的时间间隔，单位秒。 注意：此字段可能返回 null，表示取不到有效值。", "example": "30" }, { "name": "SuccessThreshold", "type": "integer", "required": false, "description": "表示后端容器从失败到成功的连续健康检查成功次数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "FailureThreshold", "type": "integer", "required": false, "description": "表示后端容器从成功到失败的连续健康检查成功次数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "3" }, { "name": "Scheme", "type": "string", "required": false, "description": "HTTP 健康检查方法使用的检查协议。支持HTTP、HTTPS。 注意：此字段可能返回 null，表示取不到有效值。", "example": "HTTP" }, { "name": "Port", "type": "integer", "required": false, "description": "健康检查端口，范围 1~65535 。 注意：此字段可能返回 null，表示取不到有效值。", "example": "8080" }, { "name": "Path", "type": "string", "required": false, "description": "HTTP 健康检查接口的请求路径。 注意：此字段可能返回 null，表示取不到有效值。", "example": "/health" }, { "name": "Command", "type": "array", "required": false, "description": "执行命令检查方式，执行的命令。 注意：此字段可能返回 null，表示取不到有效值。", "example": "sh health.sh", "item_type": "string" }, { "name": "Type", "type": "string", "required": false, "description": "TSF_DEFAULT：tsf 默认就绪探针。K8S_NATIVE：k8s 原生探针。不填默认为 k8s 原生探针。 注意：此字段可能返回 null，表示取不到有效值。", "example": "K8S_NATIVE" } ] } ] }, { "name": "CpuRequest", "type": "string", "required": false, "description": "业务容器的 cpu request", "example": "0.1" }, { "name": "CpuLimit", "type": "string", "required": false, "description": "业务容器的 cpu limit", "example": "0.5" }, { "name": "MemRequest", "type": "string", "required": false, "description": "业务容器的 mem request", "example": "1024" }, { "name": "MemLimit", "type": "string", "required": false, "description": "业务容器的 mem limit", "example": "200" }, { "name": "JvmOpts", "type": "string", "required": false, "description": "业务容器的 jvm 参数", "example": "-Xms128m -Xmx512m -XX:MetaspaceSize=128m -XX:MaxMetaspaceSize=512m" }, { "name": "InitContainerEnable", "type": "boolean", "required": false, "description": "是否为初始化容器 业务主容器不能为初始化容", "example": "false" }, { "name": "PrivilegeContainerEnable", "type": "boolean", "required": false, "description": "业务主容器是否为特权容器", "example": "false" }, { "name": "RunCommand", "type": "string", "required": false, "description": "业务主容器运行命令(转base64)", "example": "/bin/sh" }, { "name": "RunArg", "type": "string", "required": false, "description": "业务主容器运行参数(转base64)", "example": "-c\\nwhile true; do echo hello; sleep 10; done" }, { "name": "InstanceNum", "type": "integer", "required": false, "description": "实例数量", "example": "1" }, { "name": "SchedulingStrategy", "type": "object", "required": false, "description": "调度策略", "example": "无", "children": [ { "name": "Type", "type": "string", "required": false, "description": "NONE：不使用调度策略；CROSS_AZ：跨可用区部署", "example": "NONE" }, { "name": "NodeScheduleStrategyType", "type": "string", "required": false, "description": "-", "example": "NoSchedule" }, { "name": "NodeScheduleOptions", "type": "array", "required": false, "description": "-", "example": "无", "item_type": "object", "children": [ { "name": "LabelName", "type": "string", "required": false, "description": "-", "example": "GroupId" }, { "name": "Operator", "type": "string", "required": false, "description": "-", "example": "eqauls" }, { "name": "LabelValue", "type": "string", "required": false, "description": "-", "example": "group-6a79x94v" } ] }, { "name": "StrongAffinityList", "type": "array", "required": false, "description": "-", "example": "无", "item_type": "object", "children": [ { "name": "LabelName", "type": "string", "required": false, "description": "-", "example": "GroupId" }, { "name": "Operator", "type": "string", "required": false, "description": "-", "example": "eqauls" }, { "name": "LabelValue", "type": "string", "required": false, "description": "-", "example": "group-6a79x94v" } ] }, { "name": "WeakAffinityList", "type": "array", "required": false, "description": "-", "example": "无", "item_type": "object", "children": [ { "name": "LabelName", "type": "string", "required": false, "description": "-", "example": "GroupId" }, { "name": "Operator", "type": "string", "required": false, "description": "-", "example": "eqauls" }, { "name": "LabelValue", "type": "string", "required": false, "description": "-", "example": "group-6a79x94v" } ] }, { "name": "WeakAffinityWeight", "type": "integer", "required": false, "description": "-", "example": "50" }, { "name": "AvailableZoneScatterScheduleType", "type": "string", "required": false, "description": "-", "example": "podAntiAffinity" }, { "name": "AvailableZoneScatterScheduleRules", "type": "array", "required": false, "description": "-", "example": "无", "item_type": "object", "children": [ { "name": "ScatterDimension", "type": "string", "required": false, "description": "-", "example": "Application" }, { "name": "MaxUnbalanceQuantity", "type": "integer", "required": false, "description": "-", "example": "25" }, { "name": "IsForceSchedule", "type": "boolean", "required": false, "description": "-", "example": "true" }, { "name": "Paths", "type": "array", "required": false, "description": "-", "example": "无", "item_type": "object", "children": [ { "name": "LabelName", "type": "string", "required": false, "description": "-", "example": "GroupId" }, { "name": "Operator", "type": "string", "required": false, "description": "-", "example": "eqauls" }, { "name": "LabelValue", "type": "string", "required": false, "description": "-", "example": "group-6a79x94v" } ] } ] }, { "name": "PodScheduleStrategyType", "type": "string", "required": false, "description": "-", "example": "podAntiAffinity" }, { "name": "CustomPodSchedule", "type": "object", "required": false, "description": "-", "example": "无", "children": [ { "name": "ForceSchedule", "type": "object", "required": false, "description": "-", "example": "无", "children": [ { "name": "AffinityList", "type": "array", "required": false, "description": "-", "example": "无", "item_type": "string" }, { "name": "AntiAffinityList", "type": "array", "required": false, "description": "-", "example": "无", "item_type": "string" } ] }, { "name": "TrySchedule", "type": "object", "required": false, "description": "-", "example": "无", "children": [ { "name": "AffinityList", "type": "array", "required": false, "description": "-", "example": "无", "item_type": "string" }, { "name": "AntiAffinityList", "type": "array", "required": false, "description": "-", "example": "无", "item_type": "string" } ] } ] }, { "name": "TolerateScheduleType", "type": "string", "required": false, "description": "-", "example": "NoSchedule" }, { "name": "CustomTolerateSchedules", "type": "array", "required": false, "description": "-", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "-", "example": "host" }, { "name": "Operator", "type": "string", "required": false, "description": "-", "example": "equlas" }, { "name": "Value", "type": "string", "required": false, "description": "-", "example": "hostName" }, { "name": "Effect", "type": "string", "required": false, "description": "-", "example": "effect" }, { "name": "TolerationSeconds", "type": "integer", "required": false, "description": "-", "example": "30" } ] } ] }, { "name": "RestartPolicy", "type": "string", "required": false, "description": "重启策略", "example": "Always" }, { "name": "ServiceSpecEncode", "type": "string", "required": false, "description": "服务治理配置", "example": "NULL" }, { "name": "IstioMemRequest", "type": "string", "required": false, "description": "istio容器的 mem Request", "example": "200" }, { "name": "IstioCpuRequest", "type": "string", "required": false, "description": "istio容器的 cpu Request", "example": "0.4" }, { "name": "IstioMemLimit", "type": "string", "required": false, "description": "istio容器的 mem Limit", "example": "1024" }, { "name": "IstioCpuLimit", "type": "string", "required": false, "description": "istio容器的 cpu Limit", "example": "1" }, { "name": "ServiceGovernanceConfig", "type": "object", "required": false, "description": "服务治理配置", "example": "无", "children": [ { "name": "EnableGovernance", "type": "boolean", "required": false, "description": "是否开启服务治理 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "ServiceConfigList", "type": "array", "required": false, "description": "控制台场景使用 mesh服务配置信息列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "服务名", "example": "java-demo" }, { "name": "Ports", "type": "array", "required": true, "description": "端口信息列表", "example": "无", "item_type": "object", "children": [ { "name": "TargetPort", "type": "integer", "required": true, "description": "服务端口", "example": "8080" }, { "name": "Protocol", "type": "string", "required": true, "description": "端口协议，TCP或者UDP", "example": "TCP" } ] }, { "name": "HealthCheck", "type": "object", "required": false, "description": "健康检查配置", "example": "无", "children": [ { "name": "Path", "type": "string", "required": false, "description": "健康检查路径", "example": "/health" } ] } ] }, { "name": "ExclusiveInstances", "type": "array", "required": false, "description": "注册服务治理实例 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "CenterType", "type": "string", "required": false, "description": "配置中心类型[注册中心Registration、配置中心Configuration]", "example": "Registration" }, { "name": "InstanceId", "type": "string", "required": false, "description": "实例id，通过[北极星控制台](https://console.cloud.tencent.com/tse/governance)获取", "example": "ins-6a79x94v" }, { "name": "InstanceType", "type": "string", "required": false, "description": "实例类型，例如北极星Polaris", "example": "Polaris" }, { "name": "InstanceName", "type": "string", "required": false, "description": "实例名称", "example": "Polaris-Config" }, { "name": "RegionId", "type": "string", "required": false, "description": "实例地域id，通过[北极星控制台](https://console.cloud.tencent.com/tse/governance)获取", "example": "7" }, { "name": "InstanceNamespaceId", "type": "string", "required": false, "description": "实例命名空间ID，通过[北极星控制台](https://console.cloud.tencent.com/tse/governance)获取", "example": "namespace-6a79x94v" }, { "name": "GroupId", "type": "string", "required": false, "description": "部署组Id 注意：此字段可能返回 null，表示取不到有效值。", "example": "group-6a73eg5v" }, { "name": "CreateTime", "type": "integer", "required": false, "description": "创建时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "1757324401000" }, { "name": "UpdateTime", "type": "integer", "required": false, "description": "更新时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "1757324863000" } ] }, { "name": "GovernanceType", "type": "string", "required": false, "description": "服务治理类型 注意：此字段可能返回 null，表示取不到有效值。", "example": "SHARE" } ] }, { "name": "AgentMemRequest", "type": "string", "required": false, "description": "agent容器的 mem Request", "example": "200" }, { "name": "AgentCpuRequest", "type": "string", "required": false, "description": "agent容器的 cpu Request", "example": "0.1" }, { "name": "AgentMemLimit", "type": "string", "required": false, "description": "agent容器的 mem Limit", "example": "200" }, { "name": "AgentCpuLimit", "type": "string", "required": false, "description": "agent容器的 cpu Limit", "example": "1" }, { "name": "UpdateType", "type": "integer", "required": false, "description": "发布策略(0表示快速更新，1表示滚动更新。默认值为0)", "example": "0" }, { "name": "UpdateIvl", "type": "integer", "required": false, "description": "更新间隔,单位秒", "example": "10" }, { "name": "MaxSurge", "type": "string", "required": false, "description": "对应更新策略和策略配置参数", "example": "25%" }, { "name": "MaxUnavailable", "type": "string", "required": false, "description": "对应更新策略和策略配置参数", "example": "0" }, { "name": "WarmupSetting", "type": "object", "required": false, "description": "预热参数配置", "example": "无", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启预热", "example": "false" }, { "name": "WarmupTime", "type": "integer", "required": false, "description": "预热时间，单位秒", "example": "120" }, { "name": "Curvature", "type": "integer", "required": false, "description": "预热曲率，取值 1~5", "example": "2" }, { "name": "EnabledProtection", "type": "boolean", "required": false, "description": "是否开启预热保护，在开启保护的情况下，超过 50% 的节点处于预热中，则会中止预热", "example": "false" } ] }, { "name": "ConfigTemplateId", "type": "string", "required": false, "description": "配置模版ID", "example": "template-id" }, { "name": "ConfigTemplateVersion", "type": "integer", "required": false, "description": "配置模版Version", "example": "0" }, { "name": "VolumeClean", "type": "boolean", "required": false, "description": "是否清除数据卷信息", "example": "false" }, { "name": "NamespaceId", "type": "string", "required": false, "description": "命名空间Id", "example": "namespace-xx" }, { "name": "DeployAgent", "type": "boolean", "required": false, "description": "是否部署agent容器", "example": "true" }, { "name": "AgentProfileList", "type": "array", "required": false, "description": "javaagent信息: SERVICE_AGENT/OT_AGENT", "example": "无", "item_type": "object", "children": [ { "name": "AgentType", "type": "string", "required": false, "description": "Agent类型", "example": "SERVICE_AGENT/OT_AGENT" }, { "name": "AgentVersion", "type": "string", "required": false, "description": "Agent版本号", "example": "release/1.0" } ] }, { "name": "ServiceClean", "type": "boolean", "required": false, "description": "是否清除Service信息", "example": "false" }, { "name": "EnvClean", "type": "boolean", "required": false, "description": "是否清除Env信息", "example": "false" }, { "name": "DeployDesc", "type": "string", "required": false, "description": "本次部署的描述信息", "example": "update image to v1" }, { "name": "K8sNamespaceName", "type": "string", "required": false, "description": "k8s命名空间名称", "example": "consumer" }, { "name": "StaticIpEnabled", "type": "boolean", "required": false, "description": "是否启用静态IP", "example": "false" }, { "name": "PodManagementPolicyType", "type": "string", "required": false, "description": "启动策略[OrderedReady/Parallel]", "example": "OrderedReady" }, { "name": "Partition", "type": "integer", "required": false, "description": "滚动更新分区序号", "example": "0" }, { "name": "IncrementalDeployment", "type": "boolean", "required": false, "description": "是否是增量部署，增量部署只运行增量覆盖一级参数，不支持对一级参数中的子参数进行增量更新，例如更新VolumeMountInfoList时必须传入VolumeMountInfoList更新后的全量参数", "example": "false" } ], "required": [ "ApplicationId" ] }, { "name": "DeployContainerGroup", "description": "部署容器应用-更新", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "部署组ID，可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/api/649/36068)查询已创建的部署组列表或登录控制台进行查看；也可以调用[CreateContainGroup](https://cloud.tencent.com/document/api/649/36075)创建新的部署组。", "example": "group-6a79x94v" }, { "name": "TagName", "type": "string", "required": true, "description": "镜像版本名称,如v1", "example": "v1" }, { "name": "InstanceNum", "type": "integer", "required": true, "description": "实例数量", "example": "1" }, { "name": "Server", "type": "string", "required": false, "description": "镜像server", "example": "ccr.ccs.tencentyun.com" }, { "name": "CpuLimit", "type": "string", "required": false, "description": "业务容器最大的 CPU 核数，对应 K8S 的 limit；不填时默认为 request 的 2 倍", "example": "2" }, { "name": "MemLimit", "type": "string", "required": false, "description": "业务容器最大的内存 MiB 数，对应 K8S 的 limit；不填时默认为 request 的 2 倍", "example": "512" }, { "name": "JvmOpts", "type": "string", "required": false, "description": "jvm参数", "example": "-Xms512m -Xmx1048m" }, { "name": "CpuRequest", "type": "string", "required": false, "description": "业务容器分配的 CPU 核数，对应 K8S 的 request，默认0.25", "example": "0.54" }, { "name": "MemRequest", "type": "string", "required": false, "description": "业务容器分配的内存 MiB 数，对应 K8S 的 request，默认640 MiB", "example": "1024" }, { "name": "DoNotStart", "type": "boolean", "required": false, "description": "是否不立即启动", "example": "false" }, { "name": "RepoName", "type": "string", "required": false, "description": "（优先使用）新版镜像名，如/tsf/nginx", "example": "tsf_10000617xxxx/test" }, { "name": "UpdateType", "type": "integer", "required": false, "description": "更新方式：0:快速更新 1:滚动更新", "example": "1" }, { "name": "UpdateIvl", "type": "integer", "required": false, "description": "滚动更新必填，更新间隔", "example": "10" }, { "name": "AgentCpuRequest", "type": "string", "required": false, "description": "agent 容器分配的 CPU 核数，对应 K8S 的 request", "example": "0.1" }, { "name": "AgentCpuLimit", "type": "string", "required": false, "description": "agent 容器最大的 CPU 核数，对应 K8S 的 limit", "example": "0.2" }, { "name": "AgentMemRequest", "type": "string", "required": false, "description": "agent 容器分配的内存 MiB 数，对应 K8S 的 request", "example": "32" }, { "name": "AgentMemLimit", "type": "string", "required": false, "description": "agent 容器最大的内存 MiB 数，对应 K8S 的 limit", "example": "128" }, { "name": "IstioCpuRequest", "type": "string", "required": false, "description": "istioproxy 容器分配的 CPU 核数，对应 K8S 的 request", "example": "0.1" }, { "name": "IstioCpuLimit", "type": "string", "required": false, "description": "istioproxy 容器最大的 CPU 核数，对应 K8S 的 limit", "example": "0.2" }, { "name": "IstioMemRequest", "type": "string", "required": false, "description": "istioproxy 容器分配的内存 MiB 数，对应 K8S 的 request", "example": "32" }, { "name": "IstioMemLimit", "type": "string", "required": false, "description": "istioproxy 容器最大的内存 MiB 数，对应 K8S 的 limit", "example": "128" }, { "name": "MaxSurge", "type": "string", "required": false, "description": "kubernetes滚动更新策略的MaxSurge参数", "example": "25%" }, { "name": "MaxUnavailable", "type": "string", "required": false, "description": "kubernetes滚动更新策略的MaxUnavailable参数", "example": "50%" }, { "name": "HealthCheckSettings", "type": "object", "required": false, "description": "健康检查配置信息，若不指定该参数，则默认不设置健康检查。", "example": "无", "children": [ { "name": "LivenessProbe", "type": "object", "required": false, "description": "存活健康检查 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "ActionType", "type": "string", "required": true, "description": "健康检查方法。HTTP：通过 HTTP 接口检查；CMD：通过执行命令检查；TCP：通过建立 TCP 连接检查。 注意：此字段可能返回 null，表示取不到有效值。", "example": "HTTP" }, { "name": "InitialDelaySeconds", "type": "integer", "required": false, "description": "容器延时启动健康检查的时间，单位秒。 注意：此字段可能返回 null，表示取不到有效值。", "example": "180" }, { "name": "TimeoutSeconds", "type": "integer", "required": false, "description": "每次健康检查响应的最大超时时间，单位秒。 注意：此字段可能返回 null，表示取不到有效值。", "example": "30" }, { "name": "PeriodSeconds", "type": "integer", "required": false, "description": "进行健康检查的时间间隔，单位秒。 注意：此字段可能返回 null，表示取不到有效值。", "example": "30" }, { "name": "SuccessThreshold", "type": "integer", "required": false, "description": "表示后端容器从失败到成功的连续健康检查成功次数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "FailureThreshold", "type": "integer", "required": false, "description": "表示后端容器从成功到失败的连续健康检查成功次数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "3" }, { "name": "Scheme", "type": "string", "required": false, "description": "HTTP 健康检查方法使用的检查协议。支持HTTP、HTTPS。 注意：此字段可能返回 null，表示取不到有效值。", "example": "HTTP" }, { "name": "Port", "type": "integer", "required": false, "description": "健康检查端口，范围 1~65535 。 注意：此字段可能返回 null，表示取不到有效值。", "example": "8080" }, { "name": "Path", "type": "string", "required": false, "description": "HTTP 健康检查接口的请求路径。 注意：此字段可能返回 null，表示取不到有效值。", "example": "/health" }, { "name": "Command", "type": "array", "required": false, "description": "执行命令检查方式，执行的命令。 注意：此字段可能返回 null，表示取不到有效值。", "example": "sh health.sh", "item_type": "string" }, { "name": "Type", "type": "string", "required": false, "description": "TSF_DEFAULT：tsf 默认就绪探针。K8S_NATIVE：k8s 原生探针。不填默认为 k8s 原生探针。 注意：此字段可能返回 null，表示取不到有效值。", "example": "K8S_NATIVE" } ] }, { "name": "ReadinessProbe", "type": "object", "required": false, "description": "就绪健康检查 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "ActionType", "type": "string", "required": true, "description": "健康检查方法。HTTP：通过 HTTP 接口检查；CMD：通过执行命令检查；TCP：通过建立 TCP 连接检查。 注意：此字段可能返回 null，表示取不到有效值。", "example": "HTTP" }, { "name": "InitialDelaySeconds", "type": "integer", "required": false, "description": "容器延时启动健康检查的时间，单位秒。 注意：此字段可能返回 null，表示取不到有效值。", "example": "180" }, { "name": "TimeoutSeconds", "type": "integer", "required": false, "description": "每次健康检查响应的最大超时时间，单位秒。 注意：此字段可能返回 null，表示取不到有效值。", "example": "30" }, { "name": "PeriodSeconds", "type": "integer", "required": false, "description": "进行健康检查的时间间隔，单位秒。 注意：此字段可能返回 null，表示取不到有效值。", "example": "30" }, { "name": "SuccessThreshold", "type": "integer", "required": false, "description": "表示后端容器从失败到成功的连续健康检查成功次数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "FailureThreshold", "type": "integer", "required": false, "description": "表示后端容器从成功到失败的连续健康检查成功次数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "3" }, { "name": "Scheme", "type": "string", "required": false, "description": "HTTP 健康检查方法使用的检查协议。支持HTTP、HTTPS。 注意：此字段可能返回 null，表示取不到有效值。", "example": "HTTP" }, { "name": "Port", "type": "integer", "required": false, "description": "健康检查端口，范围 1~65535 。 注意：此字段可能返回 null，表示取不到有效值。", "example": "8080" }, { "name": "Path", "type": "string", "required": false, "description": "HTTP 健康检查接口的请求路径。 注意：此字段可能返回 null，表示取不到有效值。", "example": "/health" }, { "name": "Command", "type": "array", "required": false, "description": "执行命令检查方式，执行的命令。 注意：此字段可能返回 null，表示取不到有效值。", "example": "sh health.sh", "item_type": "string" }, { "name": "Type", "type": "string", "required": false, "description": "TSF_DEFAULT：tsf 默认就绪探针。K8S_NATIVE：k8s 原生探针。不填默认为 k8s 原生探针。 注意：此字段可能返回 null，表示取不到有效值。", "example": "K8S_NATIVE" } ] } ] }, { "name": "Envs", "type": "array", "required": false, "description": "部署组应用运行的环境变量。若不指定该参数，则默认不设置额外的环境变量。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "环境变量名称", "example": "foo" }, { "name": "Value", "type": "string", "required": false, "description": "环境变量值", "example": "bar" }, { "name": "ValueFrom", "type": "object", "required": false, "description": "k8s ValueFrom 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "FieldRef", "type": "object", "required": false, "description": "k8s env 的 FieldRef", "example": "无", "children": [ { "name": "FieldPath", "type": "string", "required": false, "description": "k8s 的 FieldPath", "example": "metadata.name" } ] }, { "name": "ResourceFieldRef", "type": "object", "required": false, "description": "k8s env 的 ResourceFieldRef 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Resource", "type": "string", "required": false, "description": "k8s 的 Resource", "example": "limits.cpu" } ] }, { "name": "ConfigMapKeyRef", "type": "object", "required": false, "description": "k8s env的configMapKeyRef", "example": "无", "children": [ { "name": "Name", "type": "string", "required": false, "description": "名称", "example": "name-mock" }, { "name": "Key", "type": "string", "required": false, "description": "Key值", "example": "key-mock" } ] }, { "name": "SecretKeyRef", "type": "object", "required": false, "description": "k8s env 的 secretKeyRef", "example": "无", "children": [ { "name": "Name", "type": "string", "required": false, "description": "名称", "example": "name-mock" }, { "name": "Key", "type": "string", "required": false, "description": "Key值", "example": "key-mock" } ] } ] } ] }, { "name": "ServiceSetting", "type": "object", "required": false, "description": "容器部署组的网络设置。", "example": "无", "children": [ { "name": "AccessType", "type": "integer", "required": true, "description": "0:公网, 1:集群内访问, 2：NodePort, 3: VPC 内网访问", "example": "2" }, { "name": "ProtocolPorts", "type": "array", "required": true, "description": "容器端口映射", "example": "无", "item_type": "object", "children": [ { "name": "Protocol", "type": "string", "required": true, "description": "TCP UDP", "example": "TCP" }, { "name": "Port", "type": "integer", "required": true, "description": "服务端口", "example": "8080" }, { "name": "TargetPort", "type": "integer", "required": true, "description": "容器端口", "example": "8080" }, { "name": "NodePort", "type": "integer", "required": false, "description": "主机端口", "example": "30090" }, { "name": "Name", "type": "string", "required": false, "description": "端口名称", "example": "port-0" } ] }, { "name": "SubnetId", "type": "string", "required": false, "description": "子网ID", "example": "subnet-d15zonly" }, { "name": "DisableService", "type": "boolean", "required": false, "description": "是否创建 k8s service，默认为 false", "example": "false" }, { "name": "HeadlessService", "type": "boolean", "required": false, "description": "service 是否为 headless 类型", "example": "false" }, { "name": "AllowDeleteService", "type": "boolean", "required": false, "description": "当为 true 且 DisableService 也为 true 时，会删除之前创建的 service，请小心使用", "example": "false" }, { "name": "OpenSessionAffinity", "type": "boolean", "required": false, "description": "开启SessionAffinity，true为开启，false为不开启，默认为false", "example": "false" }, { "name": "SessionAffinityTimeoutSeconds", "type": "integer", "required": false, "description": "SessionAffinity会话时间，默认10800", "example": "10800" }, { "name": "ServiceName", "type": "string", "required": false, "description": "服务名称", "example": "svc-name" }, { "name": "ExternalTrafficStrategy", "type": "string", "required": false, "description": "外部流量策略", "example": "Local" }, { "name": "ExternalTrafficPolicy", "type": "string", "required": false, "description": "外部流量策略", "example": "Local" }, { "name": "LoadBalancerProvisioner", "type": "string", "required": false, "description": "负载均衡提供者", "example": "tgw" }, { "name": "LoadBalancingType", "type": "string", "required": false, "description": "负载均衡类型，Intranet表示内网，Internet表示外网", "example": "Intranet" }, { "name": "ClusterIp", "type": "string", "required": false, "description": "k8s负载均衡内网vip", "example": "192.168.21.2" }, { "name": "DisableServiceInt", "type": "integer", "required": false, "description": "禁用服务Int记录", "example": "0" }, { "name": "OpenSessionAffinityInt", "type": "integer", "required": false, "description": "开启SessionAffinity Int记录", "example": "0" }, { "name": "HeadlessServiceInt", "type": "integer", "required": false, "description": "开启HeadlessService int记录", "example": "0" }, { "name": "Name", "type": "string", "required": false, "description": "服务名称", "example": "svc-name" }, { "name": "VpcId", "type": "string", "required": false, "description": "VPC网络ID", "example": "vpcid" }, { "name": "LoadBalancingIp", "type": "string", "required": false, "description": "负载均衡VIP", "example": "loadbalanceIp" }, { "name": "LoadBalancerId", "type": "string", "required": false, "description": "负载均衡id", "example": "loadbalanceId" }, { "name": "ExistingLoadBalancerId", "type": "string", "required": false, "description": "已存在的负载均衡id", "example": "existingLoadbalancerId" } ] }, { "name": "DeployAgent", "type": "boolean", "required": false, "description": "是否部署 agent 容器。若不指定该参数，则默认不部署 agent 容器。", "example": "true" }, { "name": "SchedulingStrategy", "type": "object", "required": false, "description": "节点调度策略。若不指定该参数，则默认不使用节点调度策略。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": false, "description": "NONE：不使用调度策略；CROSS_AZ：跨可用区部署", "example": "NONE" }, { "name": "NodeScheduleStrategyType", "type": "string", "required": false, "description": "-", "example": "NoSchedule" }, { "name": "NodeScheduleOptions", "type": "array", "required": false, "description": "-", "example": "无", "item_type": "object", "children": [ { "name": "LabelName", "type": "string", "required": false, "description": "-", "example": "GroupId" }, { "name": "Operator", "type": "string", "required": false, "description": "-", "example": "eqauls" }, { "name": "LabelValue", "type": "string", "required": false, "description": "-", "example": "group-6a79x94v" } ] }, { "name": "StrongAffinityList", "type": "array", "required": false, "description": "-", "example": "无", "item_type": "object", "children": [ { "name": "LabelName", "type": "string", "required": false, "description": "-", "example": "GroupId" }, { "name": "Operator", "type": "string", "required": false, "description": "-", "example": "eqauls" }, { "name": "LabelValue", "type": "string", "required": false, "description": "-", "example": "group-6a79x94v" } ] }, { "name": "WeakAffinityList", "type": "array", "required": false, "description": "-", "example": "无", "item_type": "object", "children": [ { "name": "LabelName", "type": "string", "required": false, "description": "-", "example": "GroupId" }, { "name": "Operator", "type": "string", "required": false, "description": "-", "example": "eqauls" }, { "name": "LabelValue", "type": "string", "required": false, "description": "-", "example": "group-6a79x94v" } ] }, { "name": "WeakAffinityWeight", "type": "integer", "required": false, "description": "-", "example": "50" }, { "name": "AvailableZoneScatterScheduleType", "type": "string", "required": false, "description": "-", "example": "podAntiAffinity" }, { "name": "AvailableZoneScatterScheduleRules", "type": "array", "required": false, "description": "-", "example": "无", "item_type": "object", "children": [ { "name": "ScatterDimension", "type": "string", "required": false, "description": "-", "example": "Application" }, { "name": "MaxUnbalanceQuantity", "type": "integer", "required": false, "description": "-", "example": "25" }, { "name": "IsForceSchedule", "type": "boolean", "required": false, "description": "-", "example": "true" }, { "name": "Paths", "type": "array", "required": false, "description": "-", "example": "无", "item_type": "object", "children": [ { "name": "LabelName", "type": "string", "required": false, "description": "-", "example": "GroupId" }, { "name": "Operator", "type": "string", "required": false, "description": "-", "example": "eqauls" }, { "name": "LabelValue", "type": "string", "required": false, "description": "-", "example": "group-6a79x94v" } ] } ] }, { "name": "PodScheduleStrategyType", "type": "string", "required": false, "description": "-", "example": "podAntiAffinity" }, { "name": "CustomPodSchedule", "type": "object", "required": false, "description": "-", "example": "无", "children": [ { "name": "ForceSchedule", "type": "object", "required": false, "description": "-", "example": "无", "children": [ { "name": "AffinityList", "type": "array", "required": false, "description": "-", "example": "无", "item_type": "string" }, { "name": "AntiAffinityList", "type": "array", "required": false, "description": "-", "example": "无", "item_type": "string" } ] }, { "name": "TrySchedule", "type": "object", "required": false, "description": "-", "example": "无", "children": [ { "name": "AffinityList", "type": "array", "required": false, "description": "-", "example": "无", "item_type": "string" }, { "name": "AntiAffinityList", "type": "array", "required": false, "description": "-", "example": "无", "item_type": "string" } ] } ] }, { "name": "TolerateScheduleType", "type": "string", "required": false, "description": "-", "example": "NoSchedule" }, { "name": "CustomTolerateSchedules", "type": "array", "required": false, "description": "-", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "-", "example": "host" }, { "name": "Operator", "type": "string", "required": false, "description": "-", "example": "equlas" }, { "name": "Value", "type": "string", "required": false, "description": "-", "example": "hostName" }, { "name": "Effect", "type": "string", "required": false, "description": "-", "example": "effect" }, { "name": "TolerationSeconds", "type": "integer", "required": false, "description": "-", "example": "30" } ] } ] }, { "name": "IncrementalDeployment", "type": "boolean", "required": false, "description": "是否进行增量部署，默认为false，全量更新", "example": "false" }, { "name": "RepoType", "type": "string", "required": false, "description": "tcr或者不填", "example": "personal" }, { "name": "VolumeInfoList", "type": "array", "required": false, "description": "数据卷信息，list", "example": "无", "item_type": "object", "children": [ { "name": "VolumeType", "type": "string", "required": true, "description": "数据卷类型", "example": "emptyDir" }, { "name": "VolumeName", "type": "string", "required": true, "description": "数据卷名称", "example": "config-path" }, { "name": "VolumeConfig", "type": "string", "required": false, "description": "数据卷配置", "example": "/host" }, { "name": "ConfigMapOptions", "type": "array", "required": false, "description": "-", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "-", "example": "key-mock" }, { "name": "Path", "type": "string", "required": false, "description": "-", "example": "/config" }, { "name": "Mode", "type": "string", "required": false, "description": "-", "example": "hostPath" } ] }, { "name": "EmptyDirOption", "type": "object", "required": false, "description": "-", "example": "无", "children": [ { "name": "EnableMemory", "type": "boolean", "required": false, "description": "-", "example": "false" }, { "name": "StorageCapacity", "type": "integer", "required": false, "description": "-", "example": "64" }, { "name": "StorageUnit", "type": "string", "required": false, "description": "-", "example": "12" }, { "name": "SizeLimit", "type": "string", "required": false, "description": "-", "example": "32" } ] }, { "name": "VolumeClaimTemplateOption", "type": "object", "required": false, "description": "数据卷PVC声明模板", "example": "无", "children": [ { "name": "StorageClass", "type": "string", "required": false, "description": "StorageClass名称", "example": "cbs" }, { "name": "AccessModes", "type": "array", "required": false, "description": "访问模式", "example": "ReadWriteOnce", "item_type": "string" }, { "name": "StorageRequest", "type": "integer", "required": false, "description": "卷空间的预占声明", "example": "20" } ] } ] }, { "name": "VolumeMountInfoList", "type": "array", "required": false, "description": "数据卷挂载点信息，list", "example": "无", "item_type": "object", "children": [ { "name": "VolumeMountName", "type": "string", "required": true, "description": "挂载数据卷名称", "example": "config-name" }, { "name": "VolumeMountPath", "type": "string", "required": true, "description": "挂载路径", "example": "/host" }, { "name": "VolumeMountSubPath", "type": "string", "required": false, "description": "挂载子路径", "example": "/tsf" }, { "name": "ReadOrWrite", "type": "string", "required": false, "description": "读写，1：读 2：读写", "example": "2" } ] }, { "name": "VolumeClean", "type": "boolean", "required": false, "description": "是否清除数据卷信息，默认false", "example": "false" }, { "name": "AgentProfileList", "type": "array", "required": false, "description": "javaagent信息: SERVICE_AGENT/OT_AGENT", "example": "无", "item_type": "object", "children": [ { "name": "AgentType", "type": "string", "required": false, "description": "Agent类型", "example": "SERVICE_AGENT/OT_AGENT" }, { "name": "AgentVersion", "type": "string", "required": false, "description": "Agent版本号", "example": "release/1.0" } ] }, { "name": "WarmupSetting", "type": "object", "required": false, "description": "预热配置信息", "example": "无", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启预热", "example": "false" }, { "name": "WarmupTime", "type": "integer", "required": false, "description": "预热时间，单位秒", "example": "120" }, { "name": "Curvature", "type": "integer", "required": false, "description": "预热曲率，取值 1~5", "example": "2" }, { "name": "EnabledProtection", "type": "boolean", "required": false, "description": "是否开启预热保护，在开启保护的情况下，超过 50% 的节点处于预热中，则会中止预热", "example": "false" } ] } ], "required": [ "GroupId", "TagName", "InstanceNum" ] }, { "name": "DeployGroup", "description": "部署虚拟机部署组应用", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "部署组ID，可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/api/649/36068)查询已创建的部署组列表或登录控制台进行查看；也可以调用[CreateContainGroup](https://cloud.tencent.com/document/api/649/36075)创建新的部署组。", "example": "group-6a79x94v" }, { "name": "PkgId", "type": "string", "required": true, "description": "软件包ID，可通过调用DescribeUploadInfo接口时[获取上传程序包信息](https://cloud.tencent.com/document/api/649/36078)返回的COS上传信息获取，登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看", "example": "pkg-6a79x94v" }, { "name": "StartupParameters", "type": "string", "required": false, "description": "部署组启动参数", "example": "-Xms512m -Xmx1024m" }, { "name": "DeployDesc", "type": "string", "required": false, "description": "部署应用描述信息", "example": "应用描述信息" }, { "name": "ForceStart", "type": "boolean", "required": false, "description": "是否允许强制启动", "example": "false" }, { "name": "EnableHealthCheck", "type": "boolean", "required": false, "description": "是否开启健康检查", "example": "true" }, { "name": "HealthCheckSettings", "type": "object", "required": false, "description": "开启健康检查时，配置健康检查", "example": "无", "children": [ { "name": "LivenessProbe", "type": "object", "required": false, "description": "存活健康检查 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "ActionType", "type": "string", "required": true, "description": "健康检查方法。HTTP：通过 HTTP 接口检查；CMD：通过执行命令检查；TCP：通过建立 TCP 连接检查。 注意：此字段可能返回 null，表示取不到有效值。", "example": "HTTP" }, { "name": "InitialDelaySeconds", "type": "integer", "required": false, "description": "容器延时启动健康检查的时间，单位秒。 注意：此字段可能返回 null，表示取不到有效值。", "example": "180" }, { "name": "TimeoutSeconds", "type": "integer", "required": false, "description": "每次健康检查响应的最大超时时间，单位秒。 注意：此字段可能返回 null，表示取不到有效值。", "example": "30" }, { "name": "PeriodSeconds", "type": "integer", "required": false, "description": "进行健康检查的时间间隔，单位秒。 注意：此字段可能返回 null，表示取不到有效值。", "example": "30" }, { "name": "SuccessThreshold", "type": "integer", "required": false, "description": "表示后端容器从失败到成功的连续健康检查成功次数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "FailureThreshold", "type": "integer", "required": false, "description": "表示后端容器从成功到失败的连续健康检查成功次数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "3" }, { "name": "Scheme", "type": "string", "required": false, "description": "HTTP 健康检查方法使用的检查协议。支持HTTP、HTTPS。 注意：此字段可能返回 null，表示取不到有效值。", "example": "HTTP" }, { "name": "Port", "type": "integer", "required": false, "description": "健康检查端口，范围 1~65535 。 注意：此字段可能返回 null，表示取不到有效值。", "example": "8080" }, { "name": "Path", "type": "string", "required": false, "description": "HTTP 健康检查接口的请求路径。 注意：此字段可能返回 null，表示取不到有效值。", "example": "/health" }, { "name": "Command", "type": "array", "required": false, "description": "执行命令检查方式，执行的命令。 注意：此字段可能返回 null，表示取不到有效值。", "example": "sh health.sh", "item_type": "string" }, { "name": "Type", "type": "string", "required": false, "description": "TSF_DEFAULT：tsf 默认就绪探针。K8S_NATIVE：k8s 原生探针。不填默认为 k8s 原生探针。 注意：此字段可能返回 null，表示取不到有效值。", "example": "K8S_NATIVE" } ] }, { "name": "ReadinessProbe", "type": "object", "required": false, "description": "就绪健康检查 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "ActionType", "type": "string", "required": true, "description": "健康检查方法。HTTP：通过 HTTP 接口检查；CMD：通过执行命令检查；TCP：通过建立 TCP 连接检查。 注意：此字段可能返回 null，表示取不到有效值。", "example": "HTTP" }, { "name": "InitialDelaySeconds", "type": "integer", "required": false, "description": "容器延时启动健康检查的时间，单位秒。 注意：此字段可能返回 null，表示取不到有效值。", "example": "180" }, { "name": "TimeoutSeconds", "type": "integer", "required": false, "description": "每次健康检查响应的最大超时时间，单位秒。 注意：此字段可能返回 null，表示取不到有效值。", "example": "30" }, { "name": "PeriodSeconds", "type": "integer", "required": false, "description": "进行健康检查的时间间隔，单位秒。 注意：此字段可能返回 null，表示取不到有效值。", "example": "30" }, { "name": "SuccessThreshold", "type": "integer", "required": false, "description": "表示后端容器从失败到成功的连续健康检查成功次数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "FailureThreshold", "type": "integer", "required": false, "description": "表示后端容器从成功到失败的连续健康检查成功次数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "3" }, { "name": "Scheme", "type": "string", "required": false, "description": "HTTP 健康检查方法使用的检查协议。支持HTTP、HTTPS。 注意：此字段可能返回 null，表示取不到有效值。", "example": "HTTP" }, { "name": "Port", "type": "integer", "required": false, "description": "健康检查端口，范围 1~65535 。 注意：此字段可能返回 null，表示取不到有效值。", "example": "8080" }, { "name": "Path", "type": "string", "required": false, "description": "HTTP 健康检查接口的请求路径。 注意：此字段可能返回 null，表示取不到有效值。", "example": "/health" }, { "name": "Command", "type": "array", "required": false, "description": "执行命令检查方式，执行的命令。 注意：此字段可能返回 null，表示取不到有效值。", "example": "sh health.sh", "item_type": "string" }, { "name": "Type", "type": "string", "required": false, "description": "TSF_DEFAULT：tsf 默认就绪探针。K8S_NATIVE：k8s 原生探针。不填默认为 k8s 原生探针。 注意：此字段可能返回 null，表示取不到有效值。", "example": "K8S_NATIVE" } ] } ] }, { "name": "UpdateType", "type": "integer", "required": false, "description": "部署方式，0表示快速更新，1表示滚动更新", "example": "1" }, { "name": "DeployBetaEnable", "type": "boolean", "required": false, "description": "是否启用beta批次", "example": "true" }, { "name": "DeployBatch", "type": "array", "required": false, "description": "滚动发布每个批次参与的实例比率", "example": "[0.25]", "item_type": "float" }, { "name": "DeployExeMode", "type": "string", "required": false, "description": "滚动发布的执行方式，auto表示自动， manual表示手动", "example": "auto" }, { "name": "DeployWaitTime", "type": "integer", "required": false, "description": "滚动发布每个批次的时间间隔，单位min。默认值是0，不等待。", "example": "30" }, { "name": "StartScript", "type": "string", "required": false, "description": "启动脚本 base64编码", "example": "mock-script-base64" }, { "name": "StopScript", "type": "string", "required": false, "description": "停止脚本 base64编码", "example": "mock-script-base64" }, { "name": "IncrementalDeployment", "type": "boolean", "required": false, "description": "是否进行增量部署，默认为false，全量更新", "example": "false" }, { "name": "JdkName", "type": "string", "required": false, "description": "JDK名称: konaJDK或openJDK", "example": "konaJDK" }, { "name": "JdkVersion", "type": "string", "required": false, "description": "konaJDK版本：8、11和17 openJDK版本：8、17", "example": "8" }, { "name": "AgentProfileList", "type": "array", "required": false, "description": "部署agent的类型、版本", "example": "无", "item_type": "object", "children": [ { "name": "AgentType", "type": "string", "required": false, "description": "Agent类型", "example": "SERVICE_AGENT/OT_AGENT" }, { "name": "AgentVersion", "type": "string", "required": false, "description": "Agent版本号", "example": "release/1.0" } ] }, { "name": "WarmupSetting", "type": "object", "required": false, "description": "预热参数配置", "example": "无", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启预热", "example": "false" }, { "name": "WarmupTime", "type": "integer", "required": false, "description": "预热时间，单位秒", "example": "120" }, { "name": "Curvature", "type": "integer", "required": false, "description": "预热曲率，取值 1~5", "example": "2" }, { "name": "EnabledProtection", "type": "boolean", "required": false, "description": "是否开启预热保护，在开启保护的情况下，超过 50% 的节点处于预热中，则会中止预热", "example": "false" } ] }, { "name": "EnableBatchHealthCheck", "type": "boolean", "required": false, "description": "开启分批健康检查", "example": "true" } ], "required": [ "GroupId", "PkgId" ] }, { "name": "DescribeApiDetail", "description": "查询API详情", "status": "online", "parameters": [ { "name": "MicroserviceId", "type": "string", "required": true, "description": "微服务ID。该参数可以通过调用 [DescribeMicroservices](https://cloud.tencent.com/document/product/649/36084) 的返回值中的 MicroserviceId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?tab=service)查看；也可以调用[CreateMicroserviceWithDetailResp](https://cloud.tencent.com/document/product/649/85860)创建新的微服务。", "example": "ms-y5w8n5e9" }, { "name": "Path", "type": "string", "required": true, "description": "请求路径。", "example": "/user-feign" }, { "name": "Method", "type": "string", "required": true, "description": "请求方法。 - GET - POST - PUT - DELETE - HEAD - PATCH - OPTIONS", "example": "GET" }, { "name": "PkgVersion", "type": "string", "required": true, "description": "应用包版本号。", "example": "20210625192924" }, { "name": "ApplicationId", "type": "string", "required": true, "description": "应用ID。该参数可以通过调用 [DescribeApplications](https://cloud.tencent.com/document/product/649/36090) 的返回值中的 ApplicationId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/app)查看；也可以调用[CreateApplication](https://cloud.tencent.com/document/product/649/36094)创建新的应用。", "example": "application-yn3zdj9v" } ], "required": [ "MicroserviceId", "Path", "Method", "PkgVersion", "ApplicationId" ] }, { "name": "DescribeApiGroup", "description": "查询API分组", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "API 分组ID", "example": "grp-e42d597" } ], "required": [ "GroupId" ] }, { "name": "DescribeApiGroups", "description": "查询API 分组信息列表", "status": "online", "parameters": [ { "name": "SearchWord", "type": "string", "required": false, "description": "搜索关键字", "example": "group_name" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页条数，默认为20", "example": "20" }, { "name": "GroupType", "type": "string", "required": false, "description": "分组类型。 ms： 微服务分组； external:外部Api分组", "example": "ms" }, { "name": "AuthType", "type": "string", "required": false, "description": "鉴权类型。 secret： 密钥鉴权； none:无鉴权", "example": "none" }, { "name": "Status", "type": "string", "required": false, "description": "发布状态, drafted: 未发布。 released: 发布", "example": "released" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序字段：\"created_time\"或\"group_context\"", "example": "created_time" }, { "name": "OrderType", "type": "integer", "required": false, "description": "排序类型：0(ASC)或1(DESC)", "example": "1" }, { "name": "GatewayInstanceId", "type": "string", "required": false, "description": "网关实体ID", "example": "gw-ins-szesmg28" } ], "required": [] }, { "name": "DescribeApiRateLimitRules", "description": "查询API限流规则", "status": "online", "parameters": [ { "name": "ApiId", "type": "string", "required": true, "description": "Api ID", "example": "api-9jw9mzhu" } ], "required": [ "ApiId" ] }, { "name": "DescribeApiUseDetail", "description": "查询网关API监控明细数据", "status": "online", "parameters": [ { "name": "GatewayDeployGroupId", "type": "string", "required": true, "description": "网关部署组ID", "example": "group-yo476mrv" }, { "name": "ApiId", "type": "string", "required": true, "description": "网关分组Api ID", "example": "api-megi25v8" }, { "name": "StartTime", "type": "string", "required": true, "description": "查询的日期,格式：yyyy-MM-dd HH:mm:ss", "example": "2024-12-16 14:52:28" }, { "name": "EndTime", "type": "string", "required": true, "description": "查询的日期,格式：yyyy-MM-dd HH:mm:ss", "example": "2024-12-23 14:52:28" } ], "required": [ "GatewayDeployGroupId", "ApiId", "StartTime", "EndTime" ] }, { "name": "DescribeApiVersions", "description": "查询API版本", "status": "online", "parameters": [ { "name": "MicroserviceId", "type": "string", "required": true, "description": "微服务ID。该参数可以通过调用 [DescribeMicroservices](https://cloud.tencent.com/document/product/649/36084) 的返回值中的 MicroserviceId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?tab=service)查看；也可以调用[CreateMicroserviceWithDetailResp](https://cloud.tencent.com/document/product/649/85860)创建新的微服务。", "example": "ms-vk2wqlnv" }, { "name": "Path", "type": "string", "required": false, "description": "API请求路径。", "example": "/hello" }, { "name": "Method", "type": "string", "required": false, "description": "API请求方法。 - GET - POST - PUT - DELETE - HEAD - PATCH - OPTIONS", "example": "GET" } ], "required": [ "MicroserviceId" ] }, { "name": "DescribeApplication", "description": "获取应用详情", "status": "online", "parameters": [ { "name": "ApplicationId", "type": "string", "required": true, "description": "应用ID，可通过调用[DescribeApplications](https://cloud.tencent.com/document/api/649/36090)查询已创建的应用列表或登录控制台进行查看；也可以调用[CreateApplication](https://cloud.tencent.com/document/api/649/36094)创建新的应用。", "example": "application-6a79x94v" } ], "required": [ "ApplicationId" ] }, { "name": "DescribeApplicationAttribute", "description": "获取应用列表其它字段，如实例数量信息等", "status": "online", "parameters": [ { "name": "ApplicationId", "type": "string", "required": true, "description": "【应用ID】，可通过调用[DescribeApplications](https://cloud.tencent.com/document/product/649/36090)查询已创建的应用列表或登录[控制台](https://console.cloud.tencent.com/tsf/app?rid=1)进行查看；也可以调用[CreateApplication](https://cloud.tencent.com/document/product/649/36094)创建新的应用。", "example": "application-6a79x94v" } ], "required": [ "ApplicationId" ] }, { "name": "DescribeApplications", "description": "获取应用列表", "status": "online", "parameters": [ { "name": "SearchWord", "type": "string", "required": false, "description": "搜索字段", "example": "application name" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序字段", "example": "ClusterId" }, { "name": "OrderType", "type": "integer", "required": false, "description": "指定排序类型，目前支持： `0`：降序 `1`：升序", "example": "0" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。关于Offset详见[API简介](https://cloud.tencent.com/document/api/213/568#.E8.BE.93.E5.85.A5.E5.8F.82.E6.95.B0.E4.B8.8E.E8.BF.94.E5.9B.9E.E5.8F.82.E6.95.B0.E9.87.8A.E4.B9.89)", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "数量限制，默认为20，最大值为100。关于Limit详见[API简介](https://cloud.tencent.com/document/api/213/568#.E8.BE.93.E5.85.A5.E5.8F.82.E6.95.B0.E4.B8.8E.E8.BF.94.E5.9B.9E.E5.8F.82.E6.95.B0.E9.87.8A.E4.B9.89)", "example": "50" }, { "name": "ApplicationType", "type": "string", "required": false, "description": "指定应用类型，目前支持： - `V`：普通应用/CVM应用 - `C`：容器应用 - `S`：serverless 应用", "example": "V" }, { "name": "MicroserviceType", "type": "string", "required": false, "description": "应用的微服务类型", "example": "N" }, { "name": "ApplicationResourceTypeList", "type": "array", "required": false, "description": "应用资源类型列表；DEF 表示默认资源类型；GW 表示网关资源类型", "example": "[\"GW\"]", "item_type": "string" }, { "name": "ApplicationIdList", "type": "array", "required": false, "description": "IdList", "example": "[\"application-6a79x94v\"]", "item_type": "string" }, { "name": "MicroserviceTypeList", "type": "array", "required": false, "description": "查询多种微服务类型的应用", "example": "[\"N\"]", "item_type": "string" } ], "required": [] }, { "name": "DescribeBasicResourceUsage", "description": "TSF基本资源信息概览接口", "status": "online", "parameters": [ { "name": "All", "type": "boolean", "required": false, "description": "是否拥有权限查询全租户的，默认 true。注：无论 true 还是 false，PackageSpaceUsed 和 ConsulInstanceCount 都是全租户的", "example": "true" } ], "required": [] }, { "name": "DescribeBusinessLogConfig", "description": "查询业务日志配置项信息", "status": "online", "parameters": [ { "name": "ConfigId", "type": "string", "required": true, "description": "日志配置项ID 可通过调用[DescribeBusinessLogConfigs](https://cloud.tencent.com/document/product/649/75777)查询已创建的日志配置项列表或登录[控制台](https://console.cloud.tencent.com/tsf/observable/log?rid=1)进行查看", "example": "apm-busi-log-cfg-qabp49vl" } ], "required": [ "ConfigId" ] }, { "name": "DescribeBusinessLogConfigs", "description": "查询日志配置项列表", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，取值范围大于等于0，默认值为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "单页请求配置数量，取值范围[1, 50]，默认值为10", "example": "50" }, { "name": "SearchWord", "type": "string", "required": false, "description": "模糊匹配关键词，可搜索配置项ID或配置项名称", "example": "config-name" }, { "name": "DisableProgramAuthCheck", "type": "boolean", "required": false, "description": "是否禁用数据集鉴权", "example": "true" }, { "name": "ConfigIdList", "type": "array", "required": false, "description": "日志配置项ID 可通过调用[DescribeBusinessLogConfigs](https://cloud.tencent.com/document/product/649/75777)查询已创建的日志配置项列表或登录[控制台](https://console.cloud.tencent.com/tsf/observable/log?rid=1)进行查看", "example": "[\"apm-busi-log-cfg-qabp49vl\"]", "item_type": "string" } ], "required": [] }, { "name": "DescribeClusterInstances", "description": "查询集群实例", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群 ID。调用[DescribeSimpleClusters](https://cloud.tencent.com/document/api/649/36047)查询已创建的集群或通过[CreateCluster](https://cloud.tencent.com/document/api/649/36049)接口创建新的集群。", "example": "cluster-6a79x94v" }, { "name": "SearchWord", "type": "string", "required": false, "description": "搜索字段", "example": "test-cvm" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序字段", "example": "ClusterId" }, { "name": "OrderType", "type": "integer", "required": false, "description": "排序类型；0：升序，1：降序。", "example": "0" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认值：0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页个数，默认值：20。", "example": "20" } ], "required": [ "ClusterId" ] }, { "name": "DescribeClusters", "description": "获取集群列表", "status": "online", "parameters": [ { "name": "SearchWord", "type": "string", "required": false, "description": "搜索词，可以搜索ID/名称/备注/标签", "example": "cluster name" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序字段，目前仅支持使用“创建时间”", "example": "create_time" }, { "name": "OrderType", "type": "integer", "required": false, "description": "排序方式，0表示升序，1表示倒序", "example": "1" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页个数，0-50 之间，默认20", "example": "20" }, { "name": "ClusterType", "type": "string", "required": false, "description": "集群类型，C表示容器集群，V表示虚拟机集群", "example": "C" }, { "name": "ClusterIdList", "type": "array", "required": false, "description": "idList", "example": "[\"cluster-6a79x94v\"]", "item_type": "string" } ], "required": [] }, { "name": "DescribeConfig", "description": "查询配置", "status": "online", "parameters": [ { "name": "ConfigId", "type": "string", "required": true, "description": "配置ID。该参数可以通过调用 [DescribeConfigs](https://cloud.tencent.com/document/product/649/38340) 的返回值中的 ConfigId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=app)配置详情-配置版本页查看；也可以调用[CreateConfig](https://cloud.tencent.com/document/product/649/38348)创建新的配置。", "example": "dcfg-vzk36owv" } ], "required": [ "ConfigId" ] }, { "name": "DescribeConfigReleaseLogs", "description": "查询配置发布历史", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": false, "description": "部署组ID，不传入时查询全量。该参数可以通过调用 [DescribeSimpleGroups](https://cloud.tencent.com/document/product/649/36064) 的返回值中的 GroupId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/resource)-查看部署组页查看；也可以调用[CreateGroup](https://cloud.tencent.com/document/product/649/36074)创建新的部署组。", "example": "group-zvwbbnxv" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "10" }, { "name": "NamespaceId", "type": "string", "required": false, "description": "命名空间ID，不传入时查询全量。该参数可以通过调用 [DescribeSimpleNamespaces](https://cloud.tencent.com/document/api/649/36096) 的返回值中的 NamespaceId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/resource?tab=namespace)查看；也可以调用[CreateNamespace](https://cloud.tencent.com/document/product/649/36098)创建新的命名空间。", "example": "namespace-vj3z3zgy" }, { "name": "ClusterId", "type": "string", "required": false, "description": "集群ID，不传入时查询全量。该参数可以通过调用 [DescribeClusters](https://cloud.tencent.com/document/product/649/85857) 的返回值中的 ClusterId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/resource?tab=namespace)查看；也可以调用[CreateCluster](https://cloud.tencent.com/document/product/649/36049)创建新的集群。", "example": "cluster-yne99jdy" }, { "name": "ApplicationId", "type": "string", "required": false, "description": "应用ID，不传入时查询全量。该参数可以通过调用 [DescribeApplications](https://cloud.tencent.com/document/product/649/36090) 的返回值中的 ApplicationId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/app)查看；也可以调用[CreateApplication](https://cloud.tencent.com/document/product/649/36094)创建新的应用。", "example": "application-ov6ml25a" } ], "required": [] }, { "name": "DescribeConfigReleases", "description": "查询配置发布信息", "status": "online", "parameters": [ { "name": "ConfigName", "type": "string", "required": false, "description": "配置项名称，不传入时查询全量。该参数可以通过调用 [DescribeConfigs](https://cloud.tencent.com/document/product/649/38340) 的返回值中的 ConfigName 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=app)配置详情-配置版本页查看；也可以调用[CreateConfig](https://cloud.tencent.com/document/product/649/38348)创建新的配置。", "example": "configName" }, { "name": "GroupId", "type": "string", "required": false, "description": "部署组ID，不传入时查询全量。该参数可以通过调用 [DescribeSimpleGroups](https://cloud.tencent.com/document/product/649/36064) 的返回值中的 GroupId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/resource)-查看部署组页查看；也可以调用[CreateGroup](https://cloud.tencent.com/document/product/649/36074)创建新的部署组。", "example": "group-aln2284v" }, { "name": "NamespaceId", "type": "string", "required": false, "description": "命名空间ID，不传入时查询全量。该参数可以通过调用 [DescribeSimpleNamespaces](https://cloud.tencent.com/document/api/649/36096) 的返回值中的 NamespaceId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/resource?tab=namespace)查看；也可以调用[CreateNamespace](https://cloud.tencent.com/document/product/649/36098)创建新的命名空间。", "example": "namespace-vw8oox6v" }, { "name": "ClusterId", "type": "string", "required": false, "description": "集群ID，不传入时查询全量。该参数可以通过调用 [DescribeClusters](https://cloud.tencent.com/document/product/649/85857) 的返回值中的 ClusterId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/resource?tab=namespace)查看；也可以调用[CreateCluster](https://cloud.tencent.com/document/product/649/36049)创建新的集群。", "example": "cluster-yne99jdy" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "ConfigId", "type": "string", "required": false, "description": "配置ID，不传入时查询全量。该参数可以通过调用 [DescribeConfigs](https://cloud.tencent.com/document/product/649/38340) 的返回值中的 ConfigId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=app)配置详情-配置版本页查看；也可以调用[CreateConfig](https://cloud.tencent.com/document/product/649/38348)创建新的配置。", "example": "dcfg-yo82mmra" }, { "name": "ApplicationId", "type": "string", "required": false, "description": "应用ID，不传入时查询全量。该参数可以通过调用 [DescribeApplications](https://cloud.tencent.com/document/product/649/36090) 的返回值中的 ApplicationId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/app)查看；也可以调用[CreateApplication](https://cloud.tencent.com/document/product/649/36094)创建新的应用。", "example": "application-a7rwwz4v" } ], "required": [] }, { "name": "DescribeConfigSummary", "description": "查询配置汇总列表", "status": "online", "parameters": [ { "name": "ApplicationId", "type": "string", "required": false, "description": "应用ID，不传入时查询全量。该参数可以通过调用 [DescribeApplications](https://cloud.tencent.com/document/product/649/36090) 的返回值中的 ApplicationId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/app)查看；也可以调用[CreateApplication](https://cloud.tencent.com/document/product/649/36094)创建新的应用。", "example": "application-5yr26r9a" }, { "name": "SearchWord", "type": "string", "required": false, "description": "查询关键字，模糊查询：应用名称，配置项名称，不传入时查询全量。", "example": "config_app" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为50。", "example": "10" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序字段。 - creation_time：按时间排序 - config_name：按名称排序", "example": "creation_time" }, { "name": "OrderType", "type": "integer", "required": false, "description": "排序顺序。 - 0：升序 - 1：降序", "example": "1" }, { "name": "ConfigTagList", "type": "array", "required": false, "description": "TAG标签资源值。", "example": "[\"config_app-application-5yr26r9a\"]", "item_type": "string" }, { "name": "DisableProgramAuthCheck", "type": "boolean", "required": false, "description": "忽略传参，业务预留字段。", "example": "true" }, { "name": "ConfigIdList", "type": "array", "required": false, "description": "配置ID列表。该参数可以通过调用 [DescribeConfigs](https://cloud.tencent.com/document/product/649/38340) 的返回值中的 ConfigId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=app)配置详情-配置版本页查看；也可以调用[CreateConfig](https://cloud.tencent.com/document/product/649/38348)创建新的配置。", "example": "[\"dcfg-vzk36owv\"]", "item_type": "string" } ], "required": [] }, { "name": "DescribeConfigTemplate", "description": "导入配置", "status": "online", "parameters": [ { "name": "ConfigTemplateId", "type": "string", "required": true, "description": "配置模板ID。该参数可以通过调用 [DescribeConfigTemplate](https://cloud.tencent.com/document/product/649/85856) 的返回值中的 ConfigTemplateId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=template)查看；也可以调用[CreateConfigTemplate](https://cloud.tencent.com/document/product/649/85861)创建新的配置模板。", "example": "dcfg_temp-vwkjqd6v" } ], "required": [ "ConfigTemplateId" ] }, { "name": "DescribeConfigs", "description": "查询配置项列表", "status": "online", "parameters": [ { "name": "ApplicationId", "type": "string", "required": false, "description": "应用ID，不传入时查询全量。该参数可以通过调用 [DescribeApplications](https://cloud.tencent.com/document/product/649/36090) 的返回值中的 ApplicationId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/app)查看；也可以调用[CreateApplication](https://cloud.tencent.com/document/product/649/36094)创建新的应用。", "example": "application-jy9w6lka" }, { "name": "ConfigId", "type": "string", "required": false, "description": "配置ID，不传入时查询全量，高优先级。该参数可以通过调用 [DescribeConfigs](https://cloud.tencent.com/document/product/649/38340) 的返回值中的 ConfigId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=app)配置详情-配置版本页查看；也可以调用[CreateConfig](https://cloud.tencent.com/document/product/649/38348)创建新的配置。", "example": "dcfg-2vz558vp" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "50" }, { "name": "ConfigIdList", "type": "array", "required": false, "description": "配置ID列表，不传入时查询全量，低优先级。该参数可以通过调用 [DescribeConfigs](https://cloud.tencent.com/document/product/649/38340) 的返回值中的 ConfigId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=app)配置详情-配置版本页查看；也可以调用[CreateConfig](https://cloud.tencent.com/document/product/649/38348)创建新的配置。", "example": "[\"dcfg-2vz558vp\"]", "item_type": "string" }, { "name": "ConfigName", "type": "string", "required": false, "description": "配置项名称，精确查询，不传入时查询全量。", "example": "test-driverapi-config" }, { "name": "ConfigVersion", "type": "string", "required": false, "description": "配置项版本，精确查询，不传入时查询全量。", "example": "v1" } ], "required": [] }, { "name": "DescribeContainerEvents", "description": "获取容器事件列表 参数限制 - 当类型是 instance 时，GroupId是必填项", "status": "online", "parameters": [ { "name": "ResourceType", "type": "string", "required": true, "description": "event 的资源类型, 仅支持 group", "example": "group" }, { "name": "ResourceId", "type": "string", "required": true, "description": "部署组ID，按照【部署组ID】进行过滤，可通过调用[DescribeGroups](https://cloud.tencent.com/document/product/649/36065)查询已创建的项目列表或登录控制台进行查看；也可以调用[CreateGroup](https://cloud.tencent.com/document/product/649/36074)创建新的项目。", "example": "group-df3fsd23" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，取值从0开始", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页个数，默认为20， 取值应为1~50", "example": "1" }, { "name": "GroupId", "type": "string", "required": false, "description": "部署组ID，可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/api/649/36068)查询已创建的部署组列表或登录控制台进行查看；也可以调用[CreateContainGroup](https://cloud.tencent.com/document/api/649/36075)创建新的部署组。", "example": "group-df3fsd23" }, { "name": "Kind", "type": "string", "required": false, "description": "event的资源种类", "example": "Deployment" }, { "name": "Type", "type": "string", "required": false, "description": "event 的事件级别", "example": "Normal" }, { "name": "ResourceName", "type": "string", "required": false, "description": "资源名称", "example": "groupName-5b6bf7b6c5-d9jnm" }, { "name": "SearchWord", "type": "string", "required": false, "description": "关键词查询", "example": "group-df3fsd23" } ], "required": [ "ResourceType", "ResourceId" ] }, { "name": "DescribeContainerGroupAttribute", "description": "获取部署组其他字段-用于前端并发调用", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "部署组ID，可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/api/649/36068)查询已创建的部署组列表或登录控制台进行查看；也可以调用[CreateContainGroup](https://cloud.tencent.com/document/api/649/36075)创建新的部署组。", "example": "group-ab958z6y" } ], "required": [ "GroupId" ] }, { "name": "DescribeContainerGroupDeployInfo", "description": "获取部署组详情", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "部署组ID，可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/api/649/36068)查询已创建的部署组列表或登录控制台进行查看；也可以调用[CreateContainGroup](https://cloud.tencent.com/document/api/649/36075)创建新的部署组。", "example": "group-gyqpkzda" } ], "required": [ "GroupId" ] }, { "name": "DescribeContainerGroupDetail", "description": "容器部署组详情（已废弃，请使用 [DescribeContainerGroupDeployInfo](https://cloud.tencent.com/document/product/649/67221)）", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "分组ID", "example": "group-6a79x94v" } ], "required": [ "GroupId" ] }, { "name": "DescribeContainerGroups", "description": "容器部署组列表", "status": "online", "parameters": [ { "name": "ApplicationId", "type": "string", "required": true, "description": "分组所属【应用ID】，可通过调用[DescribeApplications](https://cloud.tencent.com/document/product/649/36090)查询已创建的应用列表或登录[控制台](https://console.cloud.tencent.com/tsf/app?rid=1)进行查看；也可以调用[CreateApplication](https://cloud.tencent.com/document/product/649/36094)创建新的应用。", "example": "application-zvw6zp9a" }, { "name": "SearchWord", "type": "string", "required": false, "description": "搜索字段，模糊搜索groupName字段", "example": "foo-group" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序字段，默认为 createTime字段，支持id， name， createTime", "example": "id" }, { "name": "OrderType", "type": "integer", "required": false, "description": "排序方式，默认为1：倒序排序，0：正序，1：倒序", "example": "0" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，取值从0开始", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页个数，默认为20， 取值应为1~50", "example": "20" }, { "name": "ClusterId", "type": "string", "required": false, "description": "分组所属【集群ID】，可通过调用[DescribeClusters](https://cloud.tencent.com/document/product/649/85857)查询已创建的集群列表或登录[控制台](https://console.cloud.tencent.com/tsf/resource?rid=1\u0026tab=docker)进行查看；也可以调用[CreateCluster](https://cloud.tencent.com/document/product/649/36049)创建新的集群。", "example": "cls-2nhp3g1i" }, { "name": "NamespaceId", "type": "string", "required": false, "description": "分组所属【命名空间 ID】，可通过调用[DescribeSimpleNamespaces](https://cloud.tencent.com/document/product/649/36096)查询已创建的命名空间列表或登录[控制台](https://console.cloud.tencent.com/tsf/resource?rid=1\u0026tab=namespace)进行查看；也可以调用[CreateNamespace](https://cloud.tencent.com/document/product/649/36098)创建新的命名空间。", "example": "namespace-byxwl4da" } ], "required": [ "ApplicationId" ] }, { "name": "DescribeCreateGatewayApiStatus", "description": "查询一键导入API分组任务的状态", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": false, "description": "网关分组ID。该参数可以通过调用 [DescribeApiGroups](https://cloud.tencent.com/document/product/649/50636) 的返回值中的 GroupId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/app?tab=middleware\u0026subTab=app)-网关应用详情-Java网关实例-实例详情-分组管理页查看；也可以调用[CreateApiGroup](https://cloud.tencent.com/document/product/649/50641)创建新的网关分组。", "example": "grp-nb08ur29" }, { "name": "MicroserviceId", "type": "string", "required": false, "description": "微服务ID。该参数可以通过调用 [DescribeMicroservices](https://cloud.tencent.com/document/product/649/36084) 的返回值中的 MicroserviceId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?tab=service)查看；也可以调用[CreateMicroserviceWithDetailResp](https://cloud.tencent.com/document/product/649/85860)创建新的微服务。", "example": "ms-a78gk87b" } ], "required": [] }, { "name": "DescribeDeliveryConfig", "description": "获取单个投递项配置信息", "status": "online", "parameters": [ { "name": "ConfigId", "type": "string", "required": true, "description": "日志配置项ID 可通过调用[DescribeBusinessLogConfigs](https://cloud.tencent.com/document/product/649/75777)查询已创建的日志配置项列表或登录[控制台](https://console.cloud.tencent.com/tsf/observable/log?rid=1)进行查看", "example": "config-2k8sh4s" } ], "required": [ "ConfigId" ] }, { "name": "DescribeDeliveryConfigByGroupId", "description": "用部署组id获取绑定信息", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "部署组ID 可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/product/649/36068)或[DescribeGroups](https://cloud.tencent.com/document/product/649/36065)查询已创建的部署组列表或登录[控制台](https://console.cloud.tencent.com/tsf/app-detail?rid=1\u0026id=application-yo7kp9dv\u0026tab=publish\u0026subTab=group)进行查看", "example": "group-ab958z6y" } ], "required": [ "GroupId" ] }, { "name": "DescribeDeliveryConfigs", "description": "获取多个投递项配置", "status": "online", "parameters": [ { "name": "SearchWord", "type": "string", "required": false, "description": "搜索关键字，可搜索日志投递配置项ID或日志投递配置项名称", "example": "mock-name" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，取值范围大于等于0，默认值为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "单页请求配置数量，取值范围[1, 50]，默认值为10", "example": "50" }, { "name": "ProgramIdList", "type": "array", "required": false, "description": "数据集ID列表 可通过调用[DescribePrograms](https://cloud.tencent.com/document/product/649/73477)查询已创建的数据集列表或登录[控制台](https://console.cloud.tencent.com/tsf/privilege?rid=1\u0026tab=program\u0026roleId=role-a22gwdwa)进行查看", "example": "[\"program-6a79x94v\"]", "item_type": "string" }, { "name": "ConfigIdList", "type": "array", "required": false, "description": "日志配置项ID列表 可通过调用[DescribeBusinessLogConfigs](https://cloud.tencent.com/document/product/649/75777)查询已创建的日志配置项列表或登录[控制台](https://console.cloud.tencent.com/tsf/observable/log?rid=1)进行查看", "example": "[\"config-6a79x94v\"]", "item_type": "string" } ], "required": [] }, { "name": "DescribeDownloadInfo", "description": "TSF上传的程序包存放在腾讯云对象存储（COS）中，通过该API可以获取从COS下载程序包需要的信息，包括包所在的桶、存储路径、鉴权信息等，之后使用COS API（或SDK）进行下载。 请查阅[COS相关文档](https://cloud.tencent.com/document/product/436)", "status": "online", "parameters": [ { "name": "ApplicationId", "type": "string", "required": true, "description": "应用ID，通过调用DescribeApplications接口[获取应用列表](https://cloud.tencent.com/document/api/649/36090)从而获取应用ID，或登录[控制台](https://console.cloud.tencent.com/tsf/app?rid=1)进行查看，调用CreateApplication接口[创建应用](https://cloud.tencent.com/document/product/649/36094)时的返回值", "example": "application-6a79x94v" }, { "name": "PkgId", "type": "string", "required": true, "description": "软件包ID可通过调用DescribeUploadInfo接口时[获取上传程序包信息](https://cloud.tencent.com/document/api/649/36078)返回的COS上传信息获取，登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看", "example": "pkg-6a79x94v" }, { "name": "RepositoryId", "type": "string", "required": false, "description": "仓库ID，可通过调用[仓库信息查询类](https://cloud.tencent.com/document/api/649/45925)接口时出参中的RepositoryId，或登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看", "example": "application-6a79x94v" }, { "name": "RepositoryType", "type": "string", "required": false, "description": "程序包仓库类型（允许值：\"public-demo\"TSF公共demo仓库, \"private\"自定义仓库, \"default\"TSF公共仓库）", "example": "private" } ], "required": [ "ApplicationId", "PkgId" ] }, { "name": "DescribeEnabledUnitRule", "description": "查询生效的单元化规则", "status": "online", "parameters": [ { "name": "GatewayInstanceId", "type": "string", "required": true, "description": "网关实体ID", "example": "gw-ins-szesmg28" } ], "required": [ "GatewayInstanceId" ] }, { "name": "DescribeFileConfigReleases", "description": "查询文件配置项发布信息", "status": "online", "parameters": [ { "name": "ConfigId", "type": "string", "required": false, "description": "配置ID。该参数可以通过调用 [DescribeFileConfigs](https://cloud.tencent.com/document/product/649/58593) 的返回值中的 ConfigId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?rid=1\u0026subTab=file)配置详情-配置版本页查看；也可以调用[CreateFileConfig](https://cloud.tencent.com/document/product/649/58594)创建新的配置。", "example": "dcfg-f-v3qqrkdy" }, { "name": "ConfigName", "type": "string", "required": false, "description": "配置项名称，最多支持60个字符，只能包含字母、数字及分隔符（“-”,“_”），且不能以分隔符开头或结尾。", "example": "conf_app" }, { "name": "GroupId", "type": "string", "required": false, "description": "部署组ID。该参数可以通过调用 [DescribeSimpleGroups](https://cloud.tencent.com/document/product/649/36064) 的返回值中的 GroupId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/resource)-查看部署组页查看；也可以调用[CreateGroup](https://cloud.tencent.com/document/product/649/36074)创建新的部署组。", "example": "group-vj3n6lzy" }, { "name": "NamespaceId", "type": "string", "required": false, "description": "命名空间ID。该参数可以通过调用 [DescribeSimpleNamespaces](https://cloud.tencent.com/document/api/649/36096) 的返回值中的 NamespaceId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/resource?tab=namespace)查看；也可以调用[CreateNamespace](https://cloud.tencent.com/document/product/649/36098)创建新的命名空间。", "example": "namespace-ygo3djma" }, { "name": "ClusterId", "type": "string", "required": false, "description": "集群ID。该参数可以通过调用 [DescribeClusters](https://cloud.tencent.com/document/product/649/85857) 的返回值中的 ClusterId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/resource?tab=namespace)查看；也可以调用[CreateCluster](https://cloud.tencent.com/document/product/649/36049)创建新的集群。", "example": "cls-f6bk82xc" }, { "name": "ApplicationId", "type": "string", "required": false, "description": "应用ID。该参数可以通过调用 [DescribeApplications](https://cloud.tencent.com/document/product/649/36090) 的返回值中的 ApplicationId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/app)查看；也可以调用[CreateApplication](https://cloud.tencent.com/document/product/649/36094)创建新的应用。", "example": "application-vw8ljmwv" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "20" } ], "required": [] }, { "name": "DescribeFileConfigs", "description": "查询文件配置项列表", "status": "online", "parameters": [ { "name": "ConfigId", "type": "string", "required": false, "description": "配置ID。该参数可以通过调用 [DescribeFileConfigs](https://cloud.tencent.com/document/product/649/58593) 的返回值中的 ConfigId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?rid=1\u0026subTab=file)配置详情-配置版本页查看；也可以调用[CreateFileConfig](https://cloud.tencent.com/document/product/649/58594)创建新的配置。", "example": "dcfg-f-2vzbzovp" }, { "name": "ConfigIdList", "type": "array", "required": false, "description": "配置项ID列表。该参数可以通过调用 [DescribeFileConfigs](https://cloud.tencent.com/document/product/649/58593) 的返回值中的 ConfigId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?rid=1\u0026subTab=file)配置详情-配置版本页查看；也可以调用[CreateFileConfig](https://cloud.tencent.com/document/product/649/58594)创建新的配置。", "example": "[\"dcfg-f-ba2d9ovk\"]", "item_type": "string" }, { "name": "ConfigName", "type": "string", "required": false, "description": "配置项名称。", "example": "cfg1" }, { "name": "ApplicationId", "type": "string", "required": false, "description": "应用ID。该参数可以通过调用 [DescribeApplications](https://cloud.tencent.com/document/product/649/36090) 的返回值中的 ApplicationId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/app)查看；也可以调用[CreateApplication](https://cloud.tencent.com/document/product/649/36094)创建新的应用。", "example": "application-6ymrrbag" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "50" }, { "name": "ConfigVersion", "type": "string", "required": false, "description": "配置项版本。", "example": "v1" } ], "required": [] }, { "name": "DescribeFlowLastBatchState", "description": "分布式任务调度 TCT 已到达 EOMS 节点，进行产品下线处理。退市公告https://cloud.tencent.com/announce/detail/2053 查询工作流最新一个批次的状态信息", "status": "deprecated", "parameters": [ { "name": "FlowId", "type": "string", "required": true, "description": "工作流 ID。前往[工作流管理](https://console.cloud.tencent.com/tsf/tct?rid=1\u0026tab=workflowManage)，在工作流列表第一列和工作流详情页查看工作流ID。", "example": "flow-6a79x94v" } ], "required": [ "FlowId" ] }, { "name": "DescribeGatewayAllGroupApis", "description": "查询网关所有分组下Api列表", "status": "online", "parameters": [ { "name": "GatewayDeployGroupId", "type": "string", "required": true, "description": "网关部署组ID", "example": "group-yd3b588a" }, { "name": "SearchWord", "type": "string", "required": false, "description": "搜索关键字，支持命名空间名称或服务名称", "example": "namespaceName" } ], "required": [ "GatewayDeployGroupId" ] }, { "name": "DescribeGatewayApis", "description": "查询API分组下的Api列表信息", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "分组ID", "example": "grp-nb08ur29" }, { "name": "Offset", "type": "integer", "required": true, "description": "翻页偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "每页的记录数", "example": "10" }, { "name": "SearchWord", "type": "string", "required": false, "description": "搜索关键字，支持 API path", "example": "/swagger" }, { "name": "GatewayDeployGroupId", "type": "string", "required": false, "description": "部署组ID", "example": "group-yd3b588a" }, { "name": "ReleaseStatus", "type": "string", "required": false, "description": "发布状态, drafted(未发布)/released(已发布)/releasing(发布中)/failed(发布失败)", "example": "released" } ], "required": [ "GroupId", "Offset", "Limit" ] }, { "name": "DescribeGatewayMonitorOverview", "description": "查询网关监控概览", "status": "online", "parameters": [ { "name": "GatewayDeployGroupId", "type": "string", "required": true, "description": "网关部署组ID", "example": "group-yd3b588a" } ], "required": [ "GatewayDeployGroupId" ] }, { "name": "DescribeGroup", "description": "查询虚拟机部署组详情", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "部署组ID，可通过调用[DescribeGroups](https://cloud.tencent.com/document/api/649/36065)查询已创建的部署组列表或登录控制台进行查看；也可以调用[CreateGroup](https://cloud.tencent.com/document/api/649/36074)创建新的部署组。", "example": "group-oydzed8v" } ], "required": [ "GroupId" ] }, { "name": "DescribeGroupAttribute", "description": "获取部署组其他属性", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "部署组ID，可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/api/649/36068)查询已创建的部署组列表或登录控制台进行查看；也可以调用[CreateContainGroup](https://cloud.tencent.com/document/api/649/36075)创建新的部署组。", "example": "group-6a79x94v" } ], "required": [ "GroupId" ] }, { "name": "DescribeGroupBindedGateways", "description": "查询某个API分组已绑定的网关部署组信息列表", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "API 分组ID", "example": "grp-nb08ur29" }, { "name": "Offset", "type": "integer", "required": true, "description": "翻页查询偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "翻页查询每页记录数", "example": "5" }, { "name": "SearchWord", "type": "string", "required": false, "description": "搜索关键字", "example": "groupName" } ], "required": [ "GroupId", "Offset", "Limit" ] }, { "name": "DescribeGroupBusinessLogConfigs", "description": "查询分组管理日志配置列表", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "部署组ID 可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/product/649/36068)或[DescribeGroups](https://cloud.tencent.com/document/product/649/36065)查询已创建的部署组列表或登录[控制台](https://console.cloud.tencent.com/tsf/app-detail?rid=1\u0026id=application-yo7kp9dv\u0026tab=publish\u0026subTab=group)进行查看", "example": "group-6a79x94v" } ], "required": [ "GroupId" ] }, { "name": "DescribeGroupGateways", "description": "查询某个网关绑定的API 分组信息列表", "status": "online", "parameters": [ { "name": "GatewayDeployGroupId", "type": "string", "required": true, "description": "网关部署组ID", "example": "group-yd3b588a" }, { "name": "Offset", "type": "integer", "required": true, "description": "翻页查询偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "翻页查询每页记录数", "example": "5" }, { "name": "SearchWord", "type": "string", "required": false, "description": "搜索关键字", "example": "grpName" } ], "required": [ "GatewayDeployGroupId", "Offset", "Limit" ] }, { "name": "DescribeGroupInstances", "description": "查询虚拟机部署组云主机列表", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "部署组ID，可通过调用[DescribeGroups](https://cloud.tencent.com/document/api/649/36065)查询已创建的部署组列表或登录控制台进行查看；也可以调用[CreateGroup](https://cloud.tencent.com/document/api/649/36074)创建新的部署组。", "example": "group-6a79x94v" }, { "name": "SearchWord", "type": "string", "required": false, "description": "搜索字段", "example": "group-name" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序字段", "example": "groupId" }, { "name": "OrderType", "type": "integer", "required": false, "description": "排序类型；0：升序，1：降序", "example": "0" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认值：0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页个数；默认值：20", "example": "20" } ], "required": [ "GroupId" ] }, { "name": "DescribeGroupRelease", "description": "查询部署组相关的发布信息", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "部署组ID。该参数可以通过调用 [DescribeSimpleGroups](https://cloud.tencent.com/document/product/649/36064) 的返回值中的 GroupId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/resource)-查看部署组页查看；也可以调用[CreateGroup](https://cloud.tencent.com/document/product/649/36074)创建新的部署组。", "example": "group-v6q747py" } ], "required": [ "GroupId" ] }, { "name": "DescribeGroupUseDetail", "description": "查询网关分组监控明细数据", "status": "online", "parameters": [ { "name": "GatewayDeployGroupId", "type": "string", "required": true, "description": "网关部署组ID", "example": "group-yd3b588a" }, { "name": "GroupId", "type": "string", "required": true, "description": "网关分组ID", "example": "grp-nb08ur29" }, { "name": "StartTime", "type": "string", "required": true, "description": "查询的日期,格式：yyyy-MM-dd HH:mm:ss", "example": "2024-12-16 16:36:40" }, { "name": "EndTime", "type": "string", "required": true, "description": "查询的日期,格式：yyyy-MM-dd HH:mm:ss", "example": "2024-12-23 16:36:40" }, { "name": "Count", "type": "integer", "required": false, "description": "指定top的条数,默认为10", "example": "10" } ], "required": [ "GatewayDeployGroupId", "GroupId", "StartTime", "EndTime" ] }, { "name": "DescribeGroups", "description": "获取虚拟机部署组列表", "status": "online", "parameters": [ { "name": "SearchWord", "type": "string", "required": false, "description": "搜索字段", "example": "groupName" }, { "name": "ApplicationId", "type": "string", "required": false, "description": "应用ID。调用[DescribeApplications](https://cloud.tencent.com/document/api/649/36090)查询已创建的应用或通过[CreateApplication](https://cloud.tencent.com/document/api/649/36094)接口创建新的应用。", "example": "application-6a79x94v" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序字段", "example": "group_name" }, { "name": "OrderType", "type": "integer", "required": false, "description": "排序方式，0：升序，1：降序", "example": "1" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认值：0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页个数，默认值：20", "example": "10" }, { "name": "NamespaceId", "type": "string", "required": false, "description": "命名空间ID。调用[DescribeSimpleNamespaces](https://cloud.tencent.com/document/api/649/36096)查询已创建的命名空间或通过[CreateNamespace](https://cloud.tencent.com/document/api/649/36098)接口创建新的集群。", "example": "namespace-6a79x94v" }, { "name": "ClusterId", "type": "string", "required": false, "description": "集群 ID。调用[DescribeSimpleClusters](https://cloud.tencent.com/document/api/649/36047)查询已创建的集群或通过[CreateCluster](https://cloud.tencent.com/document/api/649/36049)接口创建新的集群。", "example": "cluster-6a79x94v" }, { "name": "GroupResourceTypeList", "type": "array", "required": false, "description": "部署组资源类型列表", "example": "[\"GW\"]", "item_type": "string" }, { "name": "Status", "type": "string", "required": false, "description": "部署组状态过滤字段", "example": "Running、Waiting、Paused、Updating、RollingBack、Abnormal、Unknown" }, { "name": "GroupIdList", "type": "array", "required": false, "description": "部署组ID列表", "example": "[\"group-6a79x94v\"]", "item_type": "string" } ], "required": [] }, { "name": "DescribeGroupsWithPlugin", "description": "查询某个插件下绑定或未绑定的API分组", "status": "online", "parameters": [ { "name": "PluginId", "type": "string", "required": true, "description": "插件ID", "example": "pgn-iuyb0s7c" }, { "name": "Offset", "type": "integer", "required": true, "description": "翻页偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "每页记录数量", "example": "5" }, { "name": "Bound", "type": "boolean", "required": false, "description": "绑定/未绑定: true / false", "example": "true" }, { "name": "SearchWord", "type": "string", "required": false, "description": "搜索关键字", "example": "/grpCtx" }, { "name": "GatewayInstanceId", "type": "string", "required": false, "description": "网关实体ID", "example": "gw-ins-4qvyt5dc" } ], "required": [ "PluginId", "Offset", "Limit" ] }, { "name": "DescribeImageRepository", "description": "查询镜像仓库列表", "status": "online", "parameters": [ { "name": "SearchWord", "type": "string", "required": false, "description": "仓库名，搜索关键字,不带命名空间的", "example": "tagName" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。关于Offset详见[API简介](https://cloud.tencent.com/document/api/213/568#.E8.BE.93.E5.85.A5.E5.8F.82.E6.95.B0.E4.B8.8E.E8.BF.94.E5.9B.9E.E5.8F.82.E6.95.B0.E9.87.8A.E4.B9.89)", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "数量限制，默认为20，最大值为100。关于Limit详见[API简介](https://cloud.tencent.com/document/api/213/568#.E8.BE.93.E5.85.A5.E5.8F.82.E6.95.B0.E4.B8.8E.E8.BF.94.E5.9B.9E.E5.8F.82.E6.95.B0.E9.87.8A.E4.B9.89)", "example": "20" }, { "name": "RepoType", "type": "string", "required": false, "description": "企业: tcr ；个人: personal或者不填", "example": "personal" }, { "name": "ApplicationId", "type": "string", "required": false, "description": "应用ID，可通过调用[DescribeApplications](https://cloud.tencent.com/document/api/649/36090)查询已创建的应用列表或登录控制台进行查看；也可以调用[CreateApplication](https://cloud.tencent.com/document/api/649/36094)创建新的应用。", "example": "application-6a79x94v" }, { "name": "TcrRepoInfo", "type": "object", "required": false, "description": "TcrRepoInfo值", "example": "无", "children": [ { "name": "Region", "type": "string", "required": false, "description": "地域（填数字）", "example": "ap-guangzhou" }, { "name": "RegistryId", "type": "string", "required": false, "description": "实例id", "example": "reg-6a79x94v" }, { "name": "RegistryName", "type": "string", "required": false, "description": "实例名", "example": "/tsf" }, { "name": "Namespace", "type": "string", "required": false, "description": "命名空间", "example": "tsf_1083080xxxx" }, { "name": "RepoName", "type": "string", "required": false, "description": "仓库名", "example": "/tsf/nginx" } ] }, { "name": "RepoName", "type": "string", "required": false, "description": "镜像仓库名称", "example": "nginx" } ], "required": [] }, { "name": "DescribeImageTags", "description": "镜像版本列表", "status": "online", "parameters": [ { "name": "ApplicationId", "type": "string", "required": false, "description": "应用ID，可通过调用[DescribeApplications](https://cloud.tencent.com/document/api/649/36090)查询已创建的应用列表或登录控制台进行查看；也可以调用[CreateApplication](https://cloud.tencent.com/document/api/649/36094)创建新的应用。", "example": "application-6a79x94v" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。关于Offset详见[API简介](https://cloud.tencent.com/document/api/213/568#.E8.BE.93.E5.85.A5.E5.8F.82.E6.95.B0.E4.B8.8E.E8.BF.94.E5.9B.9E.E5.8F.82.E6.95.B0.E9.87.8A.E4.B9.89)", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "数量限制，默认为20，最大值为100。关于Limit详见[API简介](https://cloud.tencent.com/document/api/213/568#.E8.BE.93.E5.85.A5.E5.8F.82.E6.95.B0.E4.B8.8E.E8.BF.94.E5.9B.9E.E5.8F.82.E6.95.B0.E9.87.8A.E4.B9.89)", "example": "100" }, { "name": "QueryImageIdFlag", "type": "integer", "required": false, "description": "不填和0:查询 1:不查询", "example": "1" }, { "name": "SearchWord", "type": "string", "required": false, "description": "可用于搜索的 tag 名字", "example": "v2" }, { "name": "RepoType", "type": "string", "required": false, "description": "企业: tcr ；个人: personal或者不填", "example": "personal" }, { "name": "TcrRepoInfo", "type": "object", "required": false, "description": "TcrRepoInfo值", "example": "无", "children": [ { "name": "Region", "type": "string", "required": false, "description": "地域（填数字）", "example": "ap-guangzhou" }, { "name": "RegistryId", "type": "string", "required": false, "description": "实例id", "example": "reg-6a79x94v" }, { "name": "RegistryName", "type": "string", "required": false, "description": "实例名", "example": "/tsf" }, { "name": "Namespace", "type": "string", "required": false, "description": "命名空间", "example": "tsf_1083080xxxx" }, { "name": "RepoName", "type": "string", "required": false, "description": "仓库名", "example": "/tsf/nginx" } ] }, { "name": "RepoName", "type": "string", "required": false, "description": "仓库名", "example": "nginx" } ], "required": [] }, { "name": "DescribeInstances", "description": "无", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。多个 filter 之间是与关系，单个 filter 多个 value 之间是或关系。 参考：[{\"Name\":\"ip\",\"Values\":[\"172.16.16.139\"]}] filter name 取值范围： - `id`：实例ID - ` name `：实例名 - ` ip `：内网IP（可填wan_ip或lan_ip）", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤条件名", "example": "host" }, { "name": "Values", "type": "array", "required": true, "description": "过滤条件匹配值，几个条件间是或关系", "example": "[\"metadata.host\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页个数，默认为20，最大100", "example": "20" } ], "required": [] }, { "name": "DescribeInvocationMetricDataCurve", "description": "查询调用指标数据变化曲线", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": false, "description": "开始时间，格式yyyy-MM-dd HH:mm:ss", "example": "2020-06-03 17:11:49" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间，格式yyyy-MM-dd HH:mm:ss", "example": "2020-06-03 17:21:49" }, { "name": "Period", "type": "integer", "required": false, "description": "查询时间粒度，单位秒。可选值：60、3600、86400", "example": "3600" }, { "name": "MetricDimensions", "type": "array", "required": false, "description": "查询指标维度，不能为空", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "指标维度名称", "example": "host" }, { "name": "Value", "type": "string", "required": false, "description": "指标维度取值", "example": "cvm-1" } ] }, { "name": "Metrics", "type": "array", "required": false, "description": "查询指标名，不能为空", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "指标名称", "example": "time" }, { "name": "Function", "type": "string", "required": false, "description": "指标计算方式，可选值： none：无，sum：求和，exclusive：独占值，avg：平均值，max：最大值，min：最小值，percentage_50：50分位数，percentage_75：75分位数，percentage_95：95分位数，percentage_99：99分位数，bucket_5：分桶统计。", "example": "count" } ] }, { "name": "Kind", "type": "string", "required": false, "description": "视图视角。可选值：SERVER：服务端，CLIENT：客户端。默认为SERVER", "example": "SERVER" }, { "name": "Type", "type": "string", "required": false, "description": "类型。组件监控使用，可选值：SQL 或者 NoSQL", "example": "SQL" } ], "required": [] }, { "name": "DescribeInvocationMetricDataDimension", "description": "查询维度", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "开始时间，格式yyyy-MM-dd HH:mm:ss", "example": "2024-11-11 12:21:50" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间，格式yyyy-MM-dd HH:mm:ss", "example": "2024-11-11 12:26:50" }, { "name": "Offset", "type": "integer", "required": true, "description": "开始index，取值范围大于等于0，默认值为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "单页请求配置数量，取值范围[1, 50]，默认值为10", "example": "50" }, { "name": "DimensionName", "type": "string", "required": true, "description": "聚合维度。可选值 NamespaceId：命名空间ID，GroupId：部署组ID，InstanceId：实例ID，ApplicationId：应用ID，OperationMethod：执行方法，OperationName：执行名称，ServiceName：服务名，UpstreamNamespaceId：上游命名空间ID", "example": "applicationName" }, { "name": "SearchWord", "type": "string", "required": false, "description": "搜索关键字", "example": "word" }, { "name": "MetricDimensionValues", "type": "array", "required": false, "description": "构建维度", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "维度名", "example": "NamespaceId" }, { "name": "Value", "type": "array", "required": true, "description": "维度值", "example": "[\"namespace-xxxxxxxx\"]", "item_type": "string" } ] } ], "required": [ "StartTime", "EndTime", "Offset", "Limit", "DimensionName" ] }, { "name": "DescribeInvocationMetricDataPoint", "description": "查询单值指标维度", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "开始时间，格式yyyy-MM-dd HH:mm:ss", "example": "2020-06-03 17:11:49" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间，格式yyyy-MM-dd HH:mm:ss", "example": "2020-06-03 17:11:49" }, { "name": "MetricDimensionValues", "type": "array", "required": true, "description": "查询指标维度, 不能为空", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "维度名", "example": "NamespaceId" }, { "name": "Value", "type": "array", "required": true, "description": "维度值", "example": "[\"namespace-xxxxxxxx\"]", "item_type": "string" } ] }, { "name": "Metrics", "type": "array", "required": true, "description": "指标，不能为空", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "指标名称", "example": "time" }, { "name": "Function", "type": "string", "required": false, "description": "指标计算方式，可选值： none：无，sum：求和，exclusive：独占值，avg：平均值，max：最大值，min：最小值，percentage_50：50分位数，percentage_75：75分位数，percentage_95：95分位数，percentage_99：99分位数，bucket_5：分桶统计。", "example": "count" } ] }, { "name": "Kind", "type": "string", "required": false, "description": "视图视角。可选值：SERVER：服务端, CLIENT：客户端。默认为SERVER", "example": "SERVER" } ], "required": [ "StartTime", "EndTime", "MetricDimensionValues", "Metrics" ] }, { "name": "DescribeInvocationMetricScatterPlot", "description": "查询调用指标数据散点图", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": false, "description": "查询开始时间，格式yyyy-MM-dd HH:mm:ss", "example": "2020-06-03 17:11:49" }, { "name": "EndTime", "type": "string", "required": false, "description": "查询结束时间，格式yyyy-MM-dd HH:mm:ss", "example": "2020-06-03 17:21:49" }, { "name": "Period", "type": "integer", "required": false, "description": "查询时间粒度，单位秒。可选值：60、3600、86400", "example": "60" }, { "name": "MetricDimensions", "type": "array", "required": false, "description": "查询指标维度, 不能为空。Name, Valeu键值对形式。Name可选值 NamespaceId：命名空间ID，GroupId：部署组ID，InstanceId：实例ID，ApplicationId：应用ID，OperationMethod：执行方法，OperationName：执行名称，ServiceName：服务名，UpstreamNamespaceId：上游命名空间ID", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "指标维度名称", "example": "host" }, { "name": "Value", "type": "string", "required": false, "description": "指标维度取值", "example": "cvm-1" } ] }, { "name": "Metrics", "type": "array", "required": false, "description": "查询指标名， 不能为空。仅支持 range_count_duration（响应耗时分布） 为 key 下的 sum（求和） 方法", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "指标名称", "example": "time" }, { "name": "Function", "type": "string", "required": false, "description": "指标计算方式，可选值： none：无，sum：求和，exclusive：独占值，avg：平均值，max：最大值，min：最小值，percentage_50：50分位数，percentage_75：75分位数，percentage_95：95分位数，percentage_99：99分位数，bucket_5：分桶统计。", "example": "count" } ] }, { "name": "Kind", "type": "string", "required": false, "description": "视图视角。可选值：SERVER：服务端, CLIENT：客户端。默认为SERVER", "example": "SERVER" } ], "required": [] }, { "name": "DescribeJvmMonitor", "description": "查询java实例jvm监控数据,返回数据可选", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "查询的实例ID 可通过调用[DescribeClusterInstances](https://cloud.tencent.com/document/product/649/36048)查询已导入的实例列表或登录[控制台](https://console.cloud.tencent.com/tsf/resource?rid=1\u0026tab=instance)进行查询。实例ID例如：ins-6decplwk", "example": "ins-6a79x94v" }, { "name": "ApplicationId", "type": "string", "required": true, "description": "实例所属应用ID 可通过调用[DescribeApplications](https://cloud.tencent.com/document/product/649/36090)查询已经存在的应用列表或登录[控制台](https://console.cloud.tencent.com/tsf/app?rid=1)查看。应用ID例如：application-v378ewna", "example": "application-6a79x94v" }, { "name": "TimeGranularity", "type": "integer", "required": true, "description": "时间粒度,单位:秒", "example": "60" }, { "name": "From", "type": "string", "required": true, "description": "查询数据起始时间格式(yyyy-MM-dd HH:mm:ss)", "example": "2022-12-30 12:32:56" }, { "name": "To", "type": "string", "required": true, "description": "查询数据结束时间格式(yyyy-MM-dd HH:mm:ss)", "example": "2022-12-30 14:32:56" }, { "name": "RequiredPictures", "type": "array", "required": true, "description": "查询的监控图列表，以返回值属性名作为入参，可选值： heapMemory：堆内存监控图；nonHeapMemory：非堆内存监控图；edenSpace：伊甸区监控图；survivorSpace：幸存者区监控图；oldSpace：老年代监控图；metaSpace：元空间监控图；youngGC：youngGC增量监控图；fullGC：fullGC增量监控图；cpuUsage：cpu使用率监控图；classCount：加载类数监控图；threadPicture：线程图", "example": "[\"heapMemory\"]", "item_type": "string" }, { "name": "Tag", "type": "string", "required": false, "description": "扩展字段", "example": "time" } ], "required": [ "InstanceId", "ApplicationId", "TimeGranularity", "From", "To", "RequiredPictures" ] }, { "name": "DescribeLaneRules", "description": "查询灰度发布规则列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为500。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "SearchWord", "type": "string", "required": false, "description": "搜索关键词。", "example": "app_lane" }, { "name": "RuleId", "type": "string", "required": false, "description": "灰度发布规则ID。该参数可以通过调用 [DescribeLaneRules](https://cloud.tencent.com/document/product/649/44505) 的返回值中的 RuleId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?tab=grayscale\u0026subTab=lanerule)查看；也可以调用[CreateLaneRule](https://cloud.tencent.com/document/product/649/44507)创建新的灰度发布规则。", "example": "lane-r-v6ewp385" }, { "name": "RuleIdList", "type": "array", "required": false, "description": "灰度发布规则ID。该参数可以通过调用 [DescribeLaneRules](https://cloud.tencent.com/document/product/649/44505) 的返回值中的 RuleId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?tab=grayscale\u0026subTab=lanerule)查看；也可以调用[CreateLaneRule](https://cloud.tencent.com/document/product/649/44507)创建新的灰度发布规则。", "example": "[\"lane-r-v6ewp385\"]", "item_type": "string" }, { "name": "QueryAll", "type": "boolean", "required": false, "description": "查询全部标记", "example": "false" } ], "required": [] }, { "name": "DescribeLanes", "description": "查询泳道配置列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "SearchWord", "type": "string", "required": false, "description": "搜索关键字。", "example": "lane_name" }, { "name": "LaneIdList", "type": "array", "required": false, "description": "泳道配置ID。该参数可以通过调用 [DescribeLanes](https://cloud.tencent.com/document/product/649/44504) 的返回值中的 LaneId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?tab=grayscale\u0026subTab=lane)查看；也可以调用[CreateLane](https://cloud.tencent.com/document/product/649/44508)创建新的泳道配置。", "example": "[\"lane-ynmlnwm4\"]", "item_type": "string" }, { "name": "DisableProgramAuthCheck", "type": "boolean", "required": false, "description": "忽略传参，业务预留字段。", "example": "true" } ], "required": [] }, { "name": "DescribeLicenses", "description": "查询许可列表", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页条数", "example": "1" } ], "required": [] }, { "name": "DescribeLogCapacity", "description": "获取用户日志使用量", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeMicroservice", "description": "查询微服务详情", "status": "online", "parameters": [ { "name": "MicroserviceId", "type": "string", "required": true, "description": "微服务ID。该参数可以通过调用 [DescribeMicroservices](https://cloud.tencent.com/document/product/649/36084) 的返回值中的 MicroserviceId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?tab=service)查看；也可以调用[CreateMicroserviceWithDetailResp](https://cloud.tencent.com/document/product/649/85860)创建新的微服务。", "example": "ms-a78gk87b" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为50。", "example": "20" }, { "name": "GroupIds", "type": "array", "required": false, "description": "部署组ID。该参数可以通过调用 [DescribeSimpleGroups](https://cloud.tencent.com/document/product/649/36064) 的返回值中的 GroupId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/resource)-查看部署组页查看；也可以调用[CreateGroup](https://cloud.tencent.com/document/product/649/36074)创建新的部署组。", "example": "[\"group-yx87px4a\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。多个 filter 之间是与关系，单个 filter 多个 value 之间是或关系。 参考：[{\"Name\":\"LanIp\",\"Values\":[\"172.16.16.139\"]}] filter name 取值范围： - id：实例ID - name：实例名 - lan-ip：内网IP - node-ip：所在节点IP", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤条件名", "example": "host" }, { "name": "Values", "type": "array", "required": true, "description": "过滤条件匹配值，几个条件间是或关系", "example": "[\"metadata.host\"]", "item_type": "string" } ] } ], "required": [ "MicroserviceId" ] }, { "name": "DescribeMicroservices", "description": "获取微服务列表", "status": "online", "parameters": [ { "name": "NamespaceId", "type": "string", "required": true, "description": "命名空间ID。该参数可以通过调用 [DescribeSimpleNamespaces](https://cloud.tencent.com/document/api/649/36096) 的返回值中的 NamespaceId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/resource?tab=namespace)查看；也可以调用[CreateNamespace](https://cloud.tencent.com/document/product/649/36098)创建新的命名空间。", "example": "namespace-v6b2exey" }, { "name": "SearchWord", "type": "string", "required": false, "description": "搜索字段。", "example": "serviceName" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序字段。 - create_time：创建时间 默认为创建时间，暂不支持其他值。", "example": "create_time" }, { "name": "OrderType", "type": "integer", "required": false, "description": "排序类型。 - 1：倒序 默认为倒序，暂不支持其他值。", "example": "1" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为50。", "example": "20" }, { "name": "Status", "type": "array", "required": false, "description": "状态。 - online：在线 - offline：离线 - single_online：单点在线", "example": "[\"single_online\"]", "item_type": "string" }, { "name": "MicroserviceIdList", "type": "array", "required": false, "description": "微服务ID列表。该参数可以通过调用 [DescribeMicroservices](https://cloud.tencent.com/document/product/649/36084) 的返回值中的 MicroserviceId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?tab=service)查看；也可以调用[CreateMicroserviceWithDetailResp](https://cloud.tencent.com/document/product/649/85860)创建新的微服务。", "example": "[\"ms-yqwbbpxl\"]", "item_type": "string" }, { "name": "MicroserviceNameList", "type": "array", "required": false, "description": "微服务名称列表。该参数可以通过调用 [DescribeMicroservices](https://cloud.tencent.com/document/product/649/36084) 的返回值中的 MicroserviceName 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?tab=service)查看；也可以调用[CreateMicroserviceWithDetailResp](https://cloud.tencent.com/document/product/649/85860)创建新的微服务。", "example": "[\"consumer-demo\"]", "item_type": "string" }, { "name": "ConfigCenterInstanceId", "type": "string", "required": false, "description": "注册中心实例ID。业务预留参数，忽略传参。", "example": "ins-ac69c57e" } ], "required": [ "NamespaceId" ] }, { "name": "DescribeMicroservicesByGroupIds", "description": "通过部署组ID获取微服务", "status": "online", "parameters": [ { "name": "GroupIds", "type": "array", "required": true, "description": "部署组ID列表。该参数可以通过调用 [DescribeSimpleGroups](https://cloud.tencent.com/document/product/649/36064) 的返回值中的 GroupId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/resource)-查看部署组页查看；也可以调用[CreateGroup](https://cloud.tencent.com/document/product/649/36074)创建新的部署组。", "example": "[\"group-6a7eb39y\",\"group-nalb5dwv\"]", "item_type": "string" } ], "required": [ "GroupIds" ] }, { "name": "DescribeMsApiList", "description": "查询服务API列表", "status": "online", "parameters": [ { "name": "MicroserviceId", "type": "string", "required": true, "description": "微服务ID。该参数可以通过调用 [DescribeMicroservices](https://cloud.tencent.com/document/product/649/36084) 的返回值中的 MicroserviceId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?tab=service)查看；也可以调用[CreateMicroserviceWithDetailResp](https://cloud.tencent.com/document/product/649/85860)创建新的微服务。", "example": "ms-y5w8n5e9" }, { "name": "SearchWord", "type": "string", "required": false, "description": "搜索关键字。", "example": "echo-feign-url" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为50。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" } ], "required": [ "MicroserviceId" ] }, { "name": "DescribeOverviewInvocation", "description": "服务调用监控统计概览", "status": "online", "parameters": [ { "name": "NamespaceId", "type": "string", "required": false, "description": "命名空间ID， 此参数必填 可通过[DescribeSimpleNamespaces](https://cloud.tencent.com/document/product/649/36096)查询已经创建的命名空间，也可以通过登录[控制台](https://console.cloud.tencent.com/tsf/resource?rid=1\u0026tab=namespace)查看", "example": "namespace-xxx" }, { "name": "Type", "type": "string", "required": false, "description": "监控统计类型，必填，取值范围 SumReqAmount：请求量，AvgFailureRate：请求错误率，AvgTimeCost：平均响应耗时", "example": "SumReqAmount" }, { "name": "Period", "type": "integer", "required": false, "description": "监控统计数据粒度，可选值：60、3600、86400，分别对应1分钟、1小时、1天", "example": "60" }, { "name": "StartTime", "type": "string", "required": false, "description": "查询开始时间，格式为yyyy-MM-dd HH:mm:ss，默认为当天的 00:00:00", "example": "2019-05-28 17:45:43" }, { "name": "EndTime", "type": "string", "required": false, "description": "查询结束时间，格式为yyyy-MM-dd HH:mm:ss，默认为当前时间", "example": "2019-05-29 17:45:43" } ], "required": [] }, { "name": "DescribePathRewrite", "description": "查询路径重写", "status": "online", "parameters": [ { "name": "PathRewriteId", "type": "string", "required": true, "description": "路径重写规则ID", "example": "rewrite-2vz5pdwv" } ], "required": [ "PathRewriteId" ] }, { "name": "DescribePathRewrites", "description": "查询路径重写列表", "status": "online", "parameters": [ { "name": "GatewayGroupId", "type": "string", "required": true, "description": "网关部署组ID", "example": "group-yd3b588a" }, { "name": "SearchWord", "type": "string", "required": false, "description": "根据正则表达式或替换的内容模糊查询", "example": "app" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页数量", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "起始偏移量", "example": "0" } ], "required": [ "GatewayGroupId" ] }, { "name": "DescribePkgs", "description": "无", "status": "online", "parameters": [ { "name": "ApplicationId", "type": "string", "required": true, "description": "应用ID，通过调用DescribeApplications接口[获取应用列表](https://cloud.tencent.com/document/api/649/36090)从而获取应用ID，或登录[控制台](https://console.cloud.tencent.com/tsf/app?rid=1)进行查看，调用CreateApplication接口[创建应用](https://cloud.tencent.com/document/product/649/36094)时的返回值", "example": "application-6a79x94v" }, { "name": "SearchWord", "type": "string", "required": false, "description": "查询关键字（支持根据包ID，包名，包版本号搜索）", "example": "demoApp" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序关键字（默认值\"UploadTime\"），允许值：\"UploadTime\"上传时间, \"name\"程序包名, \"size\"应用大小, \"id\"程序包ID", "example": "UploadTime" }, { "name": "OrderType", "type": "integer", "required": false, "description": "升序：0/降序：1（默认降序）", "example": "1" }, { "name": "Offset", "type": "integer", "required": false, "description": "查询起始偏移，大于等于0，默认值为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量限制", "example": "50" }, { "name": "RepositoryType", "type": "string", "required": false, "description": "程序包仓库类型，允许值：\"public-demo\"TSF公共demo仓库, \"private\"自定义仓库, \"default\"TSF公共仓库", "example": "private" }, { "name": "RepositoryId", "type": "string", "required": false, "description": "仓库ID，可通过调用[仓库信息查询类](https://cloud.tencent.com/document/api/649/45925)接口时出参中的RepositoryId，或登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看", "example": "tcr-6a79x94v" }, { "name": "PackageTypeList", "type": "array", "required": false, "description": "程序包类型数组支持（fatjar jar war tar.gz zip）", "example": "[\"jar\"]", "item_type": "string" } ], "required": [ "ApplicationId" ] }, { "name": "DescribePluginInstances", "description": "分页查询网关分组/API绑定（或未绑定）的插件列表", "status": "online", "parameters": [ { "name": "ScopeValue", "type": "string", "required": true, "description": "分组或者API的ID", "example": "grp-v446jrhc" }, { "name": "Offset", "type": "integer", "required": true, "description": "翻页偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "每页展示的条数", "example": "10" }, { "name": "Bound", "type": "boolean", "required": false, "description": "绑定: true; 未绑定: false", "example": "true" }, { "name": "Type", "type": "string", "required": false, "description": "插件类型", "example": "QQMiniProgramLogin" }, { "name": "SearchWord", "type": "string", "required": false, "description": "搜索关键字", "example": "pgnName" } ], "required": [ "ScopeValue", "Offset", "Limit" ] }, { "name": "DescribePodInstances", "description": "获取部署组实例列表", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "部署组ID，可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/api/649/36068)查询已创建的部署组列表或登录控制台进行查看；也可以调用[CreateContainGroup](https://cloud.tencent.com/document/api/649/36075)创建新的部署组。", "example": "group-df3fsd23" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，取值从0开始", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页个数，默认为20， 取值应为1~50", "example": "1" }, { "name": "PodNameList", "type": "array", "required": false, "description": "用于通过PodName字段过滤返回结果。", "example": "[\"test-consume-88f4974c9-gz8gk\"]", "item_type": "string" }, { "name": "DeployVersion", "type": "string", "required": false, "description": "新老版本pod批次标识，old表示老版本，new表示新版本。", "example": "old" }, { "name": "TaskId", "type": "string", "required": false, "description": "实例所属任务ID，登录控制台进行查看。", "example": "task-xxx" } ], "required": [ "GroupId" ] }, { "name": "DescribePrograms", "description": "查询数据集列表", "status": "online", "parameters": [ { "name": "SearchWord", "type": "string", "required": false, "description": "模糊查询数据集ID，数据集名称，不传入时查询全量", "example": "program-xxx" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页数量，默认值20", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "起始偏移量，默认值0", "example": "0" } ], "required": [] }, { "name": "DescribePublicConfig", "description": "查询公共配置（单条）", "status": "online", "parameters": [ { "name": "ConfigId", "type": "string", "required": true, "description": "需要查询的配置ID。该参数可以通过调用 [DescribePublicConfigs](https://cloud.tencent.com/document/product/649/38335) 的返回值中的 ConfigId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=public)配置详情-配置版本页查看；也可以调用[CreatePublicConfig](https://cloud.tencent.com/document/product/649/38347)创建新的配置。", "example": "dcfg-p-vkj5dnky" } ], "required": [ "ConfigId" ] }, { "name": "DescribePublicConfigReleaseLogs", "description": "查询公共配置发布历史", "status": "online", "parameters": [ { "name": "NamespaceId", "type": "string", "required": false, "description": "命名空间ID，不传入时查询全量。该参数可以通过调用 [DescribeSimpleNamespaces](https://cloud.tencent.com/document/api/649/36096) 的返回值中的 NamespaceId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/resource?tab=namespace)查看；也可以调用[CreateNamespace](https://cloud.tencent.com/document/product/649/36098)创建新的命名空间。", "example": "namespace-vj3z3zgy" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "10" } ], "required": [] }, { "name": "DescribePublicConfigReleases", "description": "查询公共配置发布信息", "status": "online", "parameters": [ { "name": "ConfigName", "type": "string", "required": false, "description": "配置名称，不传入时查询全量。该参数可以通过调用 [DescribePublicConfigs](https://cloud.tencent.com/document/product/649/38335) 的返回值中的 ConfigName 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=public)配置详情-配置版本页查看；也可以调用[CreatePublicConfig](https://cloud.tencent.com/document/product/649/38347)创建新的配置。", "example": "configName" }, { "name": "NamespaceId", "type": "string", "required": false, "description": "命名空间ID，不传入时查询全量。该参数可以通过调用 [DescribeSimpleNamespaces](https://cloud.tencent.com/document/api/649/36096) 的返回值中的 NamespaceId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/resource?tab=namespace)查看；也可以调用[CreateNamespace](https://cloud.tencent.com/document/product/649/36098)创建新的命名空间。", "example": "namespace-yxoqm4ky" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "ConfigId", "type": "string", "required": false, "description": "配置项ID，不传入时查询全量。该参数可以通过调用 [DescribePublicConfigs](https://cloud.tencent.com/document/product/649/38335) 的返回值中的 ConfigId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=public)配置详情-配置版本页查看；也可以调用[CreatePublicConfig](https://cloud.tencent.com/document/product/649/38347)创建新的配置。", "example": "dcfg-p-v6kxdlpy" } ], "required": [] }, { "name": "DescribePublicConfigSummary", "description": "查询公共配置汇总列表", "status": "online", "parameters": [ { "name": "SearchWord", "type": "string", "required": false, "description": "查询关键字，模糊查询：配置项名称，不传入时查询全量。", "example": "configName" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为50。", "example": "20" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序字段。 - creation_time：按时间排序 - config_name：按名称排序", "example": "creation_time" }, { "name": "OrderType", "type": "integer", "required": false, "description": "排序顺序。 - 0：升序 - 1：降序", "example": "1" }, { "name": "ConfigTagList", "type": "array", "required": false, "description": "TAG标签资源值。", "example": "[\"app-config\"]", "item_type": "string" }, { "name": "DisableProgramAuthCheck", "type": "boolean", "required": false, "description": "忽略传参，业务预留字段。", "example": "true" }, { "name": "ConfigIdList", "type": "array", "required": false, "description": "配置ID。该参数可以通过调用 [DescribePublicConfigs](https://cloud.tencent.com/document/product/649/38335) 的返回值中的 ConfigId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=public)配置详情-配置版本页查看；也可以调用[CreatePublicConfig](https://cloud.tencent.com/document/product/649/38347)创建新的配置。", "example": "[\"dcfg-p-vkj5dnky\"]", "item_type": "string" } ], "required": [] }, { "name": "DescribePublicConfigs", "description": "查询公共配置项列表", "status": "online", "parameters": [ { "name": "ConfigId", "type": "string", "required": false, "description": "配置ID。不传入时查询全量，高优先级。该参数可以通过调用 [DescribePublicConfigs](https://cloud.tencent.com/document/product/649/38335) 的返回值中的 ConfigId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=public)配置详情-配置版本页查看；也可以调用[CreatePublicConfig](https://cloud.tencent.com/document/product/649/38347)创建新的配置。", "example": "dcfg-p-id001" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "50" }, { "name": "ConfigIdList", "type": "array", "required": false, "description": "配置ID列表，不传入时查询全量，低优先级。该参数可以通过调用 [DescribePublicConfigs](https://cloud.tencent.com/document/product/649/38335) 的返回值中的 ConfigId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=public)配置详情-配置版本页查看；也可以调用[CreatePublicConfig](https://cloud.tencent.com/document/product/649/38347)创建新的配置。", "example": "[\"dcfg-p-id001\"]", "item_type": "string" }, { "name": "ConfigName", "type": "string", "required": false, "description": "配置项名称，精确查询，不传入时查询全量。", "example": "global" }, { "name": "ConfigVersion", "type": "string", "required": false, "description": "配置项版本，精确查询，不传入时查询全量。", "example": "v1" } ], "required": [] }, { "name": "DescribeReleasedConfig", "description": "查询部署组发布的配置", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "部署组ID。该参数可以通过调用 [DescribeSimpleGroups](https://cloud.tencent.com/document/product/649/36064) 的返回值中的 GroupId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/resource)-查看部署组页查看；也可以调用[CreateGroup](https://cloud.tencent.com/document/product/649/36074)创建新的部署组。", "example": "group-jy9re3gy" } ], "required": [ "GroupId" ] }, { "name": "DescribeRepositories", "description": "查询仓库列表", "status": "online", "parameters": [ { "name": "SearchWord", "type": "string", "required": false, "description": "查询关键字（按照仓库名称搜索）", "example": "demo" }, { "name": "Offset", "type": "integer", "required": false, "description": "查询起始偏移，大于等于0，默认值为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量限制，大于0，默认为不分页", "example": "10" }, { "name": "RepositoryType", "type": "string", "required": false, "description": "仓库类型（默认仓库：default，私有仓库：private，公共仓库：public-demo）", "example": "private" } ], "required": [] }, { "name": "DescribeRepository", "description": "查询仓库信息", "status": "online", "parameters": [ { "name": "RepositoryId", "type": "string", "required": true, "description": "仓库ID，可通过调用[仓库信息查询类](https://cloud.tencent.com/document/api/649/45925)接口时出参中的RepositoryId，或登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看", "example": "application-6a79x94v" } ], "required": [ "RepositoryId" ] }, { "name": "DescribeResourceConfig", "description": "无", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeResourceTaskStatus", "description": "资源任务的执行状态描述接口", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "容器实例任务ID，可通过调用 [DeployContainerGroup](https://cloud.tencent.com/document/product/649/120669) 部署容器应用，查询其返回内容中的任务ID。", "example": "task-6a79x94v" } ], "required": [ "TaskId" ] }, { "name": "DescribeSimpleApplications", "description": "查询简单应用列表", "status": "online", "parameters": [ { "name": "ApplicationIdList", "type": "array", "required": false, "description": "应用ID列表，可通过调用[DescribeApplications](https://cloud.tencent.com/document/api/649/36090)查询已创建的应用列表或登录控制台进行查看；也可以调用[CreateApplication](https://cloud.tencent.com/document/api/649/36094)创建新的应用。", "example": "[\"application-6a79x94v\"]", "item_type": "string" }, { "name": "ApplicationType", "type": "string", "required": false, "description": "指定应用类型，目前支持： - `V`：普通应用/CVM应用 - `C`：容器应用 - `S`：serverless 应用", "example": "C" }, { "name": "Limit", "type": "integer", "required": false, "description": "数量限制，默认为20，最大值为100。关于Limit详见[API简介](https://cloud.tencent.com/document/api/213/568#.E8.BE.93.E5.85.A5.E5.8F.82.E6.95.B0.E4.B8.8E.E8.BF.94.E5.9B.9E.E5.8F.82.E6.95.B0.E9.87.8A.E4.B9.89)", "example": "50" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。关于Offset详见[API简介](https://cloud.tencent.com/document/api/213/568#.E8.BE.93.E5.85.A5.E5.8F.82.E6.95.B0.E4.B8.8E.E8.BF.94.E5.9B.9E.E5.8F.82.E6.95.B0.E9.87.8A.E4.B9.89)", "example": "50" }, { "name": "MicroserviceType", "type": "string", "required": false, "description": "微服务类型", "example": "N" }, { "name": "ApplicationResourceTypeList", "type": "array", "required": false, "description": "应用资源类型列表；DEF 表示默认资源类型；GW 表示网关资源类型", "example": "[\"GW\"]", "item_type": "string" }, { "name": "SearchWord", "type": "string", "required": false, "description": "通过id和name进行关键词过滤", "example": "demo" }, { "name": "DisableProgramAuthCheck", "type": "boolean", "required": false, "description": "是否关闭鉴权查询", "example": "true" }, { "name": "MicroserviceTypeList", "type": "array", "required": false, "description": "查询指定微服务类型的应用列表", "example": "[\"N\"]", "item_type": "string" } ], "required": [] }, { "name": "DescribeSimpleClusters", "description": "查询简单集群列表", "status": "online", "parameters": [ { "name": "ClusterIdList", "type": "array", "required": false, "description": "需要查询的集群ID列表，不填或不传入时查询所有内容", "example": "[\"cluster-6a79x94v\"]", "item_type": "string" }, { "name": "ClusterType", "type": "string", "required": false, "description": "需要查询的集群类型，不填或不传入时查询所有内容", "example": "C" }, { "name": "Offset", "type": "integer", "required": false, "description": "查询偏移量，默认为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页个数，默认为20， 取值应为1~50", "example": "50" }, { "name": "SearchWord", "type": "string", "required": false, "description": "对id和name进行关键词过滤", "example": "cls-demo" }, { "name": "DisableProgramAuthCheck", "type": "boolean", "required": false, "description": "是否关闭鉴权", "example": "false" } ], "required": [] }, { "name": "DescribeSimpleGroups", "description": "查询简单部署组列表", "status": "online", "parameters": [ { "name": "GroupIdList", "type": "array", "required": false, "description": "按照【部署组ID】进行过滤，不填写时查询全量。可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/product/649/36068)查询已创建的部署组列表或登录[控制台](https://console.cloud.tencent.com/tsf/app-detail?rid=1\u0026id=application-zvw6zp9a\u0026tab=publish\u0026subTab=group)进行查看；也可以调用[CreateGroup](https://cloud.tencent.com/document/product/649/36074)创建新的部署组。", "example": "[\"group-6a79x94v\"]", "item_type": "string" }, { "name": "ApplicationId", "type": "string", "required": false, "description": "按照【应用ID】进行过滤，不填写时查询全量。可通过调用[DescribeApplications](https://cloud.tencent.com/document/product/649/36090)查询已创建的应用列表或登录[控制台](https://console.cloud.tencent.com/tsf/app?rid=1)进行查看；也可以调用[CreateApplication](https://cloud.tencent.com/document/product/649/36094)创建新的应用。", "example": "application-6a79x94v" }, { "name": "ClusterId", "type": "string", "required": false, "description": "按照【集群ID】进行过滤，不填写时查询全量。可通过调用[DescribeClusters](https://cloud.tencent.com/document/product/649/85857)查询已创建的集群列表或登录[控制台](https://console.cloud.tencent.com/tsf/resource?rid=1\u0026tab=docker)进行查看；也可以调用[CreateCluster](https://cloud.tencent.com/document/product/649/36049)创建新的集群。", "example": "cls-6a79x94v" }, { "name": "NamespaceId", "type": "string", "required": false, "description": "按照【命名空间ID】进行过滤，不填写时查询全量。可通过调用[DescribeSimpleNamespaces](https://cloud.tencent.com/document/product/649/36096)查询已创建的命名空间列表或登录[控制台](https://console.cloud.tencent.com/tsf/resource?rid=1\u0026tab=namespace)进行查看；也可以调用[CreateNamespace](https://cloud.tencent.com/document/product/649/36098)创建新的命名空间。", "example": "namespace-6a79x94v" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页条数，默认值20，无上限", "example": "50" }, { "name": "Offset", "type": "integer", "required": false, "description": "起始偏移量，默认值0", "example": "0" }, { "name": "GroupId", "type": "string", "required": false, "description": "部署组ID，不填写时查询全量", "example": "group-6a79x94v" }, { "name": "SearchWord", "type": "string", "required": false, "description": "模糊查询，部署组名称，不填写时查询全量", "example": "group-demo" }, { "name": "AppMicroServiceType", "type": "string", "required": false, "description": "部署组类型，精确过滤字段，M：service mesh, P：原生应用， G：网关应用", "example": "N" }, { "name": "GroupName", "type": "string", "required": false, "description": "按照【部署组名称】进行过滤，不填写时查询全量。可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/product/649/36068)查询已创建的部署组列表或登录[控制台](https://console.cloud.tencent.com/tsf/app-detail?rid=1\u0026id=application-zvw6zp9a\u0026tab=publish\u0026subTab=group)进行查看；也可以调用[CreateGroup](https://cloud.tencent.com/document/product/649/36074)创建新的部署组。", "example": "test-group" } ], "required": [] }, { "name": "DescribeSimpleNamespaces", "description": "查询简单命名空间列表", "status": "online", "parameters": [ { "name": "NamespaceIdList", "type": "array", "required": false, "description": "命名空间ID列表，按照【命名空间ID列表】进行过滤，可通过调用[DescribeNamespaces](https://cloud.tencent.com/document/product/649/36096)查询已创建的命名空间列表或登录控制台进行查看；也可以调用[CreateNamespace](https://cloud.tencent.com/document/product/649/36098)创建新的命名空间。", "example": "[\"namespace-6a79x94v\"]", "item_type": "string" }, { "name": "ClusterId", "type": "string", "required": false, "description": "集群ID，按照【集群ID】进行过滤，可通过调用[DescribeClusters](https://cloud.tencent.com/document/product/649/85857)查询已创建的集群列表或登录控制台进行查看；也可以调用[CreateCluster](https://cloud.tencent.com/document/product/649/36049)创建新的集群。仅在集群下无部署组、命名空间、云主机时可以删除。", "example": "cls-6a79x94v" }, { "name": "Limit", "type": "integer", "required": false, "description": "数量限制，默认为20，最大值为100。关于Limit详见[API简介](https://cloud.tencent.com/document/api/213/568#.E8.BE.93.E5.85.A5.E5.8F.82.E6.95.B0.E4.B8.8E.E8.BF.94.E5.9B.9E.E5.8F.82.E6.95.B0.E9.87.8A.E4.B9.89)", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。关于Offset详见[API简介](https://cloud.tencent.com/document/api/213/568#.E8.BE.93.E5.85.A5.E5.8F.82.E6.95.B0.E4.B8.8E.E8.BF.94.E5.9B.9E.E5.8F.82.E6.95.B0.E9.87.8A.E4.B9.89)", "example": "0" }, { "name": "NamespaceId", "type": "string", "required": false, "description": "命名空间ID，按照【命名空间ID】进行过滤，可通过调用[DescribeNamespaces](https://cloud.tencent.com/document/product/649/36096)查询已创建的命名空间列表或登录控制台进行查看；也可以调用[CreateNamespace](https://cloud.tencent.com/document/product/649/36098)创建新命名空间。", "example": "namespace-6a79x94v" }, { "name": "NamespaceResourceTypeList", "type": "array", "required": false, "description": "查询资源类型列表；DEF 表示默认资源类型；GW 表示网关资源类型", "example": "[\"GW\"]", "item_type": "string" }, { "name": "SearchWord", "type": "string", "required": false, "description": "通过id和name进行过滤", "example": "appName" }, { "name": "NamespaceTypeList", "type": "array", "required": false, "description": "查询的命名空间类型列表。DEF：默认普通命名空间。GLOBAL：全局命名空间。", "example": "[\"GLOBAL\"]", "item_type": "string" }, { "name": "NamespaceName", "type": "string", "required": false, "description": "通过命名空间名精确过滤", "example": "name" }, { "name": "IsDefault", "type": "string", "required": false, "description": "通过是否是默认命名空间过滤，不传表示拉取全部命名空间。0：默认命名空间。1：非默认命名空间。", "example": "0" }, { "name": "DisableProgramAuthCheck", "type": "boolean", "required": false, "description": "是否关闭鉴权查询", "example": "false" } ], "required": [] }, { "name": "DescribeStatistics", "description": "服务统计页面：接口和服务维度", "status": "online", "parameters": [ { "name": "Type", "type": "string", "required": true, "description": "统计类型。可选值 Interface：接口类型、Service：服务类型、Group：部署组类型、Instance：实例类型、SQL：SQL类型、NoSQL：NoSQL类型", "example": "Interface" }, { "name": "TimeStep", "type": "integer", "required": true, "description": "步长，单位秒。可选值 60、3600、86400", "example": "60" }, { "name": "Offset", "type": "integer", "required": true, "description": "偏移量，取值范围大于等于0，默认值为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "单页请求配置数量，取值范围[1, 50]，默认值为10", "example": "50" }, { "name": "NamespaceId", "type": "string", "required": false, "description": "命名空间ID。此字段，和 NamespaceIdList 或者 MetricDimensionValues 字段包含 namespaceId 维度信息。三者选其一。 可通过[DescribeSimpleNamespaces](https://cloud.tencent.com/document/product/649/36096)查询已经创建的命名空间，也可以通过登录[控制台](https://console.cloud.tencent.com/tsf/resource?rid=1\u0026tab=namespace)查看", "example": "namespace-6a79x94v" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序字段:AvgTimeConsuming[默认]、RequestCount、ErrorRate。实例监控还支持 CpuPercent", "example": "AvgTimeConsuming" }, { "name": "OrderType", "type": "integer", "required": false, "description": "排序方式：ASC:0、DESC:1", "example": "1" }, { "name": "EndTime", "type": "string", "required": false, "description": "开始时间：年月日 时分秒2020-05-12 14:43:12， 不能为空", "example": "2020-05-12 14:43:12" }, { "name": "StartTime", "type": "string", "required": false, "description": "开始时间：年月日 时分秒2020-05-12 14:43:12， 不能为空", "example": "2020-05-12 14:42:12" }, { "name": "ServiceName", "type": "string", "required": false, "description": "服务名称", "example": "demo-service" }, { "name": "SearchWord", "type": "string", "required": false, "description": "搜索关键词", "example": "demo" }, { "name": "MetricDimensionValues", "type": "array", "required": false, "description": "维度。此字段，和 NamespaceIdList 或者 MetricDimensionValues 字段包含 namespaceId 维度信息。三者选其一", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "维度名", "example": "NamespaceId" }, { "name": "Value", "type": "array", "required": true, "description": "维度值", "example": "[\"namespace-xxxxxxxx\"]", "item_type": "string" } ] }, { "name": "BucketKey", "type": "string", "required": false, "description": "聚合关键词", "example": "application" }, { "name": "DbName", "type": "string", "required": false, "description": "数据库名称", "example": "tsf_demo" }, { "name": "NamespaceIdList", "type": "array", "required": false, "description": "命名空间ID数组。此字段，和 NamespaceIdList 或者 MetricDimensionValues 字段包含 namespaceId 维度信息。三者选其一", "example": "[\"namespace-6a79x94v\"]", "item_type": "string" }, { "name": "ConfigCenterInstanceId", "type": "string", "required": false, "description": "独占配置中心的ID。 可通过调用[DescribeClusterInstances](https://cloud.tencent.com/document/product/649/36048)查询已导入的实例列表或登录[控制台](https://console.cloud.tencent.com/tsf/resource?rid=1\u0026tab=instance)进行查询。实例ID例如：ins-6decplwk。", "example": "ins-6a79x94v" }, { "name": "ServiceFilter", "type": "string", "required": false, "description": "服务过滤", "example": "normal" } ], "required": [ "Type", "TimeStep", "Offset", "Limit" ] }, { "name": "DescribeTaskDetail", "description": "分布式任务调度 TCT 已到达 EOMS 节点，进行产品下线处理。退市公告https://cloud.tencent.com/announce/detail/2053 查询任务详情", "status": "deprecated", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页第一列和任务基本信息页查看任务ID。", "example": "task-jzdv5qao" }, { "name": "TaskLogId", "type": "string", "required": false, "description": "任务历史ID。查询任务列表 [DescribeTaskRecords](https://cloud.tencent.com/document/api/649/56136) 返回值字段 TaskLogId", "example": "tlog-zex89wp5" } ], "required": [ "TaskId" ] }, { "name": "DescribeTaskLastStatus", "description": "分布式任务调度 TCT 已到达 EOMS 节点，进行产品下线处理。退市公告https://cloud.tencent.com/announce/detail/2053 查询任务最近一次执行状态", "status": "deprecated", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页第一列和任务基本信息页查看任务ID。", "example": "task-6a79x94v" } ], "required": [ "TaskId" ] }, { "name": "DescribeTaskRecords", "description": "分布式任务调度 TCT 已到达 EOMS 节点，进行产品下线处理。退市公告https://cloud.tencent.com/announce/detail/2053 翻页查询任务列表", "status": "deprecated", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "翻页偏移量。默认值为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "翻页查询单页数量。默认值为 20，最大值为 1000", "example": "10" }, { "name": "SearchWord", "type": "string", "required": false, "description": "模糊查询关键字，支持任务ID和任务名称。", "example": "taskName" }, { "name": "TaskState", "type": "string", "required": false, "description": "任务启用状态。一共2种状态可选，ENABLED：启用，DISABLED：停用", "example": "enabled" }, { "name": "GroupId", "type": "string", "required": false, "description": "部署组ID。前往[应用管理](https://console.cloud.tencent.com/tsf/app?rid=1)点击应用ID进入应用部署列表页面获取部署组ID。", "example": "group-abl8j7xy" }, { "name": "TaskType", "type": "string", "required": false, "description": "任务类型。当前只支持一种任务类型。枚举值，java：Java类任务", "example": "java" }, { "name": "ExecuteType", "type": "string", "required": false, "description": "任务执行方式，unicast：随机单节点执行，broadcast：广播执行，shard：分片执行", "example": "unicast" }, { "name": "Ids", "type": "array", "required": false, "description": "任务ID列表。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页第一列查看任务ID。", "example": "[\"task-6a79x94v\"]", "item_type": "string" } ], "required": [] }, { "name": "DescribeUnitApiUseDetail", "description": "查询网关API监控明细数据（仅单元化网关），非单元化网关使用DescribeApiUseDetail", "status": "online", "parameters": [ { "name": "GatewayDeployGroupId", "type": "string", "required": true, "description": "网关部署组ID", "example": "group-i54lzdrq" }, { "name": "ApiId", "type": "string", "required": true, "description": "网关分组Api ID", "example": "api-qabo8xyl" }, { "name": "StartTime", "type": "string", "required": true, "description": "查询的日期,格式：yyyy-MM-dd HH:mm:ss", "example": "2020-09-22 00:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "查询的日期,格式：yyyy-MM-dd HH:mm:ss", "example": "2020-09-22 00:00:00" }, { "name": "GatewayInstanceId", "type": "string", "required": true, "description": "网关实例ID", "example": "gw-ins-4hkjbwxy" }, { "name": "GroupId", "type": "string", "required": true, "description": "网关分组ID", "example": "grp-vcgimq3x" }, { "name": "Offset", "type": "integer", "required": true, "description": "翻页查询偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "翻页查询每页记录数", "example": "20" }, { "name": "Period", "type": "integer", "required": false, "description": "监控统计数据粒度", "example": "60" } ], "required": [ "GatewayDeployGroupId", "ApiId", "StartTime", "EndTime", "GatewayInstanceId", "GroupId", "Offset", "Limit" ] }, { "name": "DescribeUnitNamespaces", "description": "查询单元化命名空间列表", "status": "online", "parameters": [ { "name": "GatewayInstanceId", "type": "string", "required": true, "description": "网关实体ID", "example": "gw-ins-szesmg28" }, { "name": "SearchWord", "type": "string", "required": false, "description": "根据命名空间名或ID模糊查询", "example": "global" }, { "name": "Offset", "type": "integer", "required": false, "description": "翻页查询偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "翻页查询每页记录数", "example": "10" } ], "required": [ "GatewayInstanceId" ] }, { "name": "DescribeUnitRule", "description": "查询单元化规则详情", "status": "online", "parameters": [ { "name": "Id", "type": "string", "required": true, "description": "单元化规则ID", "example": "unit-rl-cgd3l6jo" } ], "required": [ "Id" ] }, { "name": "DescribeUnitRules", "description": "查询单元化规则列表", "status": "online", "parameters": [ { "name": "GatewayInstanceId", "type": "string", "required": true, "description": "网关实体ID", "example": "gw-ins-szesmg28" }, { "name": "SearchWord", "type": "string", "required": false, "description": "根据规则名或备注内容模糊查询", "example": "gwInsName" }, { "name": "Status", "type": "string", "required": false, "description": "启用状态, disabled: 未发布， enabled: 发布", "example": "disabled" }, { "name": "Offset", "type": "integer", "required": false, "description": "翻页查询偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "翻页查询每页记录数", "example": "10" } ], "required": [ "GatewayInstanceId" ] }, { "name": "DescribeUnitRulesV2", "description": "查询单元化规则列表V2", "status": "online", "parameters": [ { "name": "GatewayInstanceId", "type": "string", "required": true, "description": "网关实体ID", "example": "gw-ins-szesmg28" }, { "name": "SearchWord", "type": "string", "required": false, "description": "根据规则名或备注内容模糊查询", "example": "gwInsName" }, { "name": "Status", "type": "string", "required": false, "description": "启用状态, disabled: 未发布， enabled: 发布", "example": "disabled" }, { "name": "Offset", "type": "integer", "required": false, "description": "翻页查询偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "翻页查询每页记录数", "example": "10" } ], "required": [ "GatewayInstanceId" ] }, { "name": "DescribeUploadInfo", "description": "TSF会将软件包上传到腾讯云对象存储（COS）。调用此接口获取上传信息，如目标地域，桶，包Id，存储路径，鉴权信息等，之后请使用COS API（或SDK）进行上传。 请查阅[COS相关文档](https://cloud.tencent.com/document/product/436)", "status": "online", "parameters": [ { "name": "ApplicationId", "type": "string", "required": true, "description": "应用ID，通过调用DescribeApplications接口[获取应用列表](https://cloud.tencent.com/document/api/649/36090)从而获取应用ID，或登录[控制台](https://console.cloud.tencent.com/tsf/app?rid=1)进行查看，调用CreateApplication接口[创建应用](https://cloud.tencent.com/document/product/649/36094)时的返回值", "example": "application-6a79x94v" }, { "name": "PkgName", "type": "string", "required": true, "description": "程序包名", "example": "java-service" }, { "name": "PkgVersion", "type": "string", "required": true, "description": "程序包版本", "example": "v1" }, { "name": "PkgType", "type": "string", "required": true, "description": "程序包类型", "example": "jar" }, { "name": "PkgDesc", "type": "string", "required": false, "description": "程序包介绍", "example": "this is a desc" }, { "name": "RepositoryType", "type": "string", "required": false, "description": "仓库类型（默认仓库：default，私有仓库：private，公共仓库：public-demo）", "example": "private" }, { "name": "RepositoryId", "type": "string", "required": false, "description": "仓库ID，可通过调用[仓库信息查询类](https://cloud.tencent.com/document/api/649/45925)接口时出参中的RepositoryId，或登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看", "example": "repo-6a79x94v" } ], "required": [ "ApplicationId", "PkgName", "PkgVersion", "PkgType" ] }, { "name": "DescribeUsableUnitNamespaces", "description": "查询可用于被导入的命名空间列表", "status": "online", "parameters": [ { "name": "SearchWord", "type": "string", "required": false, "description": "根据命名空间名或ID模糊查询", "example": "nsName" }, { "name": "Offset", "type": "integer", "required": false, "description": "翻页查询偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "翻页查询每页记录数", "example": "10" } ], "required": [] }, { "name": "DisableLaneRule", "description": "禁用灰度发布规则", "status": "online", "parameters": [ { "name": "RuleId", "type": "string", "required": true, "description": "灰度发布规则ID。该参数可以通过调用 [DescribeLaneRules](https://cloud.tencent.com/document/product/649/44505) 的返回值中的 RuleId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?tab=grayscale\u0026subTab=lanerule)查看；也可以调用[CreateLaneRule](https://cloud.tencent.com/document/product/649/44507)创建新的灰度发布规则。", "example": "lane-r-yqg4kmbd" } ], "required": [ "RuleId" ] }, { "name": "DisableTask", "description": "分布式任务调度 TCT 已到达 EOMS 节点，进行产品下线处理。退市公告https://cloud.tencent.com/announce/detail/2053 停用任务", "status": "deprecated", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "任务ID。[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页查看任务ID。", "example": "task-6a79x94v" } ], "required": [ "TaskId" ] }, { "name": "DisableTaskFlow", "description": "分布式任务调度 TCT 已到达 EOMS 节点，进行产品下线处理。退市公告https://cloud.tencent.com/announce/detail/2053 停用工作流", "status": "deprecated", "parameters": [ { "name": "FlowId", "type": "string", "required": true, "description": "工作流 ID。[工作流管理](https://console.cloud.tencent.com/tsf/tct?rid=1\u0026tab=workflowManage)列表页查看工作流ID。", "example": "flow-6a79x94v" } ], "required": [ "FlowId" ] }, { "name": "DisableUnitRoute", "description": "禁用单元化路由", "status": "online", "parameters": [ { "name": "Id", "type": "string", "required": true, "description": "网关实体ID", "example": "gw-ins-szesmg28" } ], "required": [ "Id" ] }, { "name": "DisableUnitRule", "description": "禁用单元化规则", "status": "online", "parameters": [ { "name": "Id", "type": "string", "required": true, "description": "规则ID", "example": "unit-rl-u0643wrg" } ], "required": [ "Id" ] }, { "name": "DisassociateBusinessLogConfig", "description": "取消关联业务日志配置项和应用", "status": "online", "parameters": [ { "name": "ConfigIdList", "type": "array", "required": true, "description": "业务日志配置项ID列表 可通过调用[DescribeBusinessLogConfigs](https://cloud.tencent.com/document/product/649/75777)查询已创建的日志配置项列表或登录[控制台](https://console.cloud.tencent.com/tsf/observable/log?rid=1)进行查看", "example": "[\"apm-busi-log-cfg-6a79x94v\"]", "item_type": "string" }, { "name": "GroupId", "type": "string", "required": true, "description": "部署组ID 可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/product/649/36068)或[DescribeGroups](https://cloud.tencent.com/document/product/649/36065)查询已创建的部署组列表或登录[控制台](https://console.cloud.tencent.com/tsf/app-detail?rid=1\u0026id=application-yo7kp9dv\u0026tab=publish\u0026subTab=group)进行查看", "example": "group-6a79x94v" } ], "required": [ "ConfigIdList", "GroupId" ] }, { "name": "DisassociateKafkaConfig", "description": "取消关联投递信息和部署组", "status": "online", "parameters": [ { "name": "ConfigId", "type": "string", "required": true, "description": "日志配置项ID 可通过调用[DescribeBusinessLogConfigs](https://cloud.tencent.com/document/product/649/75777)查询已创建的日志配置项列表或登录[控制台](https://console.cloud.tencent.com/tsf/observable/log?rid=1)进行查看", "example": "apm-busi-log-cfg-6a79x94v" }, { "name": "GroupIds", "type": "array", "required": false, "description": "部署组ID列表 可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/product/649/36068)或[DescribeGroups](https://cloud.tencent.com/document/product/649/36065)查询已创建的部署组列表或登录[控制台](https://console.cloud.tencent.com/tsf/app-detail?rid=1\u0026id=application-yo7kp9dv\u0026tab=publish\u0026subTab=group)进行查看", "example": "[\"group-6a79x94v\"]", "item_type": "string" } ], "required": [ "ConfigId" ] }, { "name": "DraftApiGroup", "description": "下线Api分组", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "Api 分组ID", "example": "grp-d45mlt3o" } ], "required": [ "GroupId" ] }, { "name": "EnableLaneRule", "description": "启用灰度发布规则", "status": "online", "parameters": [ { "name": "RuleId", "type": "string", "required": true, "description": "灰度发布规则ID。该参数可以通过调用 [DescribeLaneRules](https://cloud.tencent.com/document/product/649/44505) 的返回值中的 RuleId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?tab=grayscale\u0026subTab=lanerule)查看；也可以调用[CreateLaneRule](https://cloud.tencent.com/document/product/649/44507)创建新的灰度发布规则。", "example": "lane-r-yqg4kmbd" } ], "required": [ "RuleId" ] }, { "name": "EnableTask", "description": "分布式任务调度 TCT 已到达 EOMS 节点，进行产品下线处理。退市公告https://cloud.tencent.com/announce/detail/2053 启用任务", "status": "deprecated", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "任务ID。[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页查看任务ID。", "example": "task-6a79x94v" } ], "required": [ "TaskId" ] }, { "name": "EnableTaskFlow", "description": "分布式任务调度 TCT 已到达 EOMS 节点，进行产品下线处理。退市公告https://cloud.tencent.com/announce/detail/2053 启用工作流", "status": "deprecated", "parameters": [ { "name": "FlowId", "type": "string", "required": true, "description": "工作流 ID。[工作流管理](https://console.cloud.tencent.com/tsf/tct?rid=1\u0026tab=workflowManage)列表页查看工作流ID。", "example": "flow-6a79x94v" } ], "required": [ "FlowId" ] }, { "name": "EnableUnitRoute", "description": "启用单元化路由", "status": "online", "parameters": [ { "name": "Id", "type": "string", "required": true, "description": "网关实体ID", "example": "gw-ins-szesmg28" } ], "required": [ "Id" ] }, { "name": "EnableUnitRule", "description": "启用单元化规则", "status": "online", "parameters": [ { "name": "Id", "type": "string", "required": true, "description": "规则ID", "example": "unit-rl-u0643wrg" } ], "required": [ "Id" ] }, { "name": "ExecuteTask", "description": "分布式任务调度 TCT 已到达 EOMS 节点，进行产品下线处理。退市公告https://cloud.tencent.com/announce/detail/2053 手动执行一次任务", "status": "deprecated", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页查看任务ID。", "example": "task-jzdv5qao" } ], "required": [ "TaskId" ] }, { "name": "ExecuteTaskFlow", "description": "分布式任务调度 TCT 已到达 EOMS 节点，进行产品下线处理。退市公告https://cloud.tencent.com/announce/detail/2053 执行一次工作流", "status": "deprecated", "parameters": [ { "name": "FlowId", "type": "string", "required": false, "description": "工作流 ID。[工作流管理](https://console.cloud.tencent.com/tsf/tct?rid=1\u0026tab=workflowManage)列表页查看工作流ID。", "example": "flow-6a79x94v" } ], "required": [] }, { "name": "ExpandGroup", "description": "虚拟机部署组添加实例", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "部署组ID，可通过调用[DescribeGroups](https://cloud.tencent.com/document/api/649/36065)查询已创建的部署组列表或登录控制台进行查看；也可以调用[CreateGroup](https://cloud.tencent.com/document/api/649/36074)创建新的部署组。", "example": "group-6a79x94v" }, { "name": "InstanceIdList", "type": "array", "required": true, "description": "扩容的机器实例ID列表，调用[DescribeGroupInstances](https://cloud.tencent.com/document/api/649/36066)查询虚拟机部署组云主机列表", "example": "[\"ins-6a79x94v\",\"ins-6a79x94f\"]", "item_type": "string" } ], "required": [ "GroupId", "InstanceIdList" ] }, { "name": "ModifyApplication", "description": "修改应用", "status": "online", "parameters": [ { "name": "ApplicationId", "type": "string", "required": true, "description": "应用ID，可通过调用[DescribeApplications](https://cloud.tencent.com/document/api/649/36090)查询已创建的应用列表或登录控制台进行查看；也可以调用[CreateApplication](https://cloud.tencent.com/document/api/649/36094)创建新的应用。", "example": "application-6a79x94v" }, { "name": "ApplicationName", "type": "string", "required": false, "description": "应用名称", "example": "appName" }, { "name": "ApplicationDesc", "type": "string", "required": false, "description": "应用备注", "example": "this is desc" }, { "name": "ApplicationRemarkName", "type": "string", "required": false, "description": "应用备注名", "example": "appNameAlias" }, { "name": "ServiceConfigList", "type": "array", "required": false, "description": "服务配置信息列表", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "服务名", "example": "java-demo" }, { "name": "Ports", "type": "array", "required": true, "description": "端口信息列表", "example": "无", "item_type": "object", "children": [ { "name": "TargetPort", "type": "integer", "required": true, "description": "服务端口", "example": "8080" }, { "name": "Protocol", "type": "string", "required": true, "description": "端口协议，TCP或者UDP", "example": "TCP" } ] }, { "name": "HealthCheck", "type": "object", "required": false, "description": "健康检查配置", "example": "无", "children": [ { "name": "Path", "type": "string", "required": false, "description": "健康检查路径", "example": "/health" } ] } ] }, { "name": "MicroserviceType", "type": "string", "required": false, "description": "应用的微服务类型，N表示普通应用，M表示Mesh应用，G表示网关应用，NATIVE表示原生应用，RAW表示裸应用", "example": "N" }, { "name": "ServiceGovernanceConfig", "type": "object", "required": false, "description": "注册配置治理信息", "example": "无", "children": [ { "name": "EnableGovernance", "type": "boolean", "required": false, "description": "是否开启服务注册治理", "example": "true" }, { "name": "GovernanceType", "type": "string", "required": false, "description": "服务治理类型（枚举：SHARE表示共享型、EXCLUSIVE表示独占型）", "example": "SHARE" }, { "name": "ExclusiveInstances", "type": "array", "required": false, "description": "独享实例列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "CenterType", "type": "string", "required": false, "description": "配置中心类型[注册中心Registration、配置中心Configuration]", "example": "Registration" }, { "name": "InstanceId", "type": "string", "required": false, "description": "实例id，通过[北极星控制台](https://console.cloud.tencent.com/tse/governance)获取", "example": "ins-6a79x94v" }, { "name": "InstanceType", "type": "string", "required": false, "description": "实例类型，例如北极星Polaris", "example": "Polaris" }, { "name": "InstanceName", "type": "string", "required": false, "description": "实例名称", "example": "Polaris-Config" }, { "name": "RegionId", "type": "string", "required": false, "description": "实例地域id，通过[北极星控制台](https://console.cloud.tencent.com/tse/governance)获取", "example": "7" }, { "name": "InstanceNamespaceId", "type": "string", "required": false, "description": "实例命名空间ID，通过[北极星控制台](https://console.cloud.tencent.com/tse/governance)获取", "example": "namespace-6a79x94v" }, { "name": "GroupId", "type": "string", "required": false, "description": "部署组Id 注意：此字段可能返回 null，表示取不到有效值。", "example": "group-6a73eg5v" }, { "name": "CreateTime", "type": "integer", "required": false, "description": "创建时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "1757324401000" }, { "name": "UpdateTime", "type": "integer", "required": false, "description": "更新时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "1757324863000" } ] } ] }, { "name": "FrameworkType", "type": "string", "required": false, "description": "应用开发框架，SpringCloud表示SpringCloud应用，Dubbo表示Dubbo应用，Go-GRPC表示Go-GRPC应用，Other表示其他应用", "example": "SpringCloud" } ], "required": [ "ApplicationId" ] }, { "name": "ModifyCluster", "description": "修改集群信息", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID，按照【集群ID】进行过滤，可通过调用[DescribeClusters](https://cloud.tencent.com/document/product/649/85857)查询已创建的集群列表或登录控制台进行查看；也可以调用[CreateCluster](https://cloud.tencent.com/document/product/649/36049)创建新的集群。仅在集群下无部署组、命名空间、云主机时可以删除。", "example": "cls-6a79x94v" }, { "name": "ClusterName", "type": "string", "required": false, "description": "集群名称", "example": "DEMO-DOCKER" }, { "name": "ClusterDesc", "type": "string", "required": false, "description": "集群描述信息", "example": "集群描述" }, { "name": "ClusterRemarkName", "type": "string", "required": false, "description": "备注名", "example": "集群备注" }, { "name": "EnableLogCollection", "type": "boolean", "required": false, "description": "是否开启cls日志功能，true表示开启，false表示关闭", "example": "false" }, { "name": "RepairLog", "type": "boolean", "required": false, "description": "是否修复cls日志功能，true表示修复，false表示不修复", "example": "false" } ], "required": [ "ClusterId" ] }, { "name": "ModifyContainerGroup", "description": "修改容器部署组", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "部署组ID，可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/api/649/36068)查询已创建的部署组列表或登录控制台进行查看；也可以调用[CreateContainGroup](https://cloud.tencent.com/document/api/649/36075)创建新的部署组。", "example": "group-s892vem" }, { "name": "AccessType", "type": "integer", "required": false, "description": "0:公网 1:集群内访问 2：NodePort", "example": "2" }, { "name": "ProtocolPorts", "type": "array", "required": false, "description": "ProtocolPorts数组", "example": "无", "item_type": "object", "children": [ { "name": "Protocol", "type": "string", "required": true, "description": "TCP UDP", "example": "TCP" }, { "name": "Port", "type": "integer", "required": true, "description": "服务端口", "example": "8080" }, { "name": "TargetPort", "type": "integer", "required": true, "description": "容器端口", "example": "8080" }, { "name": "NodePort", "type": "integer", "required": false, "description": "主机端口", "example": "30090" }, { "name": "Name", "type": "string", "required": false, "description": "端口名称", "example": "port-0" } ] }, { "name": "UpdateType", "type": "integer", "required": false, "description": "更新方式：0:快速更新 1:滚动更新", "example": "1" }, { "name": "UpdateIvl", "type": "integer", "required": false, "description": "更新间隔,单位秒", "example": "5" }, { "name": "SubnetId", "type": "string", "required": false, "description": "子网ID，可通过调用[DescribeSubnets](https://cloud.tencent.com/document/product/215/15784)查询已创建的子网列表或登录控制台进行查看；也可以调用[CreateSubnet](https://cloud.tencent.com/document/product/1108/43594)创建新的子网。", "example": "subnet-kgpu7vem" }, { "name": "Alias", "type": "string", "required": false, "description": "部署组备注", "example": "备注" } ], "required": [ "GroupId" ] }, { "name": "ModifyContainerReplicas", "description": "修改容器部署组实例数", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "部署组ID，部署组唯一标识，可以通过[DescribeContainerGroups](https://cloud.tencent.com/document/api/649/36068)查询已创建的容器部署组列表；也可以调用[CreateContainGroup](https://cloud.tencent.com/document/api/649/36075)创建新的容器部署组", "example": "group-6a79x94v" }, { "name": "InstanceNum", "type": "integer", "required": true, "description": "实例数量", "example": "3" } ], "required": [ "GroupId", "InstanceNum" ] }, { "name": "ModifyGroup", "description": "更新部署组信息", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "部署组ID，可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/api/649/36068)查询已创建的部署组列表或登录控制台进行查看；也可以调用[CreateContainGroup](https://cloud.tencent.com/document/api/649/36075)创建新的部署组。", "example": "group-9yn2q8yd" }, { "name": "GroupName", "type": "string", "required": false, "description": "部署组名称", "example": "mock-group" }, { "name": "GroupDesc", "type": "string", "required": false, "description": "部署组描述", "example": "这是一段描述信息" }, { "name": "Alias", "type": "string", "required": false, "description": "部署组备注", "example": "备注" } ], "required": [ "GroupId" ] }, { "name": "ModifyGroupLane", "description": "更新部署组泳道信息", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "部署组ID。该参数可以通过调用 [DescribeSimpleGroups](https://cloud.tencent.com/document/product/649/36064) 的返回值中的 GroupId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/resource)-查看部署组页查看；也可以调用[CreateGroup](https://cloud.tencent.com/document/product/649/36074)创建新的部署组。", "example": "group-ab2md7wa" }, { "name": "LaneList", "type": "array", "required": true, "description": "泳道部署组列表。", "example": "无", "item_type": "object", "children": [ { "name": "GroupId", "type": "string", "required": true, "description": "部署组ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "group-py5436a4" }, { "name": "Entrance", "type": "boolean", "required": true, "description": "是否入口应用 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "LaneGroupId", "type": "string", "required": false, "description": "泳道部署组ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "lane-g-a7or5ebv" }, { "name": "LaneId", "type": "string", "required": false, "description": "泳道ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "lane-y9647wgy" }, { "name": "GroupName", "type": "string", "required": false, "description": "部署组名 注意：此字段可能返回 null，表示取不到有效值。", "example": "group_app" }, { "name": "ApplicationId", "type": "string", "required": false, "description": "应用ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "application-byxz6gal" }, { "name": "ApplicationName", "type": "string", "required": false, "description": "应用名 注意：此字段可能返回 null，表示取不到有效值。", "example": "app_provider" }, { "name": "NamespaceId", "type": "string", "required": false, "description": "命名空间ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "namespace-6ymbn3vg" }, { "name": "NamespaceName", "type": "string", "required": false, "description": "命名空间名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "ns_app" }, { "name": "CreateTime", "type": "integer", "required": false, "description": "创建时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "1732784732000" }, { "name": "UpdateTime", "type": "integer", "required": false, "description": "更新时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "1732784732000" }, { "name": "ClusterType", "type": "string", "required": false, "description": "集群类型 注意：此字段可能返回 null，表示取不到有效值。", "example": "V" } ] } ], "required": [ "GroupId", "LaneList" ] }, { "name": "ModifyLane", "description": "更新泳道配置信息", "status": "online", "parameters": [ { "name": "LaneId", "type": "string", "required": true, "description": "泳道配置ID。该参数可以通过调用 [DescribeLanes](https://cloud.tencent.com/document/product/649/44504) 的返回值中的 LaneId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?tab=grayscale\u0026subTab=lane)查看；也可以调用[CreateLane](https://cloud.tencent.com/document/product/649/44508)创建新的泳道配置。", "example": "lane-ap62k7ol" }, { "name": "LaneName", "type": "string", "required": true, "description": "泳道配置名称，最多支持60个字符，只能包含字母、数字及分隔符（“-”），且不能以分隔符开头或结尾。", "example": "rule_app" }, { "name": "Remark", "type": "string", "required": true, "description": "备注，最多支持200个字符。", "example": "This is desc" } ], "required": [ "LaneId", "LaneName", "Remark" ] }, { "name": "ModifyLaneRule", "description": "更新灰度发布规则", "status": "online", "parameters": [ { "name": "RuleId", "type": "string", "required": true, "description": "灰度发布规则ID。该参数可以通过调用 [DescribeLaneRules](https://cloud.tencent.com/document/product/649/44505) 的返回值中的 RuleId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?tab=grayscale\u0026subTab=lanerule)查看；也可以调用[CreateLaneRule](https://cloud.tencent.com/document/product/649/44507)创建新的灰度发布规则。", "example": "lane-r-yqg4kmbd" }, { "name": "RuleName", "type": "string", "required": true, "description": "灰度发布规则名称，最多支持60个字符，支持中英文字符。", "example": "rule_app" }, { "name": "Remark", "type": "string", "required": true, "description": "灰度发布规则备注，最多支持200个字符。", "example": "This is desc" }, { "name": "RuleTagList", "type": "array", "required": true, "description": "灰度发布规则标签列表。", "example": "无", "item_type": "object", "children": [ { "name": "TagId", "type": "string", "required": false, "description": "标签ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "lane-t-nalb72vq" }, { "name": "TagName", "type": "string", "required": false, "description": "标签名 注意：此字段可能返回 null，表示取不到有效值。", "example": "user" }, { "name": "TagOperator", "type": "string", "required": false, "description": "标签操作符 注意：此字段可能返回 null，表示取不到有效值。", "example": "EQUAL" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "LaneRuleId", "type": "string", "required": false, "description": "泳道规则ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "lane-r-by8n9xyk" }, { "name": "CreateTime", "type": "integer", "required": false, "description": "创建时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "1732784732000" }, { "name": "UpdateTime", "type": "integer", "required": false, "description": "更新时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "1732784732000" } ] }, { "name": "RuleTagRelationship", "type": "string", "required": true, "description": "灰度发布规则标签关系。- RELEATION_AND：与- RELEATION_OR：或", "example": "RELEATION_AND" }, { "name": "LaneId", "type": "string", "required": true, "description": "泳道配置ID。该参数可以通过调用 [DescribeLanes](https://cloud.tencent.com/document/product/649/44504) 的返回值中的 LaneId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?tab=grayscale\u0026subTab=lane)查看；也可以调用[CreateLane](https://cloud.tencent.com/document/product/649/44508)创建新的泳道配置。", "example": "lane-ap62k7ol" }, { "name": "Enable", "type": "boolean", "required": true, "description": "开启状态。 - true：开启 - false：关闭", "example": "true" } ], "required": [ "RuleId", "RuleName", "Remark", "RuleTagList", "RuleTagRelationship", "LaneId", "Enable" ] }, { "name": "ModifyMicroservice", "description": "修改微服务详情", "status": "online", "parameters": [ { "name": "MicroserviceId", "type": "string", "required": true, "description": "微服务ID。该参数可以通过调用 [DescribeMicroservices](https://cloud.tencent.com/document/product/649/36084) 的返回值中的 MicroserviceId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?tab=service)查看；也可以调用[CreateMicroserviceWithDetailResp](https://cloud.tencent.com/document/product/649/85860)创建新的微服务。", "example": "ms-yd8dr5bx" }, { "name": "MicroserviceDesc", "type": "string", "required": true, "description": "微服务备注信息，最多支持200个字符。", "example": "This is desc" } ], "required": [ "MicroserviceId", "MicroserviceDesc" ] }, { "name": "ModifyNamespace", "description": "修改命名空间", "status": "online", "parameters": [ { "name": "NamespaceId", "type": "string", "required": true, "description": "命名空间ID，按照【命名空间ID】进行过滤，可通过调用[DescribeNamespaces](https://cloud.tencent.com/document/product/649/36096)查询已创建的命名空间列表或登录控制台进行查看；也可以调用[CreateNamespace](https://cloud.tencent.com/document/product/649/36098)创建新命名空间。", "example": "namespace-6a79x94v" }, { "name": "NamespaceName", "type": "string", "required": false, "description": "命名空间名称", "example": "PROD命名空间" }, { "name": "NamespaceDesc", "type": "string", "required": false, "description": "命名空间备注", "example": "PROD命名空间" }, { "name": "IsHaEnable", "type": "string", "required": false, "description": "是否开启高可用，0表示不开启，1表示开启", "example": "1" } ], "required": [ "NamespaceId" ] }, { "name": "ModifyPathRewrite", "description": "修改路径重写", "status": "online", "parameters": [ { "name": "PathRewriteId", "type": "string", "required": true, "description": "路径重写规则ID", "example": "rewrite-ba22pbpa" }, { "name": "Regex", "type": "string", "required": false, "description": "正则表达式", "example": "/consumer" }, { "name": "Replacement", "type": "string", "required": false, "description": "替换的内容", "example": "/provider" }, { "name": "Blocked", "type": "string", "required": false, "description": "是否屏蔽映射后路径，Y: 是 N: 否", "example": "N" }, { "name": "Order", "type": "integer", "required": false, "description": "规则顺序，越小优先级越高", "example": "1" } ], "required": [ "PathRewriteId" ] }, { "name": "ModifyProgram", "description": "更新数据集", "status": "online", "parameters": [ { "name": "ProgramId", "type": "string", "required": true, "description": "数据集ID，调用[DescribePrograms](https://console.cloud.tencent.com/tsf/privilege?rid=1\u0026tab=program)查询接口会返回数据集信息，包括programId", "example": "program-6a79x94v" }, { "name": "ProgramName", "type": "string", "required": false, "description": "数据集名称，不传入时不更新", "example": "test-name" }, { "name": "ProgramDesc", "type": "string", "required": false, "description": "数据集描述，不传入时不更新", "example": "这是一段描述信息" }, { "name": "ProgramItemList", "type": "array", "required": false, "description": "数据项列表，传入null不更新，传入空数组全量删除", "example": "无", "item_type": "object", "children": [ { "name": "ProgramItemId", "type": "string", "required": false, "description": "数据项ID，调用[DescribePrograms](https://console.cloud.tencent.com/tsf/privilege?rid=1\u0026tab=program)接口查询已创建的数据集或登陆控制台进行查看；也可以通过调用[CreateProgram](https://cloud.tencent.com/document/api/649/108544)创建新的数据集。", "example": "prog-item-6a79x94v" }, { "name": "Resource", "type": "object", "required": false, "description": "资源", "example": "无", "children": [ { "name": "ResourceId", "type": "string", "required": false, "description": "资源ID，调用[DescribeResources](https://console.cloud.tencent.com/tsf/privilege-program-create?rid=1)接口，查看接口返回的ResourceId", "example": "resource-6a79x94v" }, { "name": "ResourceCode", "type": "string", "required": false, "description": "资源编码，枚举值描述【cluster（集群）、namespace（命名空间）、config（应用配置）】", "example": "FindOne" }, { "name": "ResourceName", "type": "string", "required": false, "description": "资源名称", "example": "FindOne" }, { "name": "ServiceCode", "type": "string", "required": false, "description": "资源所属产品编码，枚举值描述【tsf】", "example": "tsf" }, { "name": "ResourceAction", "type": "string", "required": false, "description": "选取资源使用的Action，枚举值描述【DescribeSimpleCluster（查询简单集群列表）、DescribeTaskRecords（查询任务列表）】", "example": "FindOne" }, { "name": "IdField", "type": "string", "required": false, "description": "资源数据查询的ID字段名，调用[DescribeResources](https://console.cloud.tencent.com/tsf/privilege-program-create?rid=1)接口，查看接口返回的IdField", "example": "ResourceId" }, { "name": "NameField", "type": "string", "required": false, "description": "资源数据查询的名称字段名", "example": "ResourceName" }, { "name": "SelectIdsField", "type": "string", "required": false, "description": "资源数据查询的ID过滤字段名", "example": "Ids" }, { "name": "CreationTime", "type": "integer", "required": false, "description": "创建时间，时间戳格式【Long】", "example": "1279033108" }, { "name": "LastUpdateTime", "type": "integer", "required": false, "description": "最后更新时间，时间戳格式【Long】", "example": "1803792739" }, { "name": "DeleteFlag", "type": "boolean", "required": false, "description": "删除标识", "example": "false" }, { "name": "ResourceDesc", "type": "string", "required": false, "description": "资源描述", "example": "this is a desc" }, { "name": "CanSelectAll", "type": "boolean", "required": false, "description": "是否可以选择全部", "example": "false" }, { "name": "SearchWordField", "type": "string", "required": false, "description": "资源数据查询的模糊查询字段名", "example": "ResourceCode" }, { "name": "Index", "type": "integer", "required": false, "description": "排序，枚举值描述【10、20、77】", "example": "1" } ] }, { "name": "ValueList", "type": "array", "required": false, "description": "数据值列表", "example": "[\"1\"]", "item_type": "string" }, { "name": "IsAll", "type": "boolean", "required": false, "description": "全选标识，true: 全选；false: 非全选", "example": "true" }, { "name": "CreationTime", "type": "integer", "required": false, "description": "创建时间，时间戳格式【Long】", "example": "174594239000" }, { "name": "LastUpdateTime", "type": "integer", "required": false, "description": "最后更新时间，时间戳格式【Long】，单位毫秒", "example": "174594239000" }, { "name": "DeleteFlag", "type": "boolean", "required": false, "description": "删除标识，true: 可删除；false: 不可删除", "example": "false" }, { "name": "ProgramId", "type": "string", "required": false, "description": "数据集ID，调用[DescribePrograms](https://console.cloud.tencent.com/tsf/privilege?rid=1\u0026tab=program)查询接口获取", "example": "[\"program-6a79x94v\"]" } ] }, { "name": "EmptyProgramItemList", "type": "boolean", "required": false, "description": "ProgramItemList是否是空数组", "example": "true" } ], "required": [ "ProgramId" ] }, { "name": "ModifyTask", "description": "分布式任务调度 TCT 已到达 EOMS 节点，进行产品下线处理。退市公告https://cloud.tencent.com/announce/detail/2053 修改任务", "status": "deprecated", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页查看任务ID。", "example": "task-klwqrnlw" }, { "name": "TaskName", "type": "string", "required": false, "description": "任务名称，长度限制为64字符。在任务管理列表页面第一列或是任务基本信息页查看任务名称。", "example": "demohaha" }, { "name": "TaskType", "type": "string", "required": false, "description": "任务类型。当前只支持一种任务类型。枚举值，java：Java类任务", "example": "java" }, { "name": "TaskContent", "type": "string", "required": false, "description": "任务内容，长度限制为 65536 字节", "example": "com.tencent.task.example.SimpleTask" }, { "name": "ExecuteType", "type": "string", "required": false, "description": "任务执行方式，枚举值。unicast：随机单节点执行，broadcast：广播执行，shard：分片执行", "example": "unicast" }, { "name": "TaskRule", "type": "object", "required": false, "description": "触发规则", "example": "无", "children": [ { "name": "RuleType", "type": "string", "required": true, "description": "触发规则类型，枚举值。一共3个值，Cron：定时触发，Repeat：周期触发，WorkFlow：工作流触发", "example": "Cron" }, { "name": "Expression", "type": "string", "required": false, "description": "Cron类型规则，cron表达式。", "example": "0 0/1 * * * ?" }, { "name": "RepeatInterval", "type": "integer", "required": false, "description": "时间间隔， 单位毫秒 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" } ] }, { "name": "TimeOut", "type": "integer", "required": false, "description": "超时时间，取值大于0，单位：毫秒（ms）", "example": "60000" }, { "name": "GroupId", "type": "string", "required": false, "description": "部署组ID。在[应用管理](https://console.cloud.tencent.com/tsf/app?rid=1)，点击应用ID进入应用部署页查看部署组ID。", "example": "group-aedpen6v" }, { "name": "ShardCount", "type": "integer", "required": false, "description": "分片数量，取值范围2~1000", "example": "1" }, { "name": "ShardArguments", "type": "array", "required": false, "description": "分片参数", "example": "无", "item_type": "object", "children": [ { "name": "ShardKey", "type": "integer", "required": false, "description": "分片参数 KEY，整形, 范围 [1,1000]", "example": "32" }, { "name": "ShardValue", "type": "string", "required": false, "description": "分片参数 VALUE 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" } ] }, { "name": "AdvanceSettings", "type": "object", "required": false, "description": "高级设置", "example": "无", "children": [ { "name": "SubTaskConcurrency", "type": "integer", "required": false, "description": "子任务单机并发数限制，默认值为2", "example": "2" } ] }, { "name": "SuccessOperator", "type": "string", "required": false, "description": "判断任务成功的操作符 GT/GTE", "example": "GTE" }, { "name": "SuccessRatio", "type": "integer", "required": false, "description": "判断任务成功率的阈值，取值范围：1-100，单位：百分比（%）", "example": "100" }, { "name": "RetryCount", "type": "integer", "required": false, "description": "重试次数，取值范围 0 - 10，单位：次", "example": "0" }, { "name": "RetryInterval", "type": "integer", "required": false, "description": "重试间隔，取值范围 0-600，单位：秒（s）", "example": "0" }, { "name": "TaskArgument", "type": "string", "required": false, "description": "任务参数，长度限制10000个字符", "example": "0" }, { "name": "ProgramIdList", "type": "array", "required": false, "description": "数据集列表。", "example": "[\"program-6a79x94v\"]", "item_type": "string" } ], "required": [ "TaskId" ] }, { "name": "ModifyUploadInfo", "description": "调用该接口和COS的上传接口后，需要调用此接口更新TSF中保存的程序包状态。 调用此接口完成后，才标志上传包流程结束。", "status": "online", "parameters": [ { "name": "ApplicationId", "type": "string", "required": true, "description": "应用ID，通过调用DescribeApplications接口[获取应用列表](https://cloud.tencent.com/document/api/649/36090)从而获取应用ID，或登录[控制台](https://console.cloud.tencent.com/tsf/app?rid=1)进行查看，调用CreateApplication接口[创建应用](https://cloud.tencent.com/document/product/649/36094)时的返回值", "example": "application-6a79x94v" }, { "name": "PkgId", "type": "string", "required": true, "description": "软件包ID可通过调用DescribeUploadInfo接口时[获取上传程序包信息](https://cloud.tencent.com/document/api/649/36078)返回的COS上传信息获取，登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看", "example": "pkg-6a79x94v" }, { "name": "Result", "type": "integer", "required": true, "description": "COS返回上传结果（默认为0：成功，其他值表示失败）", "example": "0" }, { "name": "Md5", "type": "string", "required": true, "description": "程序包MD5", "example": "bsij82y9sdnowxohwosjxxxxxxxxxxxxxxxxxxxx" }, { "name": "Size", "type": "integer", "required": false, "description": "程序包大小（单位字节）", "example": "2048" }, { "name": "RepositoryType", "type": "string", "required": false, "description": "程序包仓库类型", "example": "personal" }, { "name": "RepositoryId", "type": "string", "required": false, "description": "仓库ID，可通过调用[仓库信息查询类](https://cloud.tencent.com/document/api/649/45925)接口时出参中的RepositoryId，或登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看", "example": "application-6a79x94v" } ], "required": [ "ApplicationId", "PkgId", "Result", "Md5" ] }, { "name": "OperateApplicationTcrBinding", "description": "绑定解绑tcr仓库", "status": "online", "parameters": [ { "name": "Command", "type": "string", "required": false, "description": "指定操作类型，目前支持： - `bind`：绑定（默认） - `unbind`：解除绑定", "example": "bind" }, { "name": "ApplicationId", "type": "string", "required": false, "description": "应用ID，可通过调用[DescribeApplications](https://cloud.tencent.com/document/api/649/36090)查询已创建的应用列表或登录控制台进行查看；也可以调用[CreateApplication](https://cloud.tencent.com/document/api/649/36094)创建新的应用。", "example": "application-6a79x94v" }, { "name": "TcrRepoInfo", "type": "object", "required": false, "description": "TcrRepoInfo值", "example": "无", "children": [ { "name": "Region", "type": "string", "required": false, "description": "地域（填数字）", "example": "ap-guangzhou" }, { "name": "RegistryId", "type": "string", "required": false, "description": "实例id", "example": "reg-6a79x94v" }, { "name": "RegistryName", "type": "string", "required": false, "description": "实例名", "example": "/tsf" }, { "name": "Namespace", "type": "string", "required": false, "description": "命名空间", "example": "tsf_1083080xxxx" }, { "name": "RepoName", "type": "string", "required": false, "description": "仓库名", "example": "/tsf/nginx" } ] } ], "required": [] }, { "name": "ReassociateBusinessLogConfig", "description": "后端服务已经删除这个接口, API 接口下线处理 重关联业务日志配置", "status": "deprecated", "parameters": [ { "name": "ConfigId", "type": "string", "required": true, "description": "原关联日志配置ID", "example": "config-6a79x94v" }, { "name": "NewConfigId", "type": "string", "required": true, "description": "新关联日志配置ID", "example": "config-6a79x94f" }, { "name": "ApplicationId", "type": "string", "required": true, "description": "TSF应用ID", "example": "application-6a79x94v" }, { "name": "GroupId", "type": "string", "required": true, "description": "TSF部署组ID", "example": "group-6a79x94v" } ], "required": [ "ConfigId", "NewConfigId", "ApplicationId", "GroupId" ] }, { "name": "RedoTask", "description": "分布式任务调度 TCT 已到达 EOMS 节点，进行产品下线处理。退市公告https://cloud.tencent.com/announce/detail/2053 重新执行任务", "status": "deprecated", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页查看任务ID。", "example": "task-6a79x94v" } ], "required": [ "TaskId" ] }, { "name": "RedoTaskBatch", "description": "分布式任务调度 TCT 已到达 EOMS 节点，进行产品下线处理。退市公告https://cloud.tencent.com/announce/detail/2053 重新执行任务批次", "status": "deprecated", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页查看任务ID。", "example": "task-6a79x94v" }, { "name": "BatchId", "type": "string", "required": true, "description": "任务批次ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)页面点击任务ID进入任务详情，进入执行记录列表页，第一列即为任务批次ID。", "example": "batch-6a79x94v" } ], "required": [ "TaskId", "BatchId" ] }, { "name": "RedoTaskExecute", "description": "分布式任务调度 TCT 已到达 EOMS 节点，进行产品下线处理。退市公告https://cloud.tencent.com/announce/detail/2053 重新执行在某个节点上执行任务。", "status": "deprecated", "parameters": [ { "name": "BatchId", "type": "string", "required": true, "description": "任务批次ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)页面第一列点击任务ID进入任务详情，进入执行记录列表页，第一列内容即为任务批次ID。", "example": "batch-6a79x94v" }, { "name": "ExecuteId", "type": "string", "required": true, "description": "任务执行ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)页面第一列点击任务ID进入任务详情，进入执行记录页，点击批次ID进入执行详情列表页，第一列即为任务执行ID。", "example": "execute-6a79x94v" }, { "name": "TaskId", "type": "string", "required": true, "description": "任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页查看任务ID。", "example": "task-6a79x94v" } ], "required": [ "BatchId", "ExecuteId", "TaskId" ] }, { "name": "RedoTaskFlowBatch", "description": "分布式任务调度 TCT 已到达 EOMS 节点，进行产品下线处理。退市公告https://cloud.tencent.com/announce/detail/2053 重新执行工作流批次", "status": "deprecated", "parameters": [ { "name": "FlowBatchId", "type": "string", "required": true, "description": "工作流批次 ID。在[工作流管理](https://console.cloud.tencent.com/tsf/tct?rid=1\u0026tab=workflowManage)页面，点击第一列的工作流ID进入工作流执行记录列表页面，第一列的内容即为工作流批次ID。", "example": "fbatch-6a79x94v" } ], "required": [ "FlowBatchId" ] }, { "name": "ReleaseApiGroup", "description": "发布Api分组", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "Api 分组ID", "example": "grp-d45mlt3o" } ], "required": [ "GroupId" ] }, { "name": "ReleaseConfig", "description": "发布配置", "status": "online", "parameters": [ { "name": "ConfigId", "type": "string", "required": true, "description": "配置ID。该参数可以通过调用 [DescribeConfigs](https://cloud.tencent.com/document/product/649/38340) 的返回值中的 ConfigId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=app)配置详情-配置版本页查看；也可以调用[CreateConfig](https://cloud.tencent.com/document/product/649/38348)创建新的配置。", "example": "dcfg-vzk36owv" }, { "name": "GroupId", "type": "string", "required": true, "description": "部署组ID。该参数可以通过调用 [DescribeSimpleGroups](https://cloud.tencent.com/document/product/649/36064) 的返回值中的 GroupId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/resource)-查看部署组页查看；也可以调用[CreateGroup](https://cloud.tencent.com/document/product/649/36074)创建新的部署组。", "example": "group-9yn684ev" }, { "name": "ReleaseDesc", "type": "string", "required": false, "description": "发布描述，最多支持200个字符。", "example": "This is desc" } ], "required": [ "ConfigId", "GroupId" ] }, { "name": "ReleaseConfigWithDetailResp", "description": "发布配置，并且返回配置ID。", "status": "online", "parameters": [ { "name": "ConfigId", "type": "string", "required": true, "description": "配置ID。该参数可以通过调用 [DescribeConfigs](https://cloud.tencent.com/document/product/649/38340) 的返回值中的 ConfigId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=app)配置详情-配置版本页查看；也可以调用[CreateConfig](https://cloud.tencent.com/document/product/649/38348)创建新的配置。", "example": "dcfg-yo82mmra" }, { "name": "GroupId", "type": "string", "required": true, "description": "部署组ID。该参数可以通过调用 [DescribeSimpleGroups](https://cloud.tencent.com/document/product/649/36064) 的返回值中的 GroupId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/resource)-查看部署组页查看；也可以调用[CreateGroup](https://cloud.tencent.com/document/product/649/36074)创建新的部署组。", "example": "group-aln2284v" }, { "name": "ReleaseDesc", "type": "string", "required": false, "description": "发布描述，最多支持200个字符。", "example": "This is desc" } ], "required": [ "ConfigId", "GroupId" ] }, { "name": "ReleaseFileConfig", "description": "发布文件配置", "status": "online", "parameters": [ { "name": "ConfigId", "type": "string", "required": true, "description": "配置ID。该参数可以通过调用 [DescribeFileConfigs](https://cloud.tencent.com/document/product/649/58593) 的返回值中的 ConfigId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?rid=1\u0026subTab=file)配置详情-配置版本页查看；也可以调用[CreateFileConfig](https://cloud.tencent.com/document/product/649/58594)创建新的配置。", "example": "dcfg-f-mae7g3v3" }, { "name": "GroupId", "type": "string", "required": true, "description": "部署组ID。该参数可以通过调用 [DescribeSimpleGroups](https://cloud.tencent.com/document/product/649/36064) 的返回值中的 GroupId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/resource)-查看部署组页查看；也可以调用[CreateGroup](https://cloud.tencent.com/document/product/649/36074)创建新的部署组。", "example": "group-oydld25a" }, { "name": "ReleaseDesc", "type": "string", "required": false, "description": "发布描述，最多支持200个字符。", "example": "this is desc" } ], "required": [ "ConfigId", "GroupId" ] }, { "name": "ReleasePublicConfig", "description": "发布公共配置", "status": "online", "parameters": [ { "name": "ConfigId", "type": "string", "required": true, "description": "配置ID。该参数可以通过调用 [DescribePublicConfigs](https://cloud.tencent.com/document/product/649/38335) 的返回值中的 ConfigId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=public)配置详情-配置版本页查看；也可以调用[CreatePublicConfig](https://cloud.tencent.com/document/product/649/38347)创建新的配置。", "example": "dcfg-p-vkj5dnky" }, { "name": "NamespaceId", "type": "string", "required": true, "description": "命名空间ID。该参数可以通过调用 [DescribeSimpleNamespaces](https://cloud.tencent.com/document/api/649/36096) 的返回值中的 NamespaceId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/resource?tab=namespace)查看；也可以调用[CreateNamespace](https://cloud.tencent.com/document/product/649/36098)创建新的命名空间。", "example": "namespace-vw46q85y" }, { "name": "ReleaseDesc", "type": "string", "required": false, "description": "发布描述，最多支持200个字符。", "example": "This is desc" } ], "required": [ "ConfigId", "NamespaceId" ] }, { "name": "RemoveInstances", "description": "从 TSF 集群中批量移除云主机节点", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群 ID。调用[DescribeSimpleClusters](https://cloud.tencent.com/document/api/649/36047)查询已创建的集群或通过[CreateCluster](https://cloud.tencent.com/document/api/649/36049)接口创建新的集群。", "example": "cls-6a79x94v" }, { "name": "InstanceIdList", "type": "array", "required": true, "description": "云主机 ID 列表，调用[DescribeInstances](https://cloud.tencent.com/document/api/649/72342)查询已有的云主机列表", "example": "[\"ins-6a79x94v\", \"ins-7a79x94v\"]", "item_type": "string" } ], "required": [ "ClusterId", "InstanceIdList" ] }, { "name": "RevocationConfig", "description": "撤回已发布的配置", "status": "online", "parameters": [ { "name": "ConfigReleaseId", "type": "string", "required": true, "description": "配置项发布ID。该参数可以通过调用 [DescribeConfigReleases](https://cloud.tencent.com/document/product/649/38342) 的返回值中的 ConfigReleaseId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=app)配置详情-发布情况页查看。", "example": "dcfgr-y84o2xla" } ], "required": [ "ConfigReleaseId" ] }, { "name": "RevocationPublicConfig", "description": "撤回已发布的公共配置", "status": "online", "parameters": [ { "name": "ConfigReleaseId", "type": "string", "required": true, "description": "配置项发布ID", "example": "dcfgr-a7rldd9v" } ], "required": [ "ConfigReleaseId" ] }, { "name": "RevokeFileConfig", "description": "撤回已发布的文件配置", "status": "online", "parameters": [ { "name": "ConfigReleaseId", "type": "string", "required": true, "description": "按照【配置项发布ID】进行撤回。可通过调用[DescribeFileConfigReleases](https://cloud.tencent.com/document/product/649/85855)查询已发布的文件配置列表或登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=file)-查看发布信息-发布情况进行查看；也可以调用[ReleaseFileConfig](https://cloud.tencent.com/document/product/649/58592)发布文件配置。", "example": "dcfgr-f-oyd458xy" } ], "required": [ "ConfigReleaseId" ] }, { "name": "RollbackConfig", "description": "回滚配置", "status": "online", "parameters": [ { "name": "ConfigReleaseLogId", "type": "string", "required": true, "description": "配置项发布历史ID。该参数可以通过调用 [DescribeConfigReleaseLogs](https://cloud.tencent.com/document/product/649/38343) 的返回值中的 ConfigReleaseLogId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=app)配置详情-发布情况页查看。", "example": "dcfgrl-a2qj3qoa" }, { "name": "ReleaseDesc", "type": "string", "required": false, "description": "回滚描述，最多支持200个字符。", "example": "This is desc" } ], "required": [ "ConfigReleaseLogId" ] }, { "name": "SearchBusinessLog", "description": "业务日志搜索", "status": "online", "parameters": [ { "name": "ConfigId", "type": "string", "required": true, "description": "日志配置项ID 可通过调用[DescribeBusinessLogConfigs](https://cloud.tencent.com/document/product/649/75777)查询已创建的日志配置项列表或登录[控制台](https://console.cloud.tencent.com/tsf/observable/log?rid=1)进行查看", "example": "apm-busi-log-cfg-6a7m36a5" }, { "name": "InstanceIds", "type": "array", "required": false, "description": "机器实例ID，不传表示全部实例", "example": "[\"openapi-service-api-c594fd9cd-x76rf\\r\\n\"]", "item_type": "string" }, { "name": "StartTime", "type": "string", "required": false, "description": "开始时间，格式yyyy-MM-dd HH:mm:ss", "example": "2019-05-29 16:06:08" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间，格式yyyy-MM-dd HH:mm:ss", "example": "2019-05-29 17:06:08" }, { "name": "Offset", "type": "integer", "required": false, "description": "请求偏移量，取值范围大于等于0，默认值为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "单页请求配置数量，取值范围[1, 200]，默认值为50", "example": "20" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序规则，默认值\"time\"", "example": "score" }, { "name": "OrderType", "type": "string", "required": false, "description": "排序方式，取值\"asc\"或\"desc\"，默认值\"desc\"", "example": "asc" }, { "name": "SearchWords", "type": "array", "required": false, "description": "检索关键词", "example": "[\"demo\"]", "item_type": "string" }, { "name": "GroupIds", "type": "array", "required": false, "description": "部署组ID列表，不传表示全部部署组 可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/product/649/36068)或[DescribeGroups](https://cloud.tencent.com/document/product/649/36065)查询已创建的部署组列表或登录[控制台](https://console.cloud.tencent.com/tsf/app-detail?rid=1\u0026id=application-yo7kp9dv\u0026tab=publish\u0026subTab=group)进行查看", "example": "[\"group-gvkqkdjv\"]", "item_type": "string" }, { "name": "SearchWordType", "type": "string", "required": false, "description": "检索类型，取值 LUCENE：Lucene检索，REGEXP：正则检索，NORMAL：普通检索", "example": "NORMAL" }, { "name": "BatchType", "type": "string", "required": false, "description": "批量请求类型，取值 PAGE：分页查询，SCROLL：滚动查询，SEARCHAFTER：游标查询，默认值PAGE", "example": "SCROLL" }, { "name": "ScrollId", "type": "string", "required": false, "description": "游标ID", "example": "scroll-gvkqkdjv" }, { "name": "SearchAfter", "type": "array", "required": false, "description": "查询es使用searchAfter时，游标", "example": "[\"1463538857\", \"654323\"]", "item_type": "string" } ], "required": [ "ConfigId" ] }, { "name": "SearchStdoutLog", "description": "标准输出日志搜索", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": false, "description": "机器实例ID， 和 部署组 ID 二者必选其一，不能同时为空 可通过调用[DescribeClusterInstances](https://cloud.tencent.com/document/product/649/36048)查询已导入的实例列表或登录[控制台](https://console.cloud.tencent.com/tsf/resource?rid=1\u0026tab=instance)进行查询。实例ID例如：ins-6decplwk", "example": "ins-6mm4t7ze" }, { "name": "Limit", "type": "integer", "required": false, "description": "单页请求配置数量，取值范围[1, 500]，默认值为100", "example": "100" }, { "name": "SearchWords", "type": "array", "required": false, "description": "检索关键词", "example": "[\"demo\"]", "item_type": "string" }, { "name": "StartTime", "type": "string", "required": false, "description": "查询起始时间，格式yyyy-MM-dd HH:mm:ss", "example": "2019-05-29 14:14:42" }, { "name": "GroupId", "type": "string", "required": false, "description": "部署组ID，和 InstanceId 二者必选其一，不能同时为空 可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/product/649/36068)或[DescribeGroups](https://cloud.tencent.com/document/product/649/36065)查询已创建的部署组列表或登录[控制台](https://console.cloud.tencent.com/tsf/app-detail?rid=1\u0026id=application-yo7kp9dv\u0026tab=publish\u0026subTab=group)进行查看", "example": "group-mctr7" }, { "name": "EndTime", "type": "string", "required": false, "description": "查询结束时间，格式yyyy-MM-dd HH:mm:ss", "example": "2020-11-12 14:34:36" }, { "name": "Offset", "type": "integer", "required": false, "description": "请求偏移量，取值范围大于等于0，默认值为 0", "example": "0" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序规则，time：按时间排序，score：按检索值排序，默认值\"time\"", "example": "time" }, { "name": "OrderType", "type": "string", "required": false, "description": "排序方式，取值 asc：升序 或 desc：降序，默认值desc", "example": "asc" }, { "name": "SearchWordType", "type": "string", "required": false, "description": "检索类型，取值 LUCENE：Lucene检索，REGEXP：正则检索，NORMAL：普通检索", "example": "NORMAL" }, { "name": "BatchType", "type": "string", "required": false, "description": "批量请求类型，取值 PAGE：分页查询，SCROLL：滚动查询，SEARCHAFTER：游标查询，默认值PAGE", "example": "SCROLL" }, { "name": "ScrollId", "type": "string", "required": false, "description": "游标ID", "example": "scroll-mctr7" }, { "name": "SearchAfter", "type": "array", "required": false, "description": "查询es使用searchAfter时，游标", "example": "[\"1463538857\", \"654323\"]", "item_type": "string" } ], "required": [] }, { "name": "ShrinkGroup", "description": "下线部署组所有机器实例", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "部署组ID，可通过调用[DescribeGroups](https://cloud.tencent.com/document/api/649/36065)查询已创建的部署组列表或登录控制台进行查看；也可以调用[CreateGroup](https://cloud.tencent.com/document/api/649/36074)创建新的部署组。", "example": "group-6a79x94v" } ], "required": [ "GroupId" ] }, { "name": "ShrinkInstances", "description": "虚拟机部署组下线实例", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "部署组ID，可通过调用[获取虚拟机部署组列表](https://cloud.tencent.com/document/api/649/36065)接口时出参中的Result.Content.GroupId，或登录[控制台](https://console.cloud.tencent.com/tsf/app-detail?rid=1\u0026id=application-aaaaaaaa\u0026tab=publish\u0026subTab=group)选择对应应用进入应用部署页面查看，同时也是调用[创建部署组](https://cloud.tencent.com/document/api/649/36074)接口返回的Result值", "example": "group-6a79x94v" }, { "name": "InstanceIdList", "type": "array", "required": true, "description": "实例ID列表，实例ID可通过调用[查询虚拟机部署组云主机列表](https://cloud.tencent.com/document/product/649/36066)接口时出参中的Result.Content.InstanceId，或登录[控制台](https://console.cloud.tencent.com/tsf/resource-detail?rid=1\u0026id=cluster-aaaaaaaa)选择对应的虚拟机集群查看云主机信息，同时也是[集群添加云主机](https://cloud.tencent.com/document/product/649/41225?ls=doc-search!current)接口的的返回值Result中的节点列表", "example": "[\"ins-6a79x94v\", \"ins-6a79kx78s\"]", "item_type": "string" } ], "required": [ "GroupId", "InstanceIdList" ] }, { "name": "StartContainerGroup", "description": "启动容器部署组", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "部署组ID，可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/api/649/36068)查询已创建的部署组列表或登录控制台进行查看；也可以调用[CreateContainGroup](https://cloud.tencent.com/document/api/649/36075)创建新的部署组。", "example": "group-s892j3s" } ], "required": [ "GroupId" ] }, { "name": "StartGroup", "description": "启动分组", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "按照【部署组ID】进行部署组启动，可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/product/649/36068)查询已创建的部署组列表或登录[控制台](https://console.cloud.tencent.com/tsf/app-detail?rid=1\u0026id=application-zvw6zp9a\u0026tab=publish\u0026subTab=group)进行查看；也可以调用[CreateGroup](https://cloud.tencent.com/document/product/649/36074)创建新的部署组。", "example": "group-2ks8wsk" } ], "required": [ "GroupId" ] }, { "name": "StopContainerGroup", "description": "停止容器部署组", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "部署组ID，可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/api/649/36068)查询已创建的部署组列表或登录控制台进行查看；也可以调用[CreateContainGroup](https://cloud.tencent.com/document/api/649/36075)创建新的部署组。", "example": "group-w28snw" } ], "required": [ "GroupId" ] }, { "name": "StopGroup", "description": "停止虚拟机部署组", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "按照【部署组ID】进行部署组删除，可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/product/649/36068)查询已创建的部署组列表或登录[控制台](https://console.cloud.tencent.com/tsf/app-detail?rid=1\u0026id=application-zvw6zp9a\u0026tab=publish\u0026subTab=group)进行查看；也可以调用[CreateGroup](https://cloud.tencent.com/document/product/649/36074)创建新的部署组。", "example": "group-wns82m" } ], "required": [ "GroupId" ] }, { "name": "StopTaskBatch", "description": "分布式任务调度 TCT 已到达 EOMS 节点，进行产品下线处理。退市公告https://cloud.tencent.com/announce/detail/2053 停止执行中的任务批次， 非运行中的任务不可调用。", "status": "deprecated", "parameters": [ { "name": "BatchId", "type": "string", "required": true, "description": "任务批次ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)页面点击任务ID进入任务详情，进入执行记录列表页，第一列即为任务批次ID。", "example": "batch-2kjs83" }, { "name": "TaskId", "type": "string", "required": false, "description": "任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页面可以查看任务ID。", "example": "task-kw92ux" } ], "required": [ "BatchId" ] }, { "name": "StopTaskExecute", "description": "分布式任务调度 TCT 已到达 EOMS 节点，进行产品下线处理。退市公告https://cloud.tencent.com/announce/detail/2053 停止正在某个节点上执行的任务", "status": "deprecated", "parameters": [ { "name": "ExecuteId", "type": "string", "required": true, "description": "任务执行ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)页面点击任务ID进入任务详情，进入执行记录页，点击批次ID进入执行详情列表页，第一列即为任务执行ID。", "example": "execute-k2is9h" }, { "name": "BatchId", "type": "string", "required": false, "description": "任务批次ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)页面点击任务ID进入任务详情，进入执行记录列表页，第一列即为任务批次ID。", "example": "batch-k2is9h" }, { "name": "TaskId", "type": "string", "required": false, "description": "任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页面可以查看任务ID。", "example": "task-k2is9h" } ], "required": [ "ExecuteId" ] }, { "name": "TerminateTaskFlowBatch", "description": "分布式任务调度 TCT 已到达 EOMS 节点，进行产品下线处理。退市公告https://cloud.tencent.com/announce/detail/2053 停止一个工作流批次", "status": "deprecated", "parameters": [ { "name": "FlowBatchId", "type": "string", "required": true, "description": "工作流批次 ID，在[工作流执行记录](https://console.cloud.tencent.com/tsf/tct?rid=1\u0026tab=taskflow)列表页第一列获取。", "example": "fbatch-2ks9hk" } ], "required": [ "FlowBatchId" ] }, { "name": "UnbindApiGroup", "description": "API分组批量与网关解绑", "status": "online", "parameters": [ { "name": "GroupGatewayList", "type": "array", "required": true, "description": "分组网关id列表", "example": "[{\"GatewayDeployGroupId\":\"group-yo99lney\",\"GroupId\":\"grp-notmqbpe\"}]", "item_type": "object", "children": [ { "name": "GatewayDeployGroupId", "type": "string", "required": true, "description": "网关部署组ID", "example": "group-xoydmy26" }, { "name": "GroupId", "type": "string", "required": true, "description": "分组id", "example": "grp-57at58po" } ] } ], "required": [ "GroupGatewayList" ] }, { "name": "UpdateApiGroup", "description": "更新Api分组", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "Api 分组ID", "example": "grp-notmqbpe" }, { "name": "GroupName", "type": "string", "required": false, "description": "Api 分组名称", "example": "grp_app" }, { "name": "Description", "type": "string", "required": false, "description": "Api 分组描述", "example": "This is desc" }, { "name": "AuthType", "type": "string", "required": false, "description": "鉴权类型。 secret： 密钥鉴权； none:无鉴权", "example": "none" }, { "name": "GroupContext", "type": "string", "required": false, "description": "分组上下文", "example": "/grp_app" }, { "name": "NamespaceNameKey", "type": "string", "required": false, "description": "命名空间参数key值", "example": "TSF-NamespaceName" }, { "name": "ServiceNameKey", "type": "string", "required": false, "description": "微服务名参数key值", "example": "TSF-ServiceName" }, { "name": "NamespaceNameKeyPosition", "type": "string", "required": false, "description": "命名空间参数位置，path，header或query，默认是path", "example": "path" }, { "name": "ServiceNameKeyPosition", "type": "string", "required": false, "description": "微服务名参数位置，path，header或query，默认是path", "example": "path" } ], "required": [ "GroupId" ] }, { "name": "UpdateApiRateLimitRule", "description": "更新API限流规则", "status": "online", "parameters": [ { "name": "RuleId", "type": "string", "required": true, "description": "限流规则ID", "example": "rule-8qlpdumd" }, { "name": "UsableStatus", "type": "string", "required": true, "description": "开启/禁用，enabled/disabled", "example": "enabled" }, { "name": "MaxQps", "type": "integer", "required": false, "description": "qps值，开启限流规则时，必填", "example": "2000" } ], "required": [ "RuleId", "UsableStatus" ] }, { "name": "UpdateApiRateLimitRules", "description": "批量更新API限流规则", "status": "online", "parameters": [ { "name": "ApiIds", "type": "array", "required": true, "description": "API ID 列表", "example": "[\"api-b1sd366q\"]", "item_type": "string" }, { "name": "UsableStatus", "type": "string", "required": true, "description": "开启/禁用，enabled/disabled", "example": "enabled" }, { "name": "MaxQps", "type": "integer", "required": false, "description": "QPS值。开启限流规则时，必填", "example": "1000" } ], "required": [ "ApiIds", "UsableStatus" ] }, { "name": "UpdateApiTimeouts", "description": "批量更新API超时", "status": "online", "parameters": [ { "name": "ApiIds", "type": "array", "required": true, "description": "API ID 列表", "example": "[\"api-tnvxy4ta\"]", "item_type": "string" }, { "name": "UsableStatus", "type": "string", "required": true, "description": "开启/禁用，enabled/disabled", "example": "enabled" }, { "name": "Timeout", "type": "integer", "required": false, "description": "超时时间，单位毫秒，开启API超时时，必填", "example": "2000" } ], "required": [ "ApiIds", "UsableStatus" ] }, { "name": "UpdateConfigTemplate", "description": "更新参数模板", "status": "online", "parameters": [ { "name": "ConfigTemplateId", "type": "string", "required": true, "description": "配置模板ID。该参数可以通过调用 [DescribeConfigTemplate](https://cloud.tencent.com/document/product/649/85856) 的返回值中的 ConfigTemplateId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=template)查看；也可以调用[CreateConfigTemplate](https://cloud.tencent.com/document/product/649/85861)创建新的配置模板。", "example": "dcfg_temp-aln5d3wv" }, { "name": "ConfigTemplateName", "type": "string", "required": true, "description": "配置模板名称，最多支持60个字符，只能包含字母、数字及分隔符（“-”），且不能以分隔符开头或结尾。", "example": "app_config" }, { "name": "ConfigTemplateType", "type": "string", "required": true, "description": "配置模板对应的微服务框架。 - Ribbon：Ribbon类型配置模板 - Hystrix：Hystrix类型配置模板 - Zuul：Zuul类型配置模板 - customize：自定义类型配置模板", "example": "Ribbon" }, { "name": "ConfigTemplateValue", "type": "string", "required": true, "description": "配置模板数据。", "example": "ribbon.ReadTimeout: 5000" }, { "name": "ConfigTemplateDesc", "type": "string", "required": false, "description": "配置模板描述，最多支持200个字符。", "example": "This is desc" } ], "required": [ "ConfigTemplateId", "ConfigTemplateName", "ConfigTemplateType", "ConfigTemplateValue" ] }, { "name": "UpdateGatewayApi", "description": "更新API", "status": "online", "parameters": [ { "name": "ApiId", "type": "string", "required": true, "description": "API ID", "example": "api-zwua4plw" }, { "name": "Path", "type": "string", "required": false, "description": "API 路径", "example": "/echo-user" }, { "name": "Method", "type": "string", "required": false, "description": "Api 请求方法", "example": "GET" }, { "name": "PathMapping", "type": "string", "required": false, "description": "请求映射", "example": "/echo-user" }, { "name": "Host", "type": "string", "required": false, "description": "api所在服务host", "example": "http://www.qq.com" }, { "name": "Description", "type": "string", "required": false, "description": "api描述信息", "example": "this is desc" } ], "required": [ "ApiId" ] }, { "name": "UpdateHealthCheckSettings", "description": "更新健康检查配置", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "部署组ID，可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/api/649/36068)查询已创建的部署组列表或登录控制台进行查看；也可以调用[CreateContainGroup](https://cloud.tencent.com/document/api/649/36075)创建新的部署组。", "example": "group-gyqnd7py" }, { "name": "EnableHealthCheck", "type": "boolean", "required": false, "description": "是否开启健康检查", "example": "false" }, { "name": "HealthCheckSettings", "type": "object", "required": false, "description": "健康检查配置", "example": "无", "children": [ { "name": "LivenessProbe", "type": "object", "required": false, "description": "存活健康检查 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "ActionType", "type": "string", "required": true, "description": "健康检查方法。HTTP：通过 HTTP 接口检查；CMD：通过执行命令检查；TCP：通过建立 TCP 连接检查。 注意：此字段可能返回 null，表示取不到有效值。", "example": "HTTP" }, { "name": "InitialDelaySeconds", "type": "integer", "required": false, "description": "容器延时启动健康检查的时间，单位秒。 注意：此字段可能返回 null，表示取不到有效值。", "example": "180" }, { "name": "TimeoutSeconds", "type": "integer", "required": false, "description": "每次健康检查响应的最大超时时间，单位秒。 注意：此字段可能返回 null，表示取不到有效值。", "example": "30" }, { "name": "PeriodSeconds", "type": "integer", "required": false, "description": "进行健康检查的时间间隔，单位秒。 注意：此字段可能返回 null，表示取不到有效值。", "example": "30" }, { "name": "SuccessThreshold", "type": "integer", "required": false, "description": "表示后端容器从失败到成功的连续健康检查成功次数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "FailureThreshold", "type": "integer", "required": false, "description": "表示后端容器从成功到失败的连续健康检查成功次数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "3" }, { "name": "Scheme", "type": "string", "required": false, "description": "HTTP 健康检查方法使用的检查协议。支持HTTP、HTTPS。 注意：此字段可能返回 null，表示取不到有效值。", "example": "HTTP" }, { "name": "Port", "type": "integer", "required": false, "description": "健康检查端口，范围 1~65535 。 注意：此字段可能返回 null，表示取不到有效值。", "example": "8080" }, { "name": "Path", "type": "string", "required": false, "description": "HTTP 健康检查接口的请求路径。 注意：此字段可能返回 null，表示取不到有效值。", "example": "/health" }, { "name": "Command", "type": "array", "required": false, "description": "执行命令检查方式，执行的命令。 注意：此字段可能返回 null，表示取不到有效值。", "example": "sh health.sh", "item_type": "string" }, { "name": "Type", "type": "string", "required": false, "description": "TSF_DEFAULT：tsf 默认就绪探针。K8S_NATIVE：k8s 原生探针。不填默认为 k8s 原生探针。 注意：此字段可能返回 null，表示取不到有效值。", "example": "K8S_NATIVE" } ] }, { "name": "ReadinessProbe", "type": "object", "required": false, "description": "就绪健康检查 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "ActionType", "type": "string", "required": true, "description": "健康检查方法。HTTP：通过 HTTP 接口检查；CMD：通过执行命令检查；TCP：通过建立 TCP 连接检查。 注意：此字段可能返回 null，表示取不到有效值。", "example": "HTTP" }, { "name": "InitialDelaySeconds", "type": "integer", "required": false, "description": "容器延时启动健康检查的时间，单位秒。 注意：此字段可能返回 null，表示取不到有效值。", "example": "180" }, { "name": "TimeoutSeconds", "type": "integer", "required": false, "description": "每次健康检查响应的最大超时时间，单位秒。 注意：此字段可能返回 null，表示取不到有效值。", "example": "30" }, { "name": "PeriodSeconds", "type": "integer", "required": false, "description": "进行健康检查的时间间隔，单位秒。 注意：此字段可能返回 null，表示取不到有效值。", "example": "30" }, { "name": "SuccessThreshold", "type": "integer", "required": false, "description": "表示后端容器从失败到成功的连续健康检查成功次数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "FailureThreshold", "type": "integer", "required": false, "description": "表示后端容器从成功到失败的连续健康检查成功次数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "3" }, { "name": "Scheme", "type": "string", "required": false, "description": "HTTP 健康检查方法使用的检查协议。支持HTTP、HTTPS。 注意：此字段可能返回 null，表示取不到有效值。", "example": "HTTP" }, { "name": "Port", "type": "integer", "required": false, "description": "健康检查端口，范围 1~65535 。 注意：此字段可能返回 null，表示取不到有效值。", "example": "8080" }, { "name": "Path", "type": "string", "required": false, "description": "HTTP 健康检查接口的请求路径。 注意：此字段可能返回 null，表示取不到有效值。", "example": "/health" }, { "name": "Command", "type": "array", "required": false, "description": "执行命令检查方式，执行的命令。 注意：此字段可能返回 null，表示取不到有效值。", "example": "sh health.sh", "item_type": "string" }, { "name": "Type", "type": "string", "required": false, "description": "TSF_DEFAULT：tsf 默认就绪探针。K8S_NATIVE：k8s 原生探针。不填默认为 k8s 原生探针。 注意：此字段可能返回 null，表示取不到有效值。", "example": "K8S_NATIVE" } ] } ] } ], "required": [ "GroupId" ] }, { "name": "UpdateRepository", "description": "更新仓库信息", "status": "online", "parameters": [ { "name": "RepositoryId", "type": "string", "required": true, "description": "仓库ID，可通过调用[仓库信息查询类](https://cloud.tencent.com/document/api/649/45925)接口时出参中的RepositoryId，或登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看", "example": "repo-6a79x94v" }, { "name": "RepositoryDesc", "type": "string", "required": false, "description": "仓库描述", "example": "this is a desc" } ], "required": [ "RepositoryId" ] }, { "name": "UpdateUnitRule", "description": "更新单元化规则", "status": "online", "parameters": [ { "name": "Id", "type": "string", "required": true, "description": "规则ID", "example": "unit-rl-cgd3l6jo" }, { "name": "Name", "type": "string", "required": true, "description": "规则名称", "example": "user_unit" }, { "name": "Description", "type": "string", "required": false, "description": "规则描述", "example": "This is desc" }, { "name": "UnitRuleItemList", "type": "array", "required": false, "description": "规则项列表", "example": "[{\"Relationship\":\"AND\",\"DestNamespaceId\":\"namespace-vk5blxnv\",\"DestNamespaceName\":\"global_default\",\"Name\":\"unit_provider\",\"Priority\":1,\"Description\":\"This is desc\"}]", "item_type": "object", "children": [ { "name": "Relationship", "type": "string", "required": true, "description": "逻辑关系：AND/OR", "example": "AND" }, { "name": "DestNamespaceId", "type": "string", "required": true, "description": "目的地命名空间ID", "example": "namespace-6ymbkkvg" }, { "name": "DestNamespaceName", "type": "string", "required": true, "description": "目的地命名空间名称", "example": "ns_app" }, { "name": "Name", "type": "string", "required": true, "description": "规则项名称", "example": "unit_rule_app" }, { "name": "Id", "type": "string", "required": false, "description": "规则项ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "unit-item-1h36x2yt" }, { "name": "UnitRuleId", "type": "string", "required": false, "description": "单元化规则ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "unit-rl-8hsa450s" }, { "name": "Priority", "type": "integer", "required": false, "description": "规则顺序，越小优先级越高：默认为0 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "Description", "type": "string", "required": false, "description": "规则描述 注意：此字段可能返回 null，表示取不到有效值。", "example": "This is desc" }, { "name": "UnitRuleTagList", "type": "array", "required": false, "description": "规则标签列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "[{\"Id\":\"unit-tag-vmhijoic\",\"UnitRuleItemId\":\"unit-item-ghpuh9rn\",\"TagType\":\"U\",\"TagField\":\"user\",\"TagOperator\":\"IN\",\"TagValue\":\"1\",\"ItemIndex\":1,\"CreatedTime\":\"2024-12-23 11:14:17\",\"UpdatedTime\":\"2024-12-23 11:14:17\"}]", "item_type": "object", "children": [ { "name": "TagType", "type": "string", "required": true, "description": "标签类型 : U(用户标签)/S(系统标签)", "example": "U" }, { "name": "TagField", "type": "string", "required": true, "description": "标签名", "example": "userId" }, { "name": "TagOperator", "type": "string", "required": true, "description": "操作符:IN/NOT_IN/EQUAL/NOT_EQUAL/REGEX", "example": "EQUAL" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值", "example": "1" }, { "name": "UnitRuleItemId", "type": "string", "required": false, "description": "单元化规则项ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "unit-item-uaji5qpr" }, { "name": "Id", "type": "string", "required": false, "description": "规则ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "unit-tag-6zpb4xrv" } ] }, { "name": "ItemIndex", "type": "integer", "required": false, "description": "规则项索引 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "CreatedTime", "type": "string", "required": false, "description": "创建时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "2024-12-23 11:14:17" }, { "name": "UpdatedTime", "type": "string", "required": false, "description": "修改时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "2024-12-23 11:14:17" } ] } ], "required": [ "Id", "Name" ] } ] }