{ "name": "lighthouse", "display_name": "轻量应用服务器", "description": "介绍如何使用API对 Lighthouse 资源和服务进行相关操作，如启动实例、关闭实例、重启实例、查询实例列表等。", "domain": "compute", "api_version": "2020-03-24", "endpoint": "lighthouse.tencentcloudapi.com", "actions": [ { "name": "ApplyDiskBackup", "description": "本接口（ApplyDiskBackup）用于回滚指定云硬盘的备份点。 * 仅支持回滚到原云硬盘。 * 用于回滚的云硬盘备份点必须处于 NORMAL 状态。 云硬盘备份点状态可以通过 [DescribeDiskBackups](https://cloud.tencent.com/document/api/1207/84379) 接口查询。 * 回滚云硬盘备份点时，云硬盘的状态必须为 UNATTACHED或ATTACHED。 云硬盘状态可通过 [DescribeDisks](https://cloud.tencent.com/document/api/1207/66093) 接口查询。 * 如\ufffd\ufffd...", "status": "online", "parameters": [ { "name": "DiskId", "type": "string", "required": true, "description": "云硬盘ID，可通过[DescribeDisks](https://cloud.tencent.com/document/api/1207/66093)接口查询。", "example": "lhdisk-qtovvuzq" }, { "name": "DiskBackupId", "type": "string", "required": true, "description": "云硬盘备份点ID，可通过[DescribeDiskBackups](https://cloud.tencent.com/document/api/1207/84379)接口查询。", "example": "lhbak-ounanbtt " } ], "required": [ "DiskId", "DiskBackupId" ] }, { "name": "ApplyFirewallTemplate", "description": "本接口 (ApplyFirewallTemplate) 用于应用防火墙模板到多个实例。", "status": "online", "parameters": [ { "name": "TemplateId", "type": "string", "required": true, "description": "防火墙模板ID。可通过[DescribeFirewallTemplates](https://cloud.tencent.com/document/product/1207/96874)接口返回值字段TemplateSet获取。", "example": "lhft-s2dxd7iy" }, { "name": "ApplyInstances", "type": "array", "required": true, "description": "应用防火墙模板的实例列表。列表长度最大值是100。", "example": "无", "item_type": "object", "children": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。", "example": "lhins-abcd1234" }, { "name": "Region", "type": "string", "required": true, "description": "实例地域。", "example": "ap-guangzhou" } ] } ], "required": [ "TemplateId", "ApplyInstances" ] }, { "name": "ApplyInstanceSnapshot", "description": "本接口（ApplyInstanceSnapshot）用于回滚指定实例的系统盘快照。 - 仅支持回滚到原系统盘。 - 用于回滚的快照必须处于 NORMAL 状态。快照状态可以通过 [DescribeSnapshots](https://cloud.tencent.com/document/product/1207/54388) 接口查询，见输出参数中 SnapshotState 字段解释。 - 回滚快照时，实例的状态必须为 STOPPED 或 RUNNING，可通过 [DescribeInstances](https://cloud.tencent.com/document/product/1207/47573) 接口查询\ufffd\ufffd...", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeInstances](https://cloud.tencent.com/document/product/1207/47573) 接口返回值中的 InstanceId 获取。", "example": "lhins-k31c771o" }, { "name": "SnapshotId", "type": "string", "required": true, "description": "快照 ID。可通过 [DescribeSnapshots](https://cloud.tencent.com/document/product/1207/54388) 接口返回值中的 SnapshotId 获取。", "example": "lhsnap-nv6aqcv6" } ], "required": [ "InstanceId", "SnapshotId" ] }, { "name": "AssociateInstancesKeyPairs", "description": "本接口（AssociateInstancesKeyPairs）用于绑定用户指定密钥对到实例。 * 只支持 [RUNNING, STOPPED] 状态的 LINUX_UNIX 操作系统的实例。处于 RUNNING 状态的实例会强制关机，然后绑定。 * 将密钥的公钥写入到实例的 SSH 配置当中，用户就可以通过该密钥的私钥来登录实例。 * 如果实例原来绑定过密钥，那么原来的密钥将失效。 * 如果实例原来是通过密码登录，绑定密钥后无法使用密码登录\ufffd\ufffd...", "status": "online", "parameters": [ { "name": "KeyIds", "type": "array", "required": true, "description": "密钥对 ID 列表，每次请求批量密钥对的上限为 100。可通过[DescribeKeyPairs](https://cloud.tencent.com/document/api/1207/55540)接口返回值中的KeyId获取。", "example": "[\"lhkp-f7rjie1q\"]", "item_type": "string" }, { "name": "InstanceIds", "type": "array", "required": true, "description": "实例 ID 列表。每次请求批量实例的上限为 100。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。", "example": "[\"lhins-ruy9d2tw\"]", "item_type": "string" } ], "required": [ "KeyIds", "InstanceIds" ] }, { "name": "AttachCcn", "description": "本接口 (AttachCcn) 用于建立与云联网的关联。", "status": "online", "parameters": [ { "name": "CcnId", "type": "string", "required": true, "description": "云联网实例ID。可通过[DescribeCcns](https://cloud.tencent.com/document/product/215/19199)接口返回值中的CcnId获取。", "example": "ccn-f49l6u0z" } ], "required": [ "CcnId" ] }, { "name": "AttachDisks", "description": "本接口（AttachDisks）用于挂载一个或多个云硬盘。 只能挂载磁盘状态（DiskState）处于待挂载（UNATTACHED）状态的云硬盘，磁盘状态可通过接口查询云硬盘（DescribeDisks）获取", "status": "online", "parameters": [ { "name": "DiskIds", "type": "array", "required": true, "description": "云硬盘ID列表。每次批量请求云硬盘的上限为 100。可通过[DescribeDisks](https://cloud.tencent.com/document/product/1207/66093)接口返回值中的DiskId获取。", "example": "[\"lhdisk-5vmz00i3\"]", "item_type": "string" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/product/1207/47573)接口返回值中的InstanceId获取。", "example": "lhins-qg08np8l" }, { "name": "RenewFlag", "type": "string", "required": false, "description": "自动续费标识。取值范围： NOTIFY_AND_AUTO_RENEW：通知过期且自动续费。 NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费，用户需要手动续费。 DISABLE_NOTIFY_AND_MANUAL_RENEW：不自动续费，且不通知。 默认取值：NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，云盘到期后将按月自动续费。", "example": "NOTIFY_AND_AUTO_RENEW" } ], "required": [ "DiskIds", "InstanceId" ] }, { "name": "CancelShareBlueprintAcrossAccounts", "description": "本接口（CancelShareBlueprintAcrossAccounts）用于取消镜像跨账号共享。 指定的镜像ID必须为自定义镜像，且指定账号ID必须已进行共享。", "status": "online", "parameters": [ { "name": "BlueprintId", "type": "string", "required": true, "description": "镜像ID, 可以通过[DescribeBlueprints](https://cloud.tencent.com/document/product/1207/47689)接口返回的BlueprintId获取。", "example": "\"lhbp-6jc6l8yb\"" }, { "name": "AccountIds", "type": "array", "required": true, "description": "接收共享镜像的[账号ID](https://cloud.tencent.com/document/product/213/4944#.E8.8E.B7.E5.8F.96.E4.B8.BB.E8.B4.A6.E5.8F.B7.E7.9A.84.E8.B4.A6.E5.8F.B7-id)列表。账号ID不同于QQ号，查询用户账号ID请查看账号信息中的账号ID栏。账号个数取值最大为10。", "example": "[\"700000164995\"]", "item_type": "string" } ], "required": [ "BlueprintId", "AccountIds" ] }, { "name": "CreateBlueprint", "description": "本接口 (CreateBlueprint) 用于创建镜像。", "status": "online", "parameters": [ { "name": "BlueprintName", "type": "string", "required": true, "description": "镜像名称。最大长度60。", "example": "test-blueprint" }, { "name": "Description", "type": "string", "required": false, "description": "镜像描述。最大长度60。", "example": "test-blueprint" }, { "name": "InstanceId", "type": "string", "required": false, "description": "需要制作镜像的实例ID。可通过 [DescribeInstances](https://cloud.tencent.com/document/api/1207/47573) 接口返回值中的 InstanceId 获取。", "example": "lhins-aaaabbbb" }, { "name": "ForcePowerOff", "type": "boolean", "required": false, "description": "是否执行强制关机以制作镜像。 取值范围： True：表示关机之后制作镜像 False：表示开机状态制作镜像 默认取值：True 开机状态制作镜像，可能导致部分数据未备份，影响数据安全。", "example": "true" }, { "name": "Tags", "type": "array", "required": false, "description": "标签键和标签值。 如果指定多个标签，则会为指定资源同时创建并绑定该多个标签。 同一个资源上的同一个标签键只能对应一个标签值。如果您尝试添加已有标签键，则对应的标签值会更新为新值。 如果标签不存在会为您自动创建标签。 数组最多支持10个元素。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "Owner" }, { "name": "Value", "type": "string", "required": true, "description": "标签值", "example": "Green" } ] } ], "required": [ "BlueprintName" ] }, { "name": "CreateDiskBackup", "description": "本接口 ( CreateDiskBackup ) 用于创建指定云硬盘（当前只支持数据盘）的备份点。", "status": "online", "parameters": [ { "name": "DiskId", "type": "string", "required": true, "description": "云硬盘ID，可通过 [DescribeDisks](https://cloud.tencent.com/document/api/1207/66093) 接口返回值中的 DiskId 获取。", "example": "lhdisk-p1zflrif" }, { "name": "DiskBackupName", "type": "string", "required": false, "description": "云硬盘备份点名称，最大长度为 90 。", "example": "disk-backup-01" }, { "name": "Tags", "type": "array", "required": false, "description": "标签键和标签值。 如果指定多个标签，则会为指定资源同时创建并绑定该多个标签。 同一个资源上的同一个标签键只能对应一个标签值。如果您尝试添加已有标签键，则对应的标签值会更新为新值。 如果标签不存在会为您自动创建标签。 数组最多支持10个元素。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "Owner" }, { "name": "Value", "type": "string", "required": true, "description": "标签值", "example": "Green" } ] } ], "required": [ "DiskId" ] }, { "name": "CreateDisks", "description": "本接口(CreateDisks)用于创建一个或多个云硬盘。", "status": "online", "parameters": [ { "name": "Zone", "type": "string", "required": true, "description": "可用区。可通过[DescribeZones](https://cloud.tencent.com/document/product/1207/57513)返回值中的Zone获取。", "example": "ap-hongkong-2" }, { "name": "DiskSize", "type": "integer", "required": true, "description": "云硬盘大小, 单位: GB。", "example": "20" }, { "name": "DiskType", "type": "string", "required": true, "description": "云硬盘介质类型。取值: \"CLOUD_PREMIUM\"(高性能云盘), \"CLOUD_SSD\"(SSD云硬盘)。", "example": "CLOUD_SSD" }, { "name": "DiskChargePrepaid", "type": "object", "required": true, "description": "云硬盘包年包月相关参数设置。", "example": "无", "children": [ { "name": "Period", "type": "integer", "required": true, "description": "新购周期。 可选值：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60。", "example": "1" }, { "name": "RenewFlag", "type": "string", "required": false, "description": "自动续费标识。取值范围： - NOTIFY_AND_AUTO_RENEW：通知过期且自动续费。 - NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费，用户需要手动续费。 - DISABLE_NOTIFY_AND_MANUAL_RENEW：不自动续费，且不通知。 默认取值：NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，云硬盘到期后将按月自动续费。", "example": "NOTIFY_AND_AUTO_RENEW" }, { "name": "TimeUnit", "type": "string", "required": false, "description": "新购单位.。 可选值：m - 月。 默认值：m - 月。", "example": "m" } ] }, { "name": "DiskName", "type": "string", "required": false, "description": "云硬盘名称。最大长度60。", "example": "disk_for_softwares" }, { "name": "DiskCount", "type": "integer", "required": false, "description": "云硬盘个数。取值范围: [1, 30]。默认值: 1。", "example": "1" }, { "name": "DiskBackupQuota", "type": "integer", "required": false, "description": "指定云硬盘备份点配额，取值范围: [0, 500]。不传时默认为不带备份点配额。", "example": "1" }, { "name": "AutoVoucher", "type": "boolean", "required": false, "description": "是否自动使用代金券。默认不使用。", "example": "false" }, { "name": "AutoMountConfiguration", "type": "object", "required": false, "description": "自动挂载并初始化数据盘。", "example": "无", "children": [ { "name": "InstanceId", "type": "string", "required": true, "description": "待挂载的实例ID。指定的实例必须与指定的数据盘处于同一可用区，实例状态必须处于“运行中”状态，且实例必须支持[自动化助手](https://cloud.tencent.com/document/product/1340/50752)。", "example": "lhins-xxxxxx" }, { "name": "MountPoint", "type": "string", "required": false, "description": "实例内的挂载点。仅Linux操作系统的实例可传入该参数, 不传则默认挂载在“/data/disk”路径下。", "example": "/data/disk" }, { "name": "FileSystemType", "type": "string", "required": false, "description": "文件系统类型。取值: “ext4”、“xfs”。仅Linux操作系统的实例可传入该参数, 不传则默认为“ext4”。", "example": "ext4" } ] }, { "name": "Tags", "type": "array", "required": false, "description": "标签键和标签值。 如果指定多个标签，则会为指定资源同时创建并绑定该多个标签。 同一个资源上的同一个标签键只能对应一个标签值。如果您尝试添加已有标签键，则对应的标签值会更新为新值。 如果标签不存在会为您自动创建标签。 数组最多支持10个元素。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "Owner" }, { "name": "Value", "type": "string", "required": true, "description": "标签值", "example": "Green" } ] } ], "required": [ "Zone", "DiskSize", "DiskType", "DiskChargePrepaid" ] }, { "name": "CreateFirewallRules", "description": "本接口（CreateFirewallRules）用于在实例上添加防火墙规则。 * FirewallVersion 为防火墙版本号，用户每次更新防火墙规则版本会自动加1，防止您更新的规则已过期，不填不考虑冲突。FirewallVersion可通过[DescribeFirewallRules](https://cloud.tencent.com/document/api/1207/48252)接口返回值中的FirewallVersion获取。 在 FirewallRules 参数中： * Protocol 字段支持输入 TCP，UDP，ICMP，ICMPv6，ALL。 * Port 字段允许输入 ...", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。可通过 [DescribeInstances](https://cloud.tencent.com/document/api/1207/47573) 接口返回值中的 InstanceId 获取。", "example": "lhins-aglzynfg" }, { "name": "FirewallRules", "type": "array", "required": true, "description": "防火墙规则列表。", "example": "无", "item_type": "object", "children": [ { "name": "Protocol", "type": "string", "required": true, "description": "协议，取值：TCP，UDP，ICMP，ALL，ICMPv6。 - 使用ICMP协议时，只支持CidrBlock，不支持使用Port、Ipv6CidrBlock参数； - 使用ICMPv6协议时，只支持Ipv6CidrBlock，不支持使用Port、Ipv6CidrBlock参数；", "example": "TCP" }, { "name": "Port", "type": "string", "required": false, "description": "端口，取值：ALL，单独的端口，逗号分隔的离散端口，减号分隔的端口范围。注意：单独的端口与离散端口不能同时存在。", "example": "80" }, { "name": "CidrBlock", "type": "string", "required": false, "description": "IPv4网段或 IPv4地址(互斥)。 示例值：0.0.0.0/0。 和Ipv6CidrBlock互斥，两者都不指定时，如果Protocol不是ICMPv6，则取默认值0.0.0.0/0。", "example": "0.0.0.0/0" }, { "name": "Ipv6CidrBlock", "type": "string", "required": false, "description": "IPv6网段或IPv6地址(互斥)。 示例值：::/0。 和CidrBlock互斥，两者都不指定时，如果Protocol是ICMPv6，则取默认值::/0。", "example": "::/0" }, { "name": "Action", "type": "string", "required": false, "description": "取值：ACCEPT（允许），DROP（拒绝）。默认为 ACCEPT。", "example": "ACCEPT" }, { "name": "FirewallRuleDescription", "type": "string", "required": false, "description": "防火墙规则描述。", "example": "firewallrule description" } ] }, { "name": "FirewallVersion", "type": "integer", "required": false, "description": "防火墙当前版本。用户每次更新防火墙规则时版本会自动加1，防止规则已过期，不填不考虑冲突。", "example": "5" } ], "required": [ "InstanceId", "FirewallRules" ] }, { "name": "CreateFirewallTemplate", "description": "本接口 (CreateFirewallTemplate) 用于创建防火墙模板。", "status": "online", "parameters": [ { "name": "TemplateName", "type": "string", "required": true, "description": "模板名称。", "example": "DemoTemplate" }, { "name": "TemplateRules", "type": "array", "required": false, "description": "防火墙规则列表。", "example": "无", "item_type": "object", "children": [ { "name": "Protocol", "type": "string", "required": true, "description": "协议，取值：TCP，UDP，ICMP，ALL，ICMPv6。 - 使用ICMP协议时，只支持CidrBlock，不支持使用Port、Ipv6CidrBlock参数； - 使用ICMPv6协议时，只支持Ipv6CidrBlock，不支持使用Port、Ipv6CidrBlock参数；", "example": "TCP" }, { "name": "Port", "type": "string", "required": false, "description": "端口，取值：ALL，单独的端口，逗号分隔的离散端口，减号分隔的端口范围。注意：单独的端口与离散端口不能同时存在。", "example": "80" }, { "name": "CidrBlock", "type": "string", "required": false, "description": "IPv4网段或 IPv4地址(互斥)。 示例值：0.0.0.0/0。 和Ipv6CidrBlock互斥，两者都不指定时，如果Protocol不是ICMPv6，则取默认值0.0.0.0/0。", "example": "0.0.0.0/0" }, { "name": "Ipv6CidrBlock", "type": "string", "required": false, "description": "IPv6网段或IPv6地址(互斥)。 示例值：::/0。 和CidrBlock互斥，两者都不指定时，如果Protocol是ICMPv6，则取默认值::/0。", "example": "::/0" }, { "name": "Action", "type": "string", "required": false, "description": "取值：ACCEPT（允许），DROP（拒绝）。默认为 ACCEPT。", "example": "ACCEPT" }, { "name": "FirewallRuleDescription", "type": "string", "required": false, "description": "防火墙规则描述。", "example": "firewallrule description" } ] } ], "required": [ "TemplateName" ] }, { "name": "CreateFirewallTemplateRules", "description": "本接口 (CreateFirewallTemplateRules) 用于创建防火墙模板规则。", "status": "online", "parameters": [ { "name": "TemplateId", "type": "string", "required": true, "description": "防火墙模板ID。可通过[DescribeFirewallTemplates](https://cloud.tencent.com/document/product/1207/96874)接口返回值字段TemplateSet获取。", "example": "lhft-abcd1234" }, { "name": "TemplateRules", "type": "array", "required": true, "description": "防火墙模板规则列表。", "example": "无", "item_type": "object", "children": [ { "name": "Protocol", "type": "string", "required": true, "description": "协议，取值：TCP，UDP，ICMP，ALL，ICMPv6。 - 使用ICMP协议时，只支持CidrBlock，不支持使用Port、Ipv6CidrBlock参数； - 使用ICMPv6协议时，只支持Ipv6CidrBlock，不支持使用Port、Ipv6CidrBlock参数；", "example": "TCP" }, { "name": "Port", "type": "string", "required": false, "description": "端口，取值：ALL，单独的端口，逗号分隔的离散端口，减号分隔的端口范围。注意：单独的端口与离散端口不能同时存在。", "example": "80" }, { "name": "CidrBlock", "type": "string", "required": false, "description": "IPv4网段或 IPv4地址(互斥)。 示例值：0.0.0.0/0。 和Ipv6CidrBlock互斥，两者都不指定时，如果Protocol不是ICMPv6，则取默认值0.0.0.0/0。", "example": "0.0.0.0/0" }, { "name": "Ipv6CidrBlock", "type": "string", "required": false, "description": "IPv6网段或IPv6地址(互斥)。 示例值：::/0。 和CidrBlock互斥，两者都不指定时，如果Protocol是ICMPv6，则取默认值::/0。", "example": "::/0" }, { "name": "Action", "type": "string", "required": false, "description": "取值：ACCEPT（允许），DROP（拒绝）。默认为 ACCEPT。", "example": "ACCEPT" }, { "name": "FirewallRuleDescription", "type": "string", "required": false, "description": "防火墙规则描述。", "example": "firewallrule description" } ] } ], "required": [ "TemplateId", "TemplateRules" ] }, { "name": "CreateInstanceSnapshot", "description": "本接口（CreateInstanceSnapshot）用于创建指定实例的系统盘快照。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "需要创建快照的实例 ID。可通过 [DescribeInstances](https://cloud.tencent.com/document/product/1207/47573) 接口返回值中的 InstanceId 获取。", "example": "lhins-k31c771o" }, { "name": "SnapshotName", "type": "string", "required": false, "description": "快照名称，最长为 60 个字符。", "example": "snap_20200903" }, { "name": "Tags", "type": "array", "required": false, "description": "标签键和标签值。 如果指定多个标签，则会为指定资源同时创建并绑定该多个标签。 同一个资源上的同一个标签键只能对应一个标签值。如果您尝试添加已有标签键，则对应的标签值会更新为新值。 如果标签不存在会为您自动创建标签。 数组最多支持10个元素。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "Owner" }, { "name": "Value", "type": "string", "required": true, "description": "标签值", "example": "Green" } ] } ], "required": [ "InstanceId" ] }, { "name": "CreateInstances", "description": "本接口(CreateInstances)用于创建一个或多个指定套餐的轻量应用服务器实例。 *创建实例时，如指定实例访问域名信息时，本次创建请求，仅支持购买一台实例。", "status": "online", "parameters": [ { "name": "BundleId", "type": "string", "required": true, "description": "套餐ID。可以通过调用 [DescribeBundles](https://cloud.tencent.com/document/api/1207/47575) 接口获取。", "example": "bundle_gen_03" }, { "name": "BlueprintId", "type": "string", "required": true, "description": "镜像ID。可以通过调用 [DescribeBlueprints](https://cloud.tencent.com/document/api/1207/47689) 接口获取。", "example": "lhbp-g0tn7djh" }, { "name": "InstanceChargePrepaid", "type": "object", "required": true, "description": "当前实例仅支持预付费模式，即包年包月相关参数设置，单位（月）。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。该参数必传。", "example": "无", "children": [ { "name": "Period", "type": "integer", "required": true, "description": "购买实例的时长，单位：月。 - 创建实例时，取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60。 - 续费实例时，取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36。", "example": "1" }, { "name": "RenewFlag", "type": "string", "required": false, "description": "自动续费标识。取值范围：NOTIFY_AND_AUTO_RENEW：通知过期且自动续费NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费，用户需要手动续费DISABLE_NOTIFY_AND_MANUAL_RENEW：不自动续费，且不通知默认取值：NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，实例到期后将按月自动续费。", "example": "NOTIFY_AND_AUTO_RENEW" } ] }, { "name": "InstanceName", "type": "string", "required": false, "description": "实例显示名称。", "example": "mylighthouse" }, { "name": "InstanceCount", "type": "integer", "required": false, "description": "购买实例数量。包年包月实例取值范围：[1，30]。默认取值：1。指定购买实例的数量不能超过用户所能购买的剩余配额数量", "example": "1" }, { "name": "Zones", "type": "array", "required": false, "description": "可用区列表。 不填此参数，表示为随机可用区。 可通过 DescribeZones接口获取指定地域下的可用区列表信息", "example": "[\"ap-beijing-1\"]", "item_type": "string" }, { "name": "DryRun", "type": "boolean", "required": false, "description": "是否只预检此次请求。 true：发送检查请求，不会创建实例。检查项包括是否填写了必需参数，请求格式，业务限制和库存。 如果检查不通过，则返回对应错误码； 如果检查通过，则返回RequestId. false（默认）：发送正常请求，通过检查后直接创建实例", "example": "false" }, { "name": "ClientToken", "type": "string", "required": false, "description": "用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。", "example": "test-create-instance-client-token" }, { "name": "LoginConfiguration", "type": "object", "required": false, "description": "实例登录密码信息配置。默认缺失情况下代表用户选择实例创建后设置登录密码。", "example": "无", "children": [ { "name": "AutoGeneratePassword", "type": "string", "required": false, "description": "\"YES\"代表选择自动生成密码，这时不指定Password字段。 \"NO\"代表选择自定义密码，这时要指定Password字段。", "example": "NO" }, { "name": "Password", "type": "string", "required": false, "description": "实例登录密码。具体按照操作系统的复杂度要求。 `LINUX_UNIX` 实例密码必须 8-30 位，推荐使用 12 位以上密码，不能包含空格，不能以“/”开头，至少包含以下字符中的三种不同字符，字符种类： 小写字母：[a-z] 大写字母：[A-Z] 数字：0-9 特殊字符： ()\\`\\~!@#$%^\u0026\\*-+=\\_|{}[]:;' ,.?/ `WINDOWS` 实例密码必须 12-30 位，不能包含空格，不能以“/”开头且不包括用户名，至少包含以下字符中的...", "example": " HelloTgHd123_\u0026*" }, { "name": "KeyIds", "type": "array", "required": false, "description": "密钥ID列表，最多同时指定5个密钥。关联密钥后，就可以通过对应的私钥来访问实例。密钥与密码不能同时指定，同时WINDOWS操作系统不支持指定密钥。密钥ID列表可以通过[DescribeKeyPairs](https://cloud.tencent.com/document/product/1207/55540)接口获取。", "example": "[\"lhkp-7f7lh1fv\"]", "item_type": "string" } ] }, { "name": "Containers", "type": "array", "required": false, "description": "要创建的容器配置列表。", "example": "无", "item_type": "object", "children": [ { "name": "ContainerImage", "type": "string", "required": true, "description": "容器镜像地址", "example": "nginx" }, { "name": "ContainerName", "type": "string", "required": false, "description": "容器名称", "example": "Container1" }, { "name": "Envs", "type": "array", "required": false, "description": "环境变量列表", "example": "[{\"Key\":\"Key1\",\"Value\":\"Value1\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "环境变量Key 注意：此字段可能返回 null，表示取不到有效值。", "example": "K1" }, { "name": "Value", "type": "string", "required": true, "description": "环境变量值 注意：此字段可能返回 null，表示取不到有效值。", "example": "V1" } ] }, { "name": "PublishPorts", "type": "array", "required": false, "description": "容器端口主机端口映射列表", "example": "[{\"ContainerPort\":80,\"HostPort\":8081}]", "item_type": "object", "children": [ { "name": "HostPort", "type": "integer", "required": true, "description": "主机端口", "example": "80" }, { "name": "ContainerPort", "type": "integer", "required": true, "description": "容器端口", "example": "80" }, { "name": "Ip", "type": "string", "required": false, "description": "对外绑定IP，默认0.0.0.0", "example": "0.0.0.0" }, { "name": "Protocol", "type": "string", "required": false, "description": "协议，默认tcp，支持tcp/udp/sctp", "example": "tcp" } ] }, { "name": "Volumes", "type": "array", "required": false, "description": "容器加载本地卷列表", "example": "[{\"ContainerPath\":\"/data/nginx\",\"HostPath\":\"/data/nginx\"}]", "item_type": "object", "children": [ { "name": "ContainerPath", "type": "string", "required": true, "description": "容器路径", "example": "/data/container" }, { "name": "HostPath", "type": "string", "required": false, "description": "主机路径", "example": "/data/host" } ] }, { "name": "Command", "type": "string", "required": false, "description": "运行的命令", "example": "ls -l" }, { "name": "RestartPolicy", "type": "string", "required": false, "description": "容器重启策略。 - no -默认策略，在容器退出时不重启容器 - on-failure -在容器非正常退出时（退出状态非0），才会重启容器 - on-failure:3 -在容器非正常退出时重启容器，最多重启3次 - always -在容器退出时总是重启容器", "example": "always" } ] }, { "name": "AutoVoucher", "type": "boolean", "required": false, "description": "是否自动使用代金券。默认不使用。", "example": "false" }, { "name": "FirewallTemplateId", "type": "string", "required": false, "description": "防火墙模板ID。若不指定该参数，则使用默认防火墙策略。", "example": "lhft-abcd1234" }, { "name": "Tags", "type": "array", "required": false, "description": "标签键和标签值。 如果指定多个标签，则会为指定资源同时创建并绑定该多个标签。 同一个资源上的同一个标签键只能对应一个标签值。如果您尝试添加已有标签键，则对应的标签值会更新为新值。 如果标签不存在会为您自动创建标签。 数组最多支持10个元素。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "Owner" }, { "name": "Value", "type": "string", "required": true, "description": "标签值", "example": "Green" } ] }, { "name": "InitCommand", "type": "object", "required": false, "description": "创建实例后自动执行的命令。", "example": "无", "children": [ { "name": "Content", "type": "string", "required": true, "description": "Base64编码后的命令内容，长度不可超过64KB。", "example": "bHM=" }, { "name": "Timeout", "type": "integer", "required": false, "description": "命令超时时间，默认60秒。取值范围[1, 86400]。", "example": "60" }, { "name": "WorkingDirectory", "type": "string", "required": false, "description": "命令执行路径，对于 SHELL 命令默认为 /root，对于 POWERSHELL 命令默认为 C:\\Program Files\\qcloud\\tat_agent\\workdir。", "example": "/root" }, { "name": "Username", "type": "string", "required": false, "description": "在 Lighthouse 实例中执行命令的用户名称。 默认情况下，在 Linux 实例中以 root 用户执行命令；在Windows 实例中以 System 用户执行命令。", "example": "root" } ] }, { "name": "DomainName", "type": "string", "required": false, "description": "主域名。 注意：域名指定后，仅支持购买一台实例（参数InstanceCount=1）。", "example": "tencent.com" }, { "name": "Subdomain", "type": "string", "required": false, "description": "子域名。 注意：域名指定后，仅支持购买一台实例（参数InstanceCount=1）。", "example": "blog" } ], "required": [ "BundleId", "BlueprintId", "InstanceChargePrepaid" ] }, { "name": "CreateKeyPair", "description": "本接口（CreateKeyPair）用于创建一个密钥对。", "status": "online", "parameters": [ { "name": "KeyName", "type": "string", "required": true, "description": "密钥对名称，可由数字，字母和下划线组成，长度不超过 25 个字符。", "example": "test_create_1" }, { "name": "Tags", "type": "array", "required": false, "description": "标签键和标签值。 如果指定多个标签，则会为指定资源同时创建并绑定该多个标签。 同一个资源上的同一个标签键只能对应一个标签值。如果您尝试添加已有标签键，则对应的标签值会更新为新值。 如果标签不存在会为您自动创建标签。 数组最多支持10个元素。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "Owner" }, { "name": "Value", "type": "string", "required": true, "description": "标签值", "example": "Green" } ] } ], "required": [ "KeyName" ] }, { "name": "CreateMcpServer", "description": "本接口（CreateMcpServer）用于创建MCP Server。 - 本接口为异步接口，请求发送成功后会返回一个 McpServerId，此时操作并未立即完成。实例操作结果可以通过调用 DescribeMcpServers 接口查询。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。", "example": "lhins-5h3s0lht" }, { "name": "Name", "type": "string", "required": true, "description": "MCP Server名称。最大长度：64", "example": "腾讯云 Lighthouse MCP Server" }, { "name": "Command", "type": "string", "required": true, "description": "Base64编码后的MCP Server启动命令。最大长度：2048", "example": "bnB4IC15IGxpZ2h0aG91c2UtbWNwLXNlcnZlcg==" }, { "name": "Description", "type": "string", "required": false, "description": "MCP Server备注。最大长度：2048", "example": "基于MCP协议的腾讯云Lighthouse MCP Server，借助大模型即可完成实例防火墙配置、实例检测、监控分析等常用功能。" }, { "name": "Envs", "type": "array", "required": false, "description": "MCP Server环境变量。最大长度：10", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "MCP Server的环境变量键。最大长度：128", "example": "MAP_API_KEY" }, { "name": "Value", "type": "string", "required": false, "description": "MCP Server的环境变量值。最大长度：1024。该字段可能存储密钥，出参时将固定返回“**********”，避免明文泄露。", "example": "api_key_xxx_xxx" } ] }, { "name": "TransportType", "type": "string", "required": false, "description": "传输类型。枚举值如下： STREAMABLE_HTTP：HTTP协议的流式传输方式。未传传输类型字段时，默认创建此类型的MCP Server SSE：Server-Sent Events，服务器发送事件", "example": "STREAMABLE_HTTP" } ], "required": [ "InstanceId", "Name", "Command" ] }, { "name": "DeleteBlueprints", "description": "本接口 (DeleteBlueprints) 用于删除镜像。可删除的镜像应满足如下条件： 1、删除镜像接口需要镜像状态为NORMAL（正常）、ISOLATED（已隔离）、CREATEFAILED（创建失败）、SYNCING_FAILED（目的地域同步失败），其他状态下的镜像不支持删除操作。镜像状态，可通过[DescribeBlueprints](https://cloud.tencent.com/document/product/1207/47689)接口返回值中的BlueprintState获取。 2、仅支持删除自定义镜像。", "status": "online", "parameters": [ { "name": "BlueprintIds", "type": "array", "required": true, "description": "镜像ID列表。镜像ID，可通过[DescribeBlueprints](https://cloud.tencent.com/document/product/1207/47689)接口返回值中的BlueprintId获取。", "example": "[\"lhbp-aaaabbbb\"]", "item_type": "string" } ], "required": [ "BlueprintIds" ] }, { "name": "DeleteDiskBackups", "description": "本接口（DeleteDiskBackups）用于删除云硬盘备份点。 云硬盘备份点必须处于 NORMAL 状态，云硬盘备份点状态可以通过 [DescribeDiskBackups](https://cloud.tencent.com/document/api/1207/84379)接口查询，见输出参数中 DiskBackupState 字段解释。", "status": "online", "parameters": [ { "name": "DiskBackupIds", "type": "array", "required": true, "description": "云硬盘备份点ID列表，可通过 [DescribeDiskBackups](https://cloud.tencent.com/document/api/1207/84379)接口查询。列表长度最大值为100。", "example": "[\"lhbak-ounanbtt\"]", "item_type": "string" } ], "required": [ "DiskBackupIds" ] }, { "name": "DeleteFirewallRules", "description": "本接口（DeleteFirewallRules）用于删除实例的防火墙规则。 * FirewallVersion 用于指定要操作的防火墙的版本。传入 FirewallVersion 版本号若不等于当前防火墙的最新版本，将返回失败；若不传 FirewallVersion 则直接删除指定的规则。FirewallVersion可通过[DescribeFirewallRules](https://cloud.tencent.com/document/api/1207/48252)接口返回值中的FirewallVersion获取。 在 FirewallRules 参数中： * Protocol 字段支持输入 TCP\ufffd...", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。可通过 [DescribeInstances](https://cloud.tencent.com/document/api/1207/47573) 接口返回值中的 InstanceId 获取。", "example": "lhins-aglzynfg" }, { "name": "FirewallRules", "type": "array", "required": true, "description": "防火墙规则列表。", "example": "无", "item_type": "object", "children": [ { "name": "Protocol", "type": "string", "required": true, "description": "协议，取值：TCP，UDP，ICMP，ALL，ICMPv6。 - 使用ICMP协议时，只支持CidrBlock，不支持使用Port、Ipv6CidrBlock参数； - 使用ICMPv6协议时，只支持Ipv6CidrBlock，不支持使用Port、Ipv6CidrBlock参数；", "example": "TCP" }, { "name": "Port", "type": "string", "required": false, "description": "端口，取值：ALL，单独的端口，逗号分隔的离散端口，减号分隔的端口范围。注意：单独的端口与离散端口不能同时存在。", "example": "80" }, { "name": "CidrBlock", "type": "string", "required": false, "description": "IPv4网段或 IPv4地址(互斥)。 示例值：0.0.0.0/0。 和Ipv6CidrBlock互斥，两者都不指定时，如果Protocol不是ICMPv6，则取默认值0.0.0.0/0。", "example": "0.0.0.0/0" }, { "name": "Ipv6CidrBlock", "type": "string", "required": false, "description": "IPv6网段或IPv6地址(互斥)。 示例值：::/0。 和CidrBlock互斥，两者都不指定时，如果Protocol是ICMPv6，则取默认值::/0。", "example": "::/0" }, { "name": "Action", "type": "string", "required": false, "description": "取值：ACCEPT（允许），DROP（拒绝）。默认为 ACCEPT。", "example": "ACCEPT" }, { "name": "FirewallRuleDescription", "type": "string", "required": false, "description": "防火墙规则描述。", "example": "firewallrule description" } ] }, { "name": "FirewallVersion", "type": "integer", "required": false, "description": "防火墙当前版本。用户每次更新防火墙规则时版本会自动加1，防止规则已过期，不填不考虑冲突。", "example": "1" } ], "required": [ "InstanceId", "FirewallRules" ] }, { "name": "DeleteFirewallTemplate", "description": "本接口 (DeleteFirewallTemplate) 用于删除防火墙模板。", "status": "online", "parameters": [ { "name": "TemplateId", "type": "string", "required": true, "description": "防火墙模板ID。可通过[DescribeFirewallTemplates](https://cloud.tencent.com/document/product/1207/96874)接口返回值字段TemplateSet获取。", "example": "lhft-xxxxxxxx" } ], "required": [ "TemplateId" ] }, { "name": "DeleteFirewallTemplateRules", "description": "本接口 (DeleteFirewallTemplateRules) 用于删除防火墙模板规则。", "status": "online", "parameters": [ { "name": "TemplateId", "type": "string", "required": true, "description": "防火墙模板ID。可通过[DescribeFirewallTemplates](https://cloud.tencent.com/document/product/1207/96874)接口返回值字段TemplateSet获取。", "example": "lhft-xxxxxxxx" }, { "name": "TemplateRuleIds", "type": "array", "required": true, "description": "防火墙模板规则ID列表。可通过[DescribeFirewallTemplateRules](https://cloud.tencent.com/document/product/1207/96875)接口返回值字段TemplateRuleSet获取。", "example": "[\"lhftr-baaj68clja\"]", "item_type": "string" } ], "required": [ "TemplateId", "TemplateRuleIds" ] }, { "name": "DeleteKeyPairs", "description": "本接口（DeleteKeyPairs）用于删除密钥对。 - 不能删除已被实例或镜像引用的密钥对，删除之前需要确保没有被任何实例和镜像引用。", "status": "online", "parameters": [ { "name": "KeyIds", "type": "array", "required": true, "description": "密钥对 ID 列表，每次请求批量密钥对的上限为 10。可通过[DescribeKeyPairs](https://cloud.tencent.com/document/api/1207/55540)接口返回值中的KeyId获取。", "example": "[\"lhkp-1234abcd\"]", "item_type": "string" } ], "required": [ "KeyIds" ] }, { "name": "DeleteSnapshots", "description": "本接口（DeleteSnapshots）用于删除快照。 快照必须处于 NORMAL 状态，快照状态可以通过 DescribeSnapshots 接口查询，见输出参数中 SnapshotState 字段解释。", "status": "online", "parameters": [ { "name": "SnapshotIds", "type": "array", "required": true, "description": "要删除的快照 ID 列表，每次请求批量快照的上限为10个，可通过 DescribeSnapshots查询。", "example": "[\"lhsnap-nv6aqcv6\"]", "item_type": "string" } ], "required": [ "SnapshotIds" ] }, { "name": "DescribeAllScenes", "description": "本接口(DescribeAllScenes)用于查询全地域使用场景列表。", "status": "online", "parameters": [ { "name": "SceneIds", "type": "array", "required": false, "description": "使用场景ID列表。可通过[DescribeAllScenes](https://cloud.tencent.com/document/product/1207/83513)接口返回值中的SceneId获取。", "example": "[\"lhsc-3bzsddow\"]", "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": "DescribeBlueprintInstances", "description": "本接口（DescribeBlueprintInstances）用于查询镜像实例信息。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "实例 ID 列表。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。 当前最多支持1个。", "example": "[\"lhins-f4s49nap\"]", "item_type": "string" } ], "required": [ "InstanceIds" ] }, { "name": "DescribeBlueprints", "description": "本接口（DescribeBlueprints）用于查询镜像信息。该接口返回的镜像类型有：自定义镜像、共享镜像、公共镜像。", "status": "online", "parameters": [ { "name": "BlueprintIds", "type": "array", "required": false, "description": "镜像 ID 列表。可通过[DescribeBlueprints](https://cloud.tencent.com/document/product/1207/47689)接口返回值字段BlueprintSet获取。列表长度最大值为100。", "example": "[\"lhbp-aaaabbbb\"]", "item_type": "string" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为 0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/product/1207/47578)中的相关小节。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，最大值为 100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/product/1207/47578)中的相关小节。", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤器列表。 blueprint-id按照【镜像 ID】进行过滤。 类型：String 必选：否 镜像 ID ，可通过[DescribeBlueprints](https://cloud.tencent.com/document/product/1207/47689)接口返回值字段BlueprintSet获取。 blueprint-type按照【镜像类型】进行过滤。 取值：APP_OS（应用镜像 ）；PURE_OS（系统镜像）；DOCKER（Docker容器镜像）；PRIVATE（自定义镜像）；SHARED（共享镜像）。 类型：String 必选：否 platform-type按照【\ufffd...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "bundle-id" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "['bundle_ntp_small2_100']", "item_type": "string" } ] } ], "required": [] }, { "name": "DescribeBundleDiscount", "description": "本接口（DescribeBundleDiscount）用于查询套餐折扣信息。", "status": "online", "parameters": [ { "name": "BundleId", "type": "string", "required": true, "description": "套餐 ID。可通过[DescribeBundles](https://cloud.tencent.com/document/product/1207/47575)接口返回值中的BundleId获取。", "example": "bundle_bw_small1_1" } ], "required": [ "BundleId" ] }, { "name": "DescribeBundles", "description": "本接口（DescribeBundles）用于查询套餐信息。", "status": "online", "parameters": [ { "name": "BundleIds", "type": "array", "required": false, "description": "套餐 ID 列表。每次请求批量套餐的上限为 100。可通过[DescribeBundles](https://cloud.tencent.com/document/product/1207/47575)接口返回值中的BundleId获取。", "example": "[\"bundle_ntp_small1_500”]", "item_type": "string" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为 0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/product/1207/47578)中的相关小节。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，最大值为 100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/product/1207/47578)中的相关小节。", "example": "20" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤器列表。 bundle-id按照【套餐 ID】进行过滤。 类型：String 必选：否 support-platform-type按照【系统类型】进行过滤。 取值： LINUX_UNIX(Linux/Unix系统) ;WINDOWS(Windows 系统) 类型：String 必选：否 bundle-type按照 【套餐类型进行过滤】。 取值：GENERAL_BUNDLE (通用型套餐); STORAGE_BUNDLE(存储型套餐);ENTERPRISE_BUNDLE( 企业型套餐);EXCLUSIVE_BUNDLE(专属型套餐);BEFAST_BUNDLE(蜂驰型套餐);STARTER_BUNDLE(入门型...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "bundle-id" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "['bundle_ntp_small2_100']", "item_type": "string" } ] }, { "name": "Zones", "type": "array", "required": false, "description": "可用区列表。默认为全部可用区。 可用区可通过接口 [DescribeZones](https://cloud.tencent.com/document/product/1207/57513) 查询", "example": "[\"ap-guangzhou-1\",\"ap-guangzhou-2\"]", "item_type": "string" } ], "required": [] }, { "name": "DescribeCcnAttachedInstances", "description": "本接口 (DescribeCcnAttachedInstances) 用于查询云联网关联的实例信息。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeDiskBackups", "description": "本接口（DescribeDiskBackups）用于查询云硬盘备份点的详细信息。", "status": "online", "parameters": [ { "name": "DiskBackupIds", "type": "array", "required": false, "description": "查询的云硬盘备份点ID列表。可通过[DescribeDiskBackups](https://cloud.tencent.com/document/product/1207/84379)接口返回值字段DiskBackupSet获取。列表长度最大值为100。参数不支持同时指定 DiskBackupIds 和 Filters。", "example": "[\"lhbak-nuen5foj\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤器列表。 disk-backup-id按照【云硬盘备份点 ID】进行过滤。 类型：String 必选：否 disk-id按照【云硬盘 ID】进行过滤。 类型：String 必选：否 disk-backup-state按照【云硬盘备份点状态】进行过滤。 类型：String 必选：否 取值：参考数据结构 [DiskBackup](https://cloud.tencent.com/document/product/1207/47576#DiskBackup) 下的DiskBackupState取值。 disk-usage按照【云硬盘类型】进行过滤。 类型：String 必选\ufffd\ufffd...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "bundle-id" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "['bundle_ntp_small2_100']", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为 0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/product/1207/47578)中的相关小节。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，最大值为 100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/product/1207/47578)中的相关小节。", "example": "1" } ], "required": [] }, { "name": "DescribeDiskBackupsDeniedActions", "description": "本接口（DescribeDiskBackupsDeniedActions）用于查询一个或多个云硬盘备份点的操作限制列表信息。", "status": "online", "parameters": [ { "name": "DiskBackupIds", "type": "array", "required": true, "description": "云硬盘备份点 ID 列表, 可通过DescribeDiskBackups接口查询。列表长度最大值为100。", "example": "[\"lhbak-nuen5foj\"] ", "item_type": "string" } ], "required": [ "DiskBackupIds" ] }, { "name": "DescribeDiskConfigs", "description": "本接口（DescribeDiskConfigs）用于查询云硬盘配置。", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤器列表。 zone按照【可用区】进行过滤。 类型：String 必选：否", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "bundle-id" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "['bundle_ntp_small2_100']", "item_type": "string" } ] } ], "required": [] }, { "name": "DescribeDiskDiscount", "description": "本接口(DescribeDiskDiscount)用于查询云硬盘折扣信息。", "status": "online", "parameters": [ { "name": "DiskType", "type": "string", "required": true, "description": "云硬盘类型, 取值范围: CLOUD_PREMIUM: 高性能云硬盘，CLOUD_SSD: SSD云硬盘", "example": "CLOUD_PREMIUM" }, { "name": "DiskSize", "type": "integer", "required": true, "description": "云硬盘大小, 单位: GB。", "example": "50" }, { "name": "DiskBackupQuota", "type": "integer", "required": false, "description": "指定云硬盘备份点配额，不传时默认为不带备份点配额。目前只支持不带或设置[0 - 500]个云硬盘备份点配额。", "example": "1" } ], "required": [ "DiskType", "DiskSize" ] }, { "name": "DescribeDisks", "description": "本接口（DescribeDisks）用于查询云硬盘信息。", "status": "online", "parameters": [ { "name": "DiskIds", "type": "array", "required": false, "description": "云硬盘ID列表。可通过[DescribeDisks](https://cloud.tencent.com/document/product/1207/66093)接口返回值字段KeyPairSet获取。列表长度最大值为100。", "example": "[\"lhdisk-p1zflrif\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤器列表。 disk-id 按照【云硬盘 ID】进行过滤。 类型：String 必选：否 instance-id 按照【实例ID】进行过滤。 类型：String 必选：否 disk-name 按照【云硬盘名称】进行过滤。 类型：String 必选：否 zone 按照【可用区】进行过滤。 类型：String 必选：否 disk-usage 按照【云硬盘类型】进行过滤。 类型：String 必选：否 取值：SYSTEM_DISK（系统盘）或 DATA_DISK（数据盘） disk-state 按照【云硬\ufffd...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "bundle-id" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "['bundle_ntp_small2_100']", "item_type": "string" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "100" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "OrderField", "type": "string", "required": false, "description": "云硬盘列表排序的依据字段。取值范围：\"CREATED_TIME\"：依据云硬盘的创建时间排序。 \"EXPIRED_TIME\"：依据云硬盘的到期时间排序。\"DISK_SIZE\"：依据云硬盘的大小排序。默认按云硬盘创建时间排序。", "example": "CREATED_TIME" }, { "name": "Order", "type": "string", "required": false, "description": "输出云硬盘列表的排列顺序。取值范围：\"ASC\"：升序排列。 \"DESC\"：降序排列。默认按降序排列。", "example": "ASC" } ], "required": [] }, { "name": "DescribeDisksDeniedActions", "description": "本接口（DescribeDisksDeniedActions）用于查询一个或多个云硬盘的操作限制列表信息。", "status": "online", "parameters": [ { "name": "DiskIds", "type": "array", "required": true, "description": "云硬盘ID列表。每次批量请求云硬盘的上限为 100。可通过[DescribeDisks](https://cloud.tencent.com/document/product/1207/66093)接口返回值中的DiskId获取。", "example": "[\"lhdisk-eobj8huv\"]", "item_type": "string" } ], "required": [ "DiskIds" ] }, { "name": "DescribeDisksReturnable", "description": "本接口（DescribeDisksReturnable）用于查询云硬盘是否可退还。", "status": "online", "parameters": [ { "name": "DiskIds", "type": "array", "required": false, "description": "云硬盘ID列表。每次批量请求云硬盘的上限为 10。可通过[DescribeDisks](https://cloud.tencent.com/document/product/1207/66093)接口返回值中的DiskId获取。", "example": "[\"lhdisk-eobj8huv\"]", "item_type": "string" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" } ], "required": [] }, { "name": "DescribeDockerActivities", "description": "查询实例内的Docker活动列表。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/product/1207/47573)接口返回值中的InstanceId获取。", "example": "lhins-nwycpjl3" }, { "name": "ActivityIds", "type": "array", "required": false, "description": "Docker活动ID列表。可通过[DescribeDockerActivities](https://cloud.tencent.com/document/product/1207/95476)接口返回值中的ActivityId获取。", "example": "[\"lhda-nn82v77w\"]", "item_type": "string" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为 0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，最大值为 100。", "example": "20" }, { "name": "CreatedTimeBegin", "type": "integer", "required": false, "description": "活动创建时间的起始值，时间戳秒数。", "example": "1553056487" }, { "name": "CreatedTimeEnd", "type": "integer", "required": false, "description": "活动创建时间的结束值，时间戳秒数。", "example": "1553056687" } ], "required": [ "InstanceId" ] }, { "name": "DescribeDockerContainerConfiguration", "description": "查询实例内的Docker容器配置信息", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/product/1207/47573)接口返回值中的InstanceId获取。", "example": "lhins-nwycpjl3" }, { "name": "ContainerId", "type": "string", "required": true, "description": "容器ID。可通过[DescribeDockerContainers](https://cloud.tencent.com/document/product/1207/95473)接口返回值中的ContainerId获取。", "example": "809e9d4014f08811779c07639ec13a53ee70ba166201611298611c883e553415" } ], "required": [ "InstanceId", "ContainerId" ] }, { "name": "DescribeDockerContainerDetail", "description": "查询实例内的Docker容器详情", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/product/1207/47573)接口返回值中的InstanceId获取。", "example": "lhins-nwycpjl3" }, { "name": "ContainerId", "type": "string", "required": true, "description": "容器ID。可通过[DescribeDockerContainers](https://cloud.tencent.com/document/product/1207/95473)接口返回值中的ContainerId获取。", "example": "809e9d4014f08811779c07639ec13a53ee70ba166201611298611c883e553415" } ], "required": [ "InstanceId", "ContainerId" ] }, { "name": "DescribeDockerContainers", "description": "查询实例内的容器列表。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/product/1207/47573)接口返回值中的InstanceId获取。", "example": "lhins-nwycpjl3" }, { "name": "ContainerIds", "type": "array", "required": false, "description": "容器ID列表。可通过[DescribeDockerContainers](https://cloud.tencent.com/document/product/1207/95473)接口返回值中的ContainerId获取。参数不支持同时指定 ContainerIds 和 Filters。", "example": "[\"edbc15ffac7074bf28cbc6071f422f90029154aefd9bf0392f33b247a3577a57\"]", "item_type": "string" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，最大值为 100。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为 0。", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤器列表。 container-id按照【容器ID】进行过滤。 类型：String 必选：否 container-name按照【容器名称】进行过滤。 类型：String 必选：否 每次请求的 Filters 的上限为 10，Filter.Values 的上限为 5。参数不支持同时指定 ContainerIds 和 Filters。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "bundle-id" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "['bundle_ntp_small2_100']", "item_type": "string" } ] } ], "required": [ "InstanceId" ] }, { "name": "DescribeFirewallRules", "description": "本接口（DescribeFirewallRules）用于查询实例的防火墙规则。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。可通过 [DescribeInstances](https://cloud.tencent.com/document/api/1207/47573) 接口返回值中的 InstanceId 获取。", "example": "lhins-aglzynfg" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为 0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/product/1207/47578)中的相关小节。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，最大值为 100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/product/1207/47578)中的相关小节。", "example": "20" } ], "required": [ "InstanceId" ] }, { "name": "DescribeFirewallRulesTemplate", "description": "本接口（DescribeFirewallRulesTemplate）用于查询防火墙规则模板。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeFirewallTemplateApplyRecords", "description": "本接口 (DescribeFirewallTemplateApplyRecords) 用于查询防火墙模板应用记录列表。", "status": "online", "parameters": [ { "name": "TemplateId", "type": "string", "required": true, "description": "防火墙模板ID。可通过[DescribeFirewallTemplates](https://cloud.tencent.com/document/product/1207/96874)接口返回值字段TemplateSet获取。", "example": "lhft-a5fh1i90" }, { "name": "TaskIds", "type": "array", "required": false, "description": "应用防火墙模板任务ID列表。可通过[ApplyFirewallTemplate](https://cloud.tencent.com/document/product/1207/96883)接口返回值TaskId字段获取。", "example": "lgtk-xalnmlko", "item_type": "string" } ], "required": [ "TemplateId" ] }, { "name": "DescribeFirewallTemplateQuota", "description": "本接口 (DescribeFirewallTemplateQuota) 用于查询防火墙模板配额。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeFirewallTemplateRuleQuota", "description": "本接口 (DescribeFirewallTemplateRuleQuota) 用于查询防火墙模板规则配额。", "status": "online", "parameters": [ { "name": "TemplateId", "type": "string", "required": true, "description": "防火墙模板ID。可通过[DescribeFirewallTemplates](https://cloud.tencent.com/document/product/1207/96874)接口返回值字段TemplateSet获取。", "example": "lhft-ow2dn19x" } ], "required": [ "TemplateId" ] }, { "name": "DescribeFirewallTemplateRules", "description": "本接口 (DescribeFirewallTemplateRules) 用于查询防火墙模板规则列表。", "status": "online", "parameters": [ { "name": "TemplateId", "type": "string", "required": true, "description": "防火墙模板ID列表。可通过[DescribeFirewallTemplates](https://cloud.tencent.com/document/product/1207/96874)接口返回值字段TemplateSet获取。列表长度最大值为100。", "example": "lhft-ow2dn19x" }, { "name": "TemplateRuleIds", "type": "array", "required": false, "description": "防火墙模板规则ID列表。可通过[DescribeFirewallTemplateRules](https://cloud.tencent.com/document/product/1207/96875)接口返回值字段TemplateRuleSet获取。列表长度最大值为100。", "example": "[\"lhftr-gexf7cmvpq\"]", "item_type": "string" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为 0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，最大值为 100。", "example": "10" } ], "required": [ "TemplateId" ] }, { "name": "DescribeFirewallTemplates", "description": "本接口 (DescribeFirewallTemplates) 用于查询防火墙模板列表。", "status": "online", "parameters": [ { "name": "TemplateIds", "type": "array", "required": false, "description": "防火墙模板ID列表。可通过[DescribeFirewallTemplates](https://cloud.tencent.com/document/product/1207/96874)接口返回值字段TemplateSet获取。列表长度最大值为100。", "example": "[\"lhft-6brh0ciy\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤器列表。 template-id按照【防火墙模板所属的ID】进行过滤。 类型：String 必选：否 template-name按照【防火墙模板所属的名称】进行过滤。 类型：String 必选：否 template-type按照【防火墙模板的类型】进行过滤。 类型：String 必选：否 取值: \"PRIVATE\"(个人模板) 每次请求的 Filters 的上限为 10，Filter.Values 的上限为 100。参数不支持同时指定 TemplateIds 和 Filters。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "bundle-id" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "['bundle_ntp_small2_100']", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为 0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，最大值为 100。", "example": "10" } ], "required": [] }, { "name": "DescribeGeneralResourceQuotas", "description": "本接口（DescribeGeneralResourceQuotas）用于查询通用资源配额信息。", "status": "online", "parameters": [ { "name": "ResourceNames", "type": "array", "required": true, "description": "资源名列表，可取值: - GENERAL_BUNDLE_INSTANCE 通用型套餐实例 - STORAGE_BUNDLE_INSTANCE 存储型套餐实例 - ENTERPRISE_BUNDLE_INSTANCE 企业型套餐实例 - EXCLUSIVE_BUNDLE_INSTANCE 专属型套餐实例 - BEFAST_BUNDLE_INSTANCE 蜂驰型套餐实例 - STARTER_BUNDLE_INSTANCE 入门型套餐实例 - HK_EXCLUSIVE_BUNDLE_INSTANCE 中国香港专属型套餐实例 - CAREFREE_BUNDLE_INSTANCE 无忧型套餐实例 - EXCLUSIVE_BUNDLE_02_INSTANCE 境外专属Ⅱ型 - NEWCOMER_BUND...", "example": "[\"GENERAL_BUNDLE_INSTANCE\"]", "item_type": "string" } ], "required": [ "ResourceNames" ] }, { "name": "DescribeImagesToShare", "description": "本接口 (DescribeImagesToShare) 用于查询CVM的自定义镜像列表共享到轻量应用服务器。", "status": "online", "parameters": [ { "name": "ImageIds", "type": "array", "required": false, "description": "CVM镜像 ID 列表。可通过[DescribeImages](https://cloud.tencent.com/document/api/213/15715)接口返回值中的ImageId获取。", "example": "[\"img-xksdu822\"]", "item_type": "string" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为 0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/product/1207/47578)中的相关小节。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，最大值为 100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/product/1207/47578)中的相关小节。", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤器列表。 image-id按照【CVM镜像ID】进行过滤。 类型：String 必选：否 image-name按照【CVM镜像名称】进行过滤。 类型：String 必选：否 image-type按照【CVM镜像类型】进行过滤。 类型：String 必选：否 取值范围： PRIVATE_IMAGE: 私有镜像 (本账户创建的镜像) PUBLIC_IMAGE: 公共镜像 (腾讯云官方镜像) SHARED_IMAGE: 共享镜像(其他账户共享给本账户的镜像) 。 每次请求的 Filters 的上限为 10，Filte...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "bundle-id" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "['bundle_ntp_small2_100']", "item_type": "string" } ] } ], "required": [] }, { "name": "DescribeInstanceVncUrl", "description": "本接口 ( DescribeInstanceVncUrl ) 用于查询实例管理终端地址，获取的地址可用于实例的 VNC 登录。 * 仅处于 `RUNNING`，`RESCUE_MODE` 状态的机器，且当前机器无变更中操作，才可使用此功能。 * 管理终端地址的有效期为 15 秒，调用接口成功后如果 15 秒内不使用该链接进行访问，管理终端地址自动失效，您需要重新查询。 * 管理终端地址一旦被访问，将自动失效，您需要重新查询。 * 如...", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。", "example": "lhins-ruy9d2tw" } ], "required": [ "InstanceId" ] }, { "name": "DescribeInstances", "description": "本接口（DescribeInstances）用于查询一个或多个实例的详细信息。 * 可以根据实例 ID、实例名称或者实例的内网 IP 查询实例的详细信息。 * 过滤信息详细请见过滤器 [Filters](https://cloud.tencent.com/document/product/1207/47576#Filter) 。 * 如果参数为空，返回当前用户一定数量（Limit 所指定的数量，默认为 20）的实例。 * 支持查询实例的最新操作（LatestOperation）以及最新操作状态（LatestOperationS...", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": false, "description": "实例 ID 列表。每次请求批量实例的上限为 100。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。", "example": "[\"lhins-4r4pvtbg\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤器列表。 instance-name按照【实例名称】进行过滤。 类型：String 必选：否 private-ip-address按照【实例主网卡的内网 IP】进行过滤。 类型：String 必选：否 public-ip-address按照【实例主网卡的公网 IP】进行过滤。 类型：String 必选：否 zone按照【可用区】进行过滤。 类型：String 必选：否 instance-state按照【实例状态】进行过滤。 类型：String 必选：否 tag-key按照【标签键】进行过滤。...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "bundle-id" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "['bundle_ntp_small2_100']", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为 0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/product/1207/47578)中的相关小节。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，最大值为 100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/product/1207/47578)中的相关小节。", "example": "1" }, { "name": "OrderField", "type": "string", "required": false, "description": "指定排序字段 。取值范围： \"EXPIRED_TIME\"：依据实例的到期时间排序。 不传入此字段时, 优先返回实例状态为“待回收”的实例, 其余实例以“创建时间”倒序返回。", "example": "EXPIRED_TIME" }, { "name": "Order", "type": "string", "required": false, "description": "输出实例列表的排列顺序。取值范围： \"ASC\"：升序排列。 \"DESC\"：降序排列。 默认按升序排序。当传入该字段时，必须指定OrderField。", "example": "DESC" } ], "required": [] }, { "name": "DescribeInstancesDeniedActions", "description": "本接口（DescribeInstancesDeniedActions）用于查询一个或多个实例的操作限制列表信息。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "实例 ID 列表。每次请求批量实例的上限为 100。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。", "example": "[\"lhins-ruy9d2tw\"]", "item_type": "string" } ], "required": [ "InstanceIds" ] }, { "name": "DescribeInstancesDiskNum", "description": "本接口(DescribeInstancesDiskNum)用于查询实例挂载云硬盘数量。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "实例ID列表。每次请求批量实例的上限为 100。 可通过 DescribeInstances 接口返回值中的 InstanceId 获取。", "example": "[\"lhins-anxwfvxh\"]", "item_type": "string" } ], "required": [ "InstanceIds" ] }, { "name": "DescribeInstancesReturnable", "description": "本接口（DescribeInstancesReturnable）用于查询实例是否可退还。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": false, "description": "实例 ID 列表。每次请求批量实例的上限为 100。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。", "example": "[\"lhins-ruy9d2tw\",\"lhins-xusdke45\"]", "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": "DescribeInstancesTrafficPackages", "description": "本接口（DescribeInstancesTrafficPackages）用于查询一个或多个实例的流量包详情。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": false, "description": "实例 ID 列表。每次请求批量实例的上限为 100。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。", "example": "[\"lhins-7h98ep3z\"]", "item_type": "string" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为 0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，最大值为 100。", "example": "2" } ], "required": [] }, { "name": "DescribeKeyPairs", "description": "本接口 (DescribeKeyPairs) 用于查询用户密钥对信息。", "status": "online", "parameters": [ { "name": "KeyIds", "type": "array", "required": false, "description": "密钥对 ID 列表。可通过[DescribeKeyPairs](https://cloud.tencent.com/document/product/1207/55540)接口返回值字段KeyPairSet获取。列表长度最大值为100。", "example": "[\"lhkp-omd12oc1\"]", "item_type": "string" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为 0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，最大值为 100。", "example": "20" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤器列表。 key-id按照【密钥对ID】进行过滤。 类型：String 必选：否 key-name按照【密钥对名称】进行过滤（支持模糊匹配）。 类型：String 必选：否 tag-key 按照【标签键】进行过滤。 类型：String 必选：否 tag-value 按照【标签值】进行过滤。 类型：String 必选：否 tag:tag-key 按照【标签键值对】进行过滤。 tag-key使用具体的标签键进行替换。 每次请求的 Filters 的上限为 10，Filter.Va...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "bundle-id" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "['bundle_ntp_small2_100']", "item_type": "string" } ] } ], "required": [] }, { "name": "DescribeMcpServerTemplates", "description": "本接口（DescribeMcpServerTemplates）用于查询MCP Server模板列表。", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤器列表。 name-description按照MCP Server模板名称或描述进行过滤（支持模糊匹配）。 类型：String 必选：否 每次请求的 Filters 的上限为 10，Filter.Values 的上限为 5。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "bundle-id" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "['bundle_ntp_small2_100']", "item_type": "string" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，最大值为 100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/product/1207/47578)中的相关小节。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为 0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/product/1207/47578)中的相关小节。", "example": "0" } ], "required": [] }, { "name": "DescribeMcpServers", "description": "本接口（DescribeMcpServers）用于查询MCP Server列表。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。", "example": "lhins-5h3s0lht" }, { "name": "McpServerIds", "type": "array", "required": false, "description": "MCP Server ID列表。列表为空时此条件不生效。最大长度：10", "example": "[\"lhms-p2dophob\"]", "item_type": "string" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，最大值为 100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/product/1207/47578)中的相关小节。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为 0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/product/1207/47578)中的相关小节。", "example": "0" } ], "required": [ "InstanceId" ] }, { "name": "DescribeModifyInstanceBundles", "description": "本接口（DescribeModifyInstanceBundles）用于查询实例可变更套餐列表。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 DescribeInstances 接口返回值中的 InstanceId 获取。", "example": "lhins-f4s3n38h" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤器列表。 bundle-id按照【套餐 ID】进行过滤。 类型：String 必选：否 可通过 DescribeBundles 接口返回值中的 BundleId 获取。 support-platform-type按照【系统类型】进行过滤。 取值： LINUX_UNIX（Linux/Unix系统）；WINDOWS（Windows 系统） 类型：String 必选：否 bundle-type按照 【套餐类型进行过滤】。 取值：GENERAL_BUNDLE (通用型套餐); STORAGE_BUNDLE(存储型套餐);ENTERPRISE_BUNDLE( 企业型套餐);EXCLUSIVE_BUN...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "bundle-id" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "['bundle_ntp_small2_100']", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为 0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/product/1207/47578)中的相关小节。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，最大值为 100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/product/1207/47578)中的相关小节。", "example": "0" } ], "required": [ "InstanceId" ] }, { "name": "DescribeRegions", "description": "本接口（DescribeRegions）用于查询地域信息。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeResetInstanceBlueprints", "description": "本接口（DescribeResetInstanceBlueprints）查询重置实例的镜像信息。对于游戏专区实例，该接口只会返回当前镜像，且不支持 Filters 参数。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。可通过 DescribeInstances 接口返回值中的 InstanceId 获取。", "example": "lhins-383nzmm1" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为 0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/product/1207/47578)中的相关小节。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，最大值为 100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/product/1207/47578)中的相关小节。", "example": "20" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤器列表。 blueprint-id按照【镜像 ID】进行过滤。 类型：String 必选：否 可通过 DescribeBlueprints 接口返回值中的 BlueprintId 获取。 blueprint-type按照【镜像类型】进行过滤。 取值： APP_OS（应用镜像 ）；PURE_OS（ 系统镜像）；PRIVATE（自定义镜像）;DOCKER（Docker容器镜像）；SHARED（共享镜像）。 类型：String 必选：否 platform-type按照【镜像平台类型】进行过滤。 取值： LINUX_UNIX（Linux/U...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "bundle-id" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "['bundle_ntp_small2_100']", "item_type": "string" } ] } ], "required": [ "InstanceId" ] }, { "name": "DescribeScenes", "description": "本接口(DescribeScenes)用于查看使用场景列表。", "status": "online", "parameters": [ { "name": "SceneIds", "type": "array", "required": false, "description": "使用场景ID列表。可通过[DescribeScenes](https://cloud.tencent.com/document/product/1207/83512)接口返回值中的SceneId获取。", "example": "[\"lhsc-123456\"]", "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": "DescribeSnapshots", "description": "本接口（DescribeSnapshots）用于查询快照的详细信息。", "status": "online", "parameters": [ { "name": "SnapshotIds", "type": "array", "required": false, "description": "要查询快照的 ID 列表。每次请求批量快照的上限为 100。 可通过 [DescribeSnapshots](https://cloud.tencent.com/document/product/1207/54388) 接口返回值中的 SnapshotId 获取。 参数不支持同时指定 SnapshotIds 和 Filters。", "example": "[\"lhsnap-nv6aqcv6\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤器列表。 snapshot-id按照【快照 ID】进行过滤。 类型：String 必选：否 可通过 DescribeSnapshots 接口返回值中的 SnapshotId 获取。 disk-id按照【磁盘 ID】进行过滤。 类型：String 必选：否 可通过 DescribeDisks 接口返回值中的 DiskId 获取。 snapshot-name按照【快照名称】进行过滤。 类型：String 必选：否 可通过 DescribeSnapshots 接口返回值中的 SnapshotName 获取。 instance-id按照【实例 ID 】进行过...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "bundle-id" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "['bundle_ntp_small2_100']", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为 0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，最大值为 100。", "example": "1" } ], "required": [] }, { "name": "DescribeSnapshotsDeniedActions", "description": "本接口（DescribeSnapshotsDeniedActions）用于查询一个或多个快照的操作限制列表信息。", "status": "online", "parameters": [ { "name": "SnapshotIds", "type": "array", "required": true, "description": "快照 ID 列表,每次请求批量快照的上限是100个。 可通过 DescribeSnapshots 查询。", "example": "[\"lhsnap-nv6aqcv6\"]", "item_type": "string" } ], "required": [ "SnapshotIds" ] }, { "name": "DescribeZones", "description": "查询地域下可用区", "status": "online", "parameters": [ { "name": "OrderField", "type": "string", "required": false, "description": "可用区列表排序的依据字段。取值范围： ZONE：依据可用区排序。 INSTANCE_DISPLAY_LABEL：依据可用区展示标签排序，可用区展示标签包括：HIDDEN（隐藏）、NORMAL（普通）、SELECTED（默认选中），默认采用的升序排列为：['HIDDEN', 'NORMAL', 'SELECTED']。 默认按可用区排序。", "example": "\"ZONE\"" }, { "name": "Order", "type": "string", "required": false, "description": "输出可用区列表的排列顺序。取值范围： ASC：升序排列。 DESC：降序排列。 默认按升序排列。", "example": "\"DESC\"" } ], "required": [] }, { "name": "DetachCcn", "description": "本接口 (DetachCcn) 用于解除与云联网的关联。", "status": "online", "parameters": [ { "name": "CcnId", "type": "string", "required": true, "description": "云联网实例ID。可通过[DescribeCcnAttachedInstances](https://cloud.tencent.com/document/product/1207/58797)接口返回值中的CcnId获取。", "example": "ccn-f49l6u0z" } ], "required": [ "CcnId" ] }, { "name": "DetachDisks", "description": "本接口（DetachDisks）用于卸载一个或多个云硬盘。该操作目前仅支持云硬盘类型为数据盘的云硬盘。 - 支持批量操作，卸载挂载在同一主机上的多块云硬盘。如果多块云硬盘中存在不允许卸载的云硬盘，则操作不执行，返回特定的错误码。 - 本接口为异步接口，当请求成功返回时，云硬盘并未立即卸载，可通过接口[DescribeDisks](https://cloud.tencent.com/document/product/362/16315)来查询对应...", "status": "online", "parameters": [ { "name": "DiskIds", "type": "array", "required": true, "description": "云硬盘ID列表。每次批量请求云硬盘的上限为 100。可通过[DescribeDisks](https://cloud.tencent.com/document/product/1207/66093)接口返回值中的DiskId获取。", "example": "[\"lhdisk-eobj8huv\"]", "item_type": "string" } ], "required": [ "DiskIds" ] }, { "name": "DisassociateInstancesKeyPairs", "description": "本接口（DisassociateInstancesKeyPairs）用于解除实例与指定密钥对的绑定关系。 * 只支持 [RUNNING, STOPPED] 状态的 LINUX_UNIX 操作系统的实例。处于 RUNNING 状态的实例会强制关机，然后解绑。 * 解绑密钥后，实例可以通过原来设置的密码登录。 * 如果原来没有设置密码，解绑后将无法使用 SSH 登录。可以调用 ResetInstancesPassword 接口来设置登录密码。 * 支持批量操作。每次请求批量实例的\ufffd\ufffd...", "status": "online", "parameters": [ { "name": "KeyIds", "type": "array", "required": true, "description": "密钥对 ID 列表，每次请求批量密钥对的上限为 100。可通过[DescribeKeyPairs](https://cloud.tencent.com/document/api/1207/55540)接口返回值中的KeyId获取。", "example": "[\"lhkp-f7rjie1q\"]", "item_type": "string" }, { "name": "InstanceIds", "type": "array", "required": true, "description": "实例 ID 列表。每次请求批量实例的上限为 100。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。", "example": "[\"lhins-ruy9d2tw\"]", "item_type": "string" } ], "required": [ "KeyIds", "InstanceIds" ] }, { "name": "ImportKeyPair", "description": "本接口（ImportKeyPair）用于导入用户指定密钥对。", "status": "online", "parameters": [ { "name": "KeyName", "type": "string", "required": true, "description": "密钥对名称，可由数字，字母和下划线组成，长度不超过 25 个字符。", "example": "test_import" }, { "name": "PublicKey", "type": "string", "required": true, "description": "密钥对的公钥内容， OpenSSH RSA 格式。", "example": "\u003c公钥内容\u003e" }, { "name": "Tags", "type": "array", "required": false, "description": "标签键和标签值。 如果指定多个标签，则会为指定资源同时创建并绑定该多个标签。 同一个资源上的同一个标签键只能对应一个标签值。如果您尝试添加已有标签键，则对应的标签值会更新为新值。 如果标签不存在会为您自动创建标签。 数组最多支持10个元素。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "Owner" }, { "name": "Value", "type": "string", "required": true, "description": "标签值", "example": "Green" } ] } ], "required": [ "KeyName", "PublicKey" ] }, { "name": "InquirePriceCreateBlueprint", "description": "本接口 (InquirePriceCreateBlueprint) 用于创建镜像询价。", "status": "online", "parameters": [ { "name": "BlueprintCount", "type": "integer", "required": false, "description": "自定义镜像的个数。默认值为1。", "example": "1" } ], "required": [] }, { "name": "InquirePriceCreateDisks", "description": "本接口（InquirePriceCreateDisks）用于新购云硬盘询价。", "status": "online", "parameters": [ { "name": "DiskSize", "type": "integer", "required": true, "description": "云硬盘大小, 单位: GB。", "example": "30" }, { "name": "DiskType", "type": "string", "required": true, "description": "云硬盘介质类型。取值: \"CLOUD_PREMIUM\"(高性能云盘), \"CLOUD_SSD\"(SSD云硬盘)。", "example": "CLOUD_SSD" }, { "name": "DiskChargePrepaid", "type": "object", "required": true, "description": "新购云硬盘包年包月相关参数设置。", "example": "无", "children": [ { "name": "Period", "type": "integer", "required": true, "description": "新购周期。 可选值：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60。", "example": "1" }, { "name": "RenewFlag", "type": "string", "required": false, "description": "自动续费标识。取值范围： - NOTIFY_AND_AUTO_RENEW：通知过期且自动续费。 - NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费，用户需要手动续费。 - DISABLE_NOTIFY_AND_MANUAL_RENEW：不自动续费，且不通知。 默认取值：NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，云硬盘到期后将按月自动续费。", "example": "NOTIFY_AND_AUTO_RENEW" }, { "name": "TimeUnit", "type": "string", "required": false, "description": "新购单位.。 可选值：m - 月。 默认值：m - 月。", "example": "m" } ] }, { "name": "DiskCount", "type": "integer", "required": false, "description": "云硬盘个数, 默认值: 1。", "example": "1" }, { "name": "DiskBackupQuota", "type": "integer", "required": false, "description": "指定云硬盘备份点配额，不传时默认为不带备份点配额。 取值范围：0 到 500", "example": "1" } ], "required": [ "DiskSize", "DiskType", "DiskChargePrepaid" ] }, { "name": "InquirePriceCreateInstances", "description": "本接口（InquiryPriceCreateInstances）用于创建实例询价。", "status": "online", "parameters": [ { "name": "BundleId", "type": "string", "required": true, "description": "实例的套餐 ID。可以通过调用[DescribeBundles](https://cloud.tencent.com/document/api/1207/47575)接口获取。", "example": "bundle_ntp_small1_500" }, { "name": "InstanceChargePrepaid", "type": "object", "required": true, "description": "预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。", "example": "无", "children": [ { "name": "Period", "type": "integer", "required": true, "description": "购买实例的时长，单位：月。 - 创建实例时，取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60。 - 续费实例时，取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36。", "example": "1" }, { "name": "RenewFlag", "type": "string", "required": false, "description": "自动续费标识。取值范围：NOTIFY_AND_AUTO_RENEW：通知过期且自动续费NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费，用户需要手动续费DISABLE_NOTIFY_AND_MANUAL_RENEW：不自动续费，且不通知默认取值：NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，实例到期后将按月自动续费。", "example": "NOTIFY_AND_AUTO_RENEW" } ] }, { "name": "InstanceCount", "type": "integer", "required": false, "description": "创建数量，默认为 1。", "example": "2" }, { "name": "BlueprintId", "type": "string", "required": false, "description": "应用镜像 ID，使用收费应用镜像时必填。可通过[DescribeBlueprints](https://cloud.tencent.com/document/product/1207/47689)接口返回值中的BlueprintId获取。", "example": "lhbp-aaaabbbb" } ], "required": [ "BundleId", "InstanceChargePrepaid" ] }, { "name": "InquirePriceRenewDisks", "description": "本接口（InquirePriceRenewDisks）用于续费云硬盘询价。", "status": "online", "parameters": [ { "name": "DiskIds", "type": "array", "required": true, "description": "云硬盘ID列表。每次批量请求云硬盘的上限为 1。可通过[DescribeDisks](https://cloud.tencent.com/document/product/1207/66093)接口返回值中的DiskId获取。", "example": "[\"lhdisk-eobj8huv\"]", "item_type": "string" }, { "name": "RenewDiskChargePrepaid", "type": "object", "required": true, "description": "续费云硬盘包年包月相关参数设置。", "example": "无", "children": [ { "name": "Period", "type": "integer", "required": false, "description": "续费周期。 单位：月。 取值范围: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36]", "example": "1" }, { "name": "RenewFlag", "type": "string", "required": false, "description": "自动续费标识。 取值范围： NOTIFY_AND_AUTO_RENEW：通知过期且自动续费 NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费，用户需要手动续费DISABLE_NOTIFY_AND_MANUAL_RENEW：不自动续费，且不通知 默认取值：NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，云硬盘到期后将按月自动续费。", "example": "NOTIFY_AND_AUTO_RENEW" }, { "name": "TimeUnit", "type": "string", "required": false, "description": "周期单位。取值范围：“m”(月)。默认值: \"m\"。", "example": "m" }, { "name": "CurInstanceDeadline", "type": "string", "required": false, "description": "当前实例到期时间。如“2018-01-01 00:00:00”。 指定该参数即可对齐云硬盘所挂载的实例到期时间。 该参数与Period必须指定其一，且不支持同时指定。 该参数值必须大于入参中云硬盘的过期时间。", "example": "2018-01-01 00:00:00" } ] } ], "required": [ "DiskIds", "RenewDiskChargePrepaid" ] }, { "name": "InquirePriceRenewInstances", "description": "本接口（InquirePriceRenewInstances）用于续费实例询价。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "待续费的实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573 )接口返回值中的InstanceId获取。每次请求批量实例的上限为50。", "example": "[\"lhins-11110001\"]", "item_type": "string" }, { "name": "InstanceChargePrepaid", "type": "object", "required": true, "description": "预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。", "example": "无", "children": [ { "name": "Period", "type": "integer", "required": true, "description": "购买实例的时长，单位：月。 - 创建实例时，取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60。 - 续费实例时，取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36。", "example": "1" }, { "name": "RenewFlag", "type": "string", "required": false, "description": "自动续费标识。取值范围：NOTIFY_AND_AUTO_RENEW：通知过期且自动续费NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费，用户需要手动续费DISABLE_NOTIFY_AND_MANUAL_RENEW：不自动续费，且不通知默认取值：NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，实例到期后将按月自动续费。", "example": "NOTIFY_AND_AUTO_RENEW" } ] }, { "name": "RenewDataDisk", "type": "boolean", "required": false, "description": "是否续费数据盘。默认值: false, 即不续费。", "example": "false" }, { "name": "AlignInstanceExpiredTime", "type": "boolean", "required": false, "description": "数据盘是否对齐实例到期时间。默认值: false, 即不对齐。", "example": "false" } ], "required": [ "InstanceIds", "InstanceChargePrepaid" ] }, { "name": "IsolateDisks", "description": "本接口(IsolateDisks)用于退还一个或多个轻量应用服务器云硬盘。 只有状态为 UNATTACHED 的数据盘才可以进行此操作。 接口调用成功后，云硬盘会进入SHUTDOWN 状态。 支持批量操作。每次请求批量资源的上限为 20。 本接口为异步接口，请求发送成功后会返回一个 RequestId，此时操作并未立即完成。云硬盘操作结果可以通过调用 [DescribeDisks](https://cloud.tencent.com/document/product/1207/66093) 接\ufffd...", "status": "online", "parameters": [ { "name": "DiskIds", "type": "array", "required": true, "description": "云硬盘ID列表。一个或多个待操作的云硬盘ID。可通过[DescribeDisks](https://cloud.tencent.com/document/product/1207/66093)接口返回值中的DiskId获取。每次请求退还数据盘数量总计上限为20。", "example": "[\"lhdisk-eobj8huv\"]\t", "item_type": "string" } ], "required": [ "DiskIds" ] }, { "name": "IsolateInstances", "description": "本接口(IsolateInstances)用于退还一个或多个轻量应用服务器实例。 * 只有状态为 RUNNING 或 STOPPED 的实例才可以进行此操作。 * 接口调用成功后，实例会进入SHUTDOWN 状态。 * 支持批量操作。每次请求批量资源（包括实例与数据盘）的上限为 20。 * 本接口为异步接口，请求发送成功后会返回一个 RequestId，此时操作并未立即完成。实例操作结果可以通过调用 DescribeInstances 接口查询，如...", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "实例ID列表。一个或多个待操作的实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。每次请求退还实例和数据盘数量总计上限为20。", "example": "[\"lhins-7ofik5q9\"]", "item_type": "string" }, { "name": "IsolateDataDisk", "type": "boolean", "required": false, "description": "是否退还挂载的数据盘。取值范围： TRUE：表示退还实例同时退还其挂载的数据盘。 FALSE：表示退还实例同时不再退还其挂载的数据盘。 默认取值：TRUE。", "example": "true" } ], "required": [ "InstanceIds" ] }, { "name": "ModifyBlueprintAttribute", "description": "本接口 (ModifyBlueprintAttribute) 用于修改镜像属性。", "status": "online", "parameters": [ { "name": "BlueprintId", "type": "string", "required": true, "description": "镜像 ID。可通过[DescribeBlueprints](https://cloud.tencent.com/document/product/1207/47689)接口返回值中的BlueprintId获取。", "example": "lhbp-aaaabbbb" }, { "name": "BlueprintName", "type": "string", "required": false, "description": "设置新的镜像名称。最大长度60。", "example": "test-blueprint" }, { "name": "Description", "type": "string", "required": false, "description": "设置新的镜像描述。最大长度60。", "example": "test-blueprint" } ], "required": [ "BlueprintId" ] }, { "name": "ModifyDiskBackupsAttribute", "description": "本接口 (ModifyDiskBackupsAttribute) 用于修改云硬盘备份点属性。", "status": "online", "parameters": [ { "name": "DiskBackupIds", "type": "array", "required": true, "description": "云硬盘备份点ID，可通过 [DescribeDiskBackups](https://cloud.tencent.com/document/api/1207/84379) 接口返回值中的 DiskBackupId 获取。列表长度最大值为100。", "example": "[\"lhbak-l1ghx97r\"]", "item_type": "string" }, { "name": "DiskBackupName", "type": "string", "required": false, "description": "云硬盘备份点名称，最大长度 90 。", "example": "disk-backup-name" } ], "required": [ "DiskBackupIds" ] }, { "name": "ModifyDisksAttribute", "description": "本接口(ModifyDisksAttribute)用于修改云硬盘属性。 云硬盘必须处于以下状态: ATTACHED（已挂载） UNATTACHED（待挂载）", "status": "online", "parameters": [ { "name": "DiskIds", "type": "array", "required": true, "description": "云硬盘ID列表。每次批量请求云硬盘的上限为 100。可通过[DescribeDisks](https://cloud.tencent.com/document/product/1207/66093)接口返回值中的DiskId获取。", "example": "[\"lhdisk-p1zflrif\"]", "item_type": "string" }, { "name": "DiskName", "type": "string", "required": true, "description": "云硬盘名称。", "example": "disk-name" } ], "required": [ "DiskIds", "DiskName" ] }, { "name": "ModifyDisksBackupQuota", "description": "本接口(ModifyDisksBackupQuota)用于调整云硬盘备份点配额。 该操作目前仅支持状态是ATTACHED（已挂载）或 UNATTACHED（待挂载）的云硬盘。 支持批量操作。每次批量请求云硬盘数量上限为15个。", "status": "online", "parameters": [ { "name": "DiskIds", "type": "array", "required": true, "description": "云硬盘ID列表，可通过[DescribeDisks](https://cloud.tencent.com/document/api/1207/66093)接口查询。列表最大长度为15。", "example": "[\"lhdisk-guzg7nsa\"]\t", "item_type": "string" }, { "name": "DiskBackupQuota", "type": "integer", "required": true, "description": "云硬盘备份点配额。取值范围: [0, 500]。调整后的配额必须大于等于已存在的备份点数量。", "example": "4" } ], "required": [ "DiskIds", "DiskBackupQuota" ] }, { "name": "ModifyDisksRenewFlag", "description": "本接口（ModifyDisksRenewFlag）用于修改云硬盘续费标识。 云硬盘需要处于以下状态： ATTACHED （已挂载） UNATTACHED （待挂载） ATTACHING （挂载中） DETACHING （卸载中）", "status": "online", "parameters": [ { "name": "DiskIds", "type": "array", "required": true, "description": "云硬盘ID列表。每次批量请求云硬盘的上限为 100。可通过[DescribeDisks](https://cloud.tencent.com/document/product/1207/66093)接口返回值中的DiskId获取。", "example": "[\"lhdisk-eobj8huv\"]", "item_type": "string" }, { "name": "RenewFlag", "type": "string", "required": true, "description": "自动续费标识。取值范围： - NOTIFY_AND_AUTO_RENEW：通知过期且自动续费 - NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费 - DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费 若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，实例到期后将按月自动续费。", "example": "NOTIFY_AND_AUTO_RENEW" } ], "required": [ "DiskIds", "RenewFlag" ] }, { "name": "ModifyDockerContainer", "description": "修改实例内的Docker容器，之后可以通过返回的ActivityId调用DescribeDockerActivities接口查询重建情况。 请注意：本接口会重新创建并运行实例内的Docker容器。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/product/1207/47573)接口返回值中的InstanceId获取。", "example": "lhins-nwycpjl3" }, { "name": "ContainerId", "type": "string", "required": true, "description": "容器ID。可通过[DescribeDockerContainers](https://cloud.tencent.com/document/product/1207/95473)接口返回值中的ContainerId获取。", "example": "809e9d4014f08811779c07639ec13a53ee70ba166201611298611c883e553415" }, { "name": "Envs", "type": "array", "required": false, "description": "环境变量列表", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "环境变量Key 注意：此字段可能返回 null，表示取不到有效值。", "example": "K1" }, { "name": "Value", "type": "string", "required": true, "description": "环境变量值 注意：此字段可能返回 null，表示取不到有效值。", "example": "V1" } ] }, { "name": "PublishPorts", "type": "array", "required": false, "description": "容器端口主机端口映射列表", "example": "无", "item_type": "object", "children": [ { "name": "HostPort", "type": "integer", "required": true, "description": "主机端口", "example": "80" }, { "name": "ContainerPort", "type": "integer", "required": true, "description": "容器端口", "example": "80" }, { "name": "Ip", "type": "string", "required": false, "description": "对外绑定IP，默认0.0.0.0", "example": "0.0.0.0" }, { "name": "Protocol", "type": "string", "required": false, "description": "协议，默认tcp，支持tcp/udp/sctp", "example": "tcp" } ] }, { "name": "Volumes", "type": "array", "required": false, "description": "容器加载本地卷列表", "example": "无", "item_type": "object", "children": [ { "name": "ContainerPath", "type": "string", "required": true, "description": "容器路径", "example": "/data/container" }, { "name": "HostPath", "type": "string", "required": false, "description": "主机路径", "example": "/data/host" } ] }, { "name": "Command", "type": "string", "required": false, "description": "运行的命令", "example": "ls -l" }, { "name": "RestartPolicy", "type": "string", "required": false, "description": "容器重启策略，对应docker \"--restart\"参数。 枚举值: no: 不自动重启。默认策略。 on-failure[:max-retries]: 当容器退出码非0时重启容器。使用max-retries限制重启次数，比如on-failure:10，限制最多重启10次。 always: 只要容器退出就重启。 unless-stopped: 始终重新启动容器，包括在守护进程启动时，除非容器在 Docker 守护进程停止之前进入停止状态。", "example": "always" } ], "required": [ "InstanceId", "ContainerId" ] }, { "name": "ModifyFirewallRuleDescription", "description": "本接口（ModifyFirewallRuleDescription）用于修改单条防火墙规则描述。 * FirewallVersion 用于指定要操作的防火墙的版本。传入 FirewallVersion 版本号若不等于当前防火墙的最新版本，将返回失败；若不传 FirewallVersion 则直接修改防火墙规则备注。FirewallVersion可通过[DescribeFirewallRules](https://cloud.tencent.com/document/api/1207/48252)接口返回值中的FirewallVersion获取。 用FirewallRule参数来指定要修改的防\ufffd...", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。可通过 [DescribeInstances](https://cloud.tencent.com/document/api/1207/47573) 接口返回值中的 InstanceId 获取。", "example": "lhins-12345678" }, { "name": "FirewallRule", "type": "object", "required": true, "description": "防火墙规则。", "example": "无", "children": [ { "name": "Protocol", "type": "string", "required": true, "description": "协议，取值：TCP，UDP，ICMP，ALL，ICMPv6。 - 使用ICMP协议时，只支持CidrBlock，不支持使用Port、Ipv6CidrBlock参数； - 使用ICMPv6协议时，只支持Ipv6CidrBlock，不支持使用Port、Ipv6CidrBlock参数；", "example": "TCP" }, { "name": "Port", "type": "string", "required": false, "description": "端口，取值：ALL，单独的端口，逗号分隔的离散端口，减号分隔的端口范围。注意：单独的端口与离散端口不能同时存在。", "example": "80" }, { "name": "CidrBlock", "type": "string", "required": false, "description": "IPv4网段或 IPv4地址(互斥)。 示例值：0.0.0.0/0。 和Ipv6CidrBlock互斥，两者都不指定时，如果Protocol不是ICMPv6，则取默认值0.0.0.0/0。", "example": "0.0.0.0/0" }, { "name": "Ipv6CidrBlock", "type": "string", "required": false, "description": "IPv6网段或IPv6地址(互斥)。 示例值：::/0。 和CidrBlock互斥，两者都不指定时，如果Protocol是ICMPv6，则取默认值::/0。", "example": "::/0" }, { "name": "Action", "type": "string", "required": false, "description": "取值：ACCEPT（允许），DROP（拒绝）。默认为 ACCEPT。", "example": "ACCEPT" }, { "name": "FirewallRuleDescription", "type": "string", "required": false, "description": "防火墙规则描述。", "example": "firewallrule description" } ] }, { "name": "FirewallVersion", "type": "integer", "required": false, "description": "防火墙当前版本。用户每次更新防火墙规则时版本会自动加1，防止规则已过期，不填不考虑冲突。", "example": "1" } ], "required": [ "InstanceId", "FirewallRule" ] }, { "name": "ModifyFirewallRules", "description": "本接口（ModifyFirewallRules）用于重置实例防火墙规则。 本接口先删除当前实例的所有防火墙规则，然后添加新的规则。 * FirewallVersion 用于指定要操作的防火墙的版本。传入 FirewallVersion 版本号若不等于当前防火墙的最新版本，将返回失败；若不传 FirewallVersion 则直接重置防火墙规则。可通过[DescribeFirewallRules](https://cloud.tencent.com/document/api/1207/48252)接口返回值中的FirewallVersion获取\ufffd\ufffd...", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。实例的ID可通过[DescribeInstances](https://cloud.tencent.com/document/product/1207/47573)接口返回值中的InstanceId获取。", "example": "lhins-12345678" }, { "name": "FirewallRules", "type": "array", "required": true, "description": "防火墙规则列表。列表长度最大值是100。", "example": "无", "item_type": "object", "children": [ { "name": "Protocol", "type": "string", "required": true, "description": "协议，取值：TCP，UDP，ICMP，ALL，ICMPv6。 - 使用ICMP协议时，只支持CidrBlock，不支持使用Port、Ipv6CidrBlock参数； - 使用ICMPv6协议时，只支持Ipv6CidrBlock，不支持使用Port、Ipv6CidrBlock参数；", "example": "TCP" }, { "name": "Port", "type": "string", "required": false, "description": "端口，取值：ALL，单独的端口，逗号分隔的离散端口，减号分隔的端口范围。注意：单独的端口与离散端口不能同时存在。", "example": "80" }, { "name": "CidrBlock", "type": "string", "required": false, "description": "IPv4网段或 IPv4地址(互斥)。 示例值：0.0.0.0/0。 和Ipv6CidrBlock互斥，两者都不指定时，如果Protocol不是ICMPv6，则取默认值0.0.0.0/0。", "example": "0.0.0.0/0" }, { "name": "Ipv6CidrBlock", "type": "string", "required": false, "description": "IPv6网段或IPv6地址(互斥)。 示例值：::/0。 和CidrBlock互斥，两者都不指定时，如果Protocol是ICMPv6，则取默认值::/0。", "example": "::/0" }, { "name": "Action", "type": "string", "required": false, "description": "取值：ACCEPT（允许），DROP（拒绝）。默认为 ACCEPT。", "example": "ACCEPT" }, { "name": "FirewallRuleDescription", "type": "string", "required": false, "description": "防火墙规则描述。", "example": "firewallrule description" } ] }, { "name": "FirewallVersion", "type": "integer", "required": false, "description": "防火墙当前版本。用户每次更新防火墙规则时版本会自动加1，防止规则已过期，不填不考虑冲突。", "example": "1" } ], "required": [ "InstanceId", "FirewallRules" ] }, { "name": "ModifyFirewallTemplate", "description": "本接口 (ModifyFirewallTemplate) 用于修改防火墙模板。", "status": "online", "parameters": [ { "name": "TemplateId", "type": "string", "required": true, "description": "防火墙模板ID。可通过[DescribeFirewallTemplates](https://cloud.tencent.com/document/product/1207/96874)接口返回值字段TemplateSet获取。", "example": "lhft-xxxxxxxx" }, { "name": "TemplateName", "type": "string", "required": false, "description": "防火墙模板名称。可通过[DescribeFirewallTemplates](https://cloud.tencent.com/document/product/1207/96874)接口返回值字段TemplateSet获取。", "example": "DemoTemplate" } ], "required": [ "TemplateId" ] }, { "name": "ModifyImageSharePermission", "description": "本接口 (ModifyImageSharePermission) 用于共享和取消共享CVM自定义镜像到轻量应用服务器服务。 CVM镜像共享到轻量应用服务器镜像需要满足如下条件： 1.已共享过的镜像不支持再次共享。 2.外部导入的镜像不支持共享。 3.整机镜像不支持共享。 4.镜像要支持Cloudinit才支持共享。 5.镜像的Platform和OsName要满足。 6.NORMAL状态的镜像才支持共享。", "status": "online", "parameters": [ { "name": "ImageId", "type": "string", "required": true, "description": "镜像 ID。可通过[DescribeImages](https://cloud.tencent.com/document/api/213/15715)接口返回值中的ImageId获取。", "example": "img-dw8adx" }, { "name": "Permission", "type": "string", "required": true, "description": "共享属性，包括 SHARE，CANCEL。其中SHARE代表共享，CANCEL代表取消共享。", "example": "SHARE" } ], "required": [ "ImageId", "Permission" ] }, { "name": "ModifyInstancesAttribute", "description": "本接口（ModifyInstancesAttribute）用于修改实例的属性。 * “实例名称”仅为方便用户自己管理之用。 * 支持批量操作。每次请求批量实例的上限为 100。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "实例 ID 列表。每次请求批量实例的上限为 100。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。", "example": "[\"lhins-ruy9d2tw\",\"lhins-rusdke45\"]", "item_type": "string" }, { "name": "InstanceName", "type": "string", "required": false, "description": "实例名称。可任意命名，但不得超过 60 个字符。", "example": "instance_for_api" } ], "required": [ "InstanceIds" ] }, { "name": "ModifyInstancesBundle", "description": "本接口(ModifyInstancesBundle)用于变更一个或多个轻量应用服务器实例套餐。 * 只有状态为 RUNNING，STOPPED的实例才可以进行此操作。 * 支持批量操作。每次请求批量实例的上限为 30。 * 本接口为异步接口，请求发送成功后会返回一个 RequestId，此时操作并未立即完成。实例操作结果可以通过调用 DescribeInstances 接口查询，如果实例的最新操作状态（LatestOperationState）为“SUCCESS”，则代\ufffd...", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "实例ID列表。一个或多个待操作的实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。每次请求批量实例的上限为15。", "example": "[“lhins-123456”]", "item_type": "string" }, { "name": "BundleId", "type": "string", "required": true, "description": "待变更的套餐Id。注意不可和当前要升配的实例套餐ID相同。可通过[DescribeBundles](https://cloud.tencent.com/document/api/1207/47575)接口返回值中的BundleId获取。", "example": "“bundle_ent_01”" }, { "name": "AutoVoucher", "type": "boolean", "required": false, "description": "是否自动抵扣代金券。取值范围： true：表示自动抵扣代金券 false：表示不自动抵扣代金券 默认取值：false。", "example": "false" } ], "required": [ "InstanceIds", "BundleId" ] }, { "name": "ModifyInstancesRenewFlag", "description": "本接口 (ModifyInstancesRenewFlag) 用于修改包年包月实例续费标识。 * 实例被标识为自动续费后，每次在实例到期时，会自动续费一个月。 * 支持批量操作。每次请求批量实例的上限为100。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "实例 ID 列表。每次请求批量实例的上限为 100。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。", "example": "[\"lhins-ruy9d2tw\"]", "item_type": "string" }, { "name": "RenewFlag", "type": "string", "required": true, "description": "自动续费标识。取值范围： - NOTIFY_AND_AUTO_RENEW：通知过期且自动续费 - NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费 - DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费 若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，实例到期后将按月自动续费。", "example": "NOTIFY_AND_AUTO_RENEW" } ], "required": [ "InstanceIds", "RenewFlag" ] }, { "name": "ModifyMcpServer", "description": "本接口（ModifyMcpServer）用于修改实例的MCP Server信息。 - 本接口为异步接口，API返回时修改操作并未立即完成。MCP Server的修改结果可以通过调用 DescribeMcpServers 接口查询。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。可以通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。", "example": "lhins-5h3s0lht" }, { "name": "McpServerId", "type": "string", "required": true, "description": "MCP Server ID。可以通[DescribeMcpServers](https://cloud.tencent.com/document/product/1207/122837)接口返回值中的McpServerId获取。", "example": "lhms-p2dophob" }, { "name": "Name", "type": "string", "required": false, "description": "MCP Server名称。最大长度：64", "example": "腾讯云 Lighthouse MCP Server" }, { "name": "Command", "type": "string", "required": false, "description": "Base64编码后的MCP Server启动命令。最大长度：2048", "example": "bnB4IC15IGxpZ2h0aG91c2UtbWNwLXNlcnZlcg==" }, { "name": "Description", "type": "string", "required": false, "description": "MCP Server备注。最大长度：2048", "example": "基于MCP协议的腾讯云Lighthouse MCP Server，借助大模型即可完成实例防火墙配置、实例检测、监控分析等常用功能。" }, { "name": "Envs", "type": "array", "required": false, "description": "MCP Server环境变量。最大长度：10。用于完整替换MCP Server的环境变量。当该字段为空时，系统将清除当前所有环境变量。若无需修改环境变量，请勿传递该字段。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "MCP Server的环境变量键。最大长度：128", "example": "MAP_API_KEY" }, { "name": "Value", "type": "string", "required": false, "description": "MCP Server的环境变量值。最大长度：1024。该字段可能存储密钥，出参时将固定返回“**********”，避免明文泄露。", "example": "api_key_xxx_xxx" } ] }, { "name": "TransportType", "type": "string", "required": false, "description": "传输类型。枚举值如下： STREAMABLE_HTTP：HTTP协议的流式传输方式 SSE：Server-Sent Events，服务器发送事件", "example": "STREAMABLE_HTTP" } ], "required": [ "InstanceId", "McpServerId" ] }, { "name": "ModifySnapshotAttribute", "description": "本接口（ModifySnapshotAttribute）用于修改指定快照的属性。 “快照名称”仅为方便用户自己管理之用。", "status": "online", "parameters": [ { "name": "SnapshotId", "type": "string", "required": true, "description": "快照 ID, 可通过 DescribeSnapshots 查询。", "example": "lhsnap-nv6aqcv6" }, { "name": "SnapshotName", "type": "string", "required": false, "description": "新的快照名称，最长为 60 个字符。", "example": "snap_20200903" } ], "required": [ "SnapshotId" ] }, { "name": "RebootInstances", "description": "本接口（RebootInstances）用于重启实例。 * 只有状态为 RUNNING 的实例才可以进行此操作。 * 接口调用成功时，实例会进入 REBOOTING 状态；重启实例成功时，实例会进入 RUNNING 状态。 * 支持批量操作，每次请求批量实例的上限为 100。 * 本接口为异步接口，请求发送成功后会返回一个 RequestId，此时操作并未立即完成。实例操作结果可以通过调用 DescribeInstances 接口查询，如果实例的最...", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "实例 ID 列表。每次请求批量实例的上限为 100。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。", "example": "[\"lhins-ruy9d2tw\",\"lhins-rusdke45\"]", "item_type": "string" }, { "name": "StopType", "type": "string", "required": false, "description": "关机类型。 取值范围： - SOFT：表示软关机 - HARD：表示硬关机 - SOFT_FIRST：表示优先软关机，失败再执行硬关机 默认取值：SOFT_FIRST。", "example": "\"SOFT_FIRST\"" } ], "required": [ "InstanceIds" ] }, { "name": "RemoveDockerContainers", "description": "删除实例内的Docker容器，之后可以通过返回的ActivityId调用[DescribeDockerActivities](https://cloud.tencent.com/document/product/1207/95476)接口查询删除情况。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/product/1207/47573)接口返回值中的InstanceId获取。", "example": "lhins-nwycpjl3" }, { "name": "ContainerIds", "type": "array", "required": true, "description": "容器ID列表。可通过[DescribeDockerContainers](https://cloud.tencent.com/document/product/1207/95473)接口返回值中的ContainerId获取。", "example": "[\"809e9d4014f08811779c07639ec13a53ee70ba166201611298611c883e5534\"]", "item_type": "string" } ], "required": [ "InstanceId", "ContainerIds" ] }, { "name": "RemoveMcpServers", "description": "本接口（RemoveMcpServers）用于删除MCP Server。 - 本接口为异步接口，API返回时操作并未立即完成。MCP Server的操作结果可以通过调用 DescribeMcpServers 接口查询。 - 本接口在操作多个MCP Server时，不会因为某一个失败而停止。您需要通过调用 DescribeMcpServers 接口查询最终操作结果，如无法查询到，代表删除成功。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。可以通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。", "example": "lhins-5h3s0lht" }, { "name": "McpServerIds", "type": "array", "required": true, "description": "MCP Server ID列表。可通过DescribeMcpServers接口返回值中的McpServerId获取。最大长度：10", "example": "[\"lhms-p2dophob\"]", "item_type": "string" } ], "required": [ "InstanceId", "McpServerIds" ] }, { "name": "RenameDockerContainer", "description": "重命名实例内的Docker容器，之后可以通过返回的ActivityId调用[DescribeDockerActivities](https://cloud.tencent.com/document/product/1207/95476)接口查询重命名情况。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/product/1207/47573)接口返回值中的InstanceId获取。", "example": "lhins-nwycpjl3" }, { "name": "ContainerId", "type": "string", "required": true, "description": "容器ID。可通过[DescribeDockerContainers](https://cloud.tencent.com/document/product/1207/95473)接口返回值中的ContainerId获取。", "example": "809e9d4014f08811779c07639ec13a53ee70ba166201611298611c883e553415" }, { "name": "ContainerName", "type": "string", "required": true, "description": "容器新的名称。", "example": "Container1" } ], "required": [ "InstanceId", "ContainerId", "ContainerName" ] }, { "name": "RenewDisks", "description": "本接口(RenewDisks)用于续费一个或多个轻量应用服务器云硬盘。 只有状态为 ATTACHED，UNATTACHED 或 SHUTDOWN 的数据盘才可以进行此操作。 支持批量操作。每次请求批量云硬盘的上限为 50。 本接口为异步接口，请求发送成功后会返回一个 RequestId，此时操作并未立即完成。云硬盘操作结果可以通过调用 [DescribeDisks](https://cloud.tencent.com/document/product/1207/66093) 接口查询，如果云硬盘的最新\ufffd...", "status": "online", "parameters": [ { "name": "DiskIds", "type": "array", "required": true, "description": "云硬盘ID列表。一个或多个待操作的云硬盘ID。可通过[DescribeDisks](https://cloud.tencent.com/document/product/1207/66093)接口返回值中的DiskId获取。每次请求续费数据盘数量总计上限为50。", "example": "[“lhdisk-afkvbns”]", "item_type": "string" }, { "name": "RenewDiskChargePrepaid", "type": "object", "required": true, "description": "续费云硬盘包年包月相关参数设置。", "example": "无", "children": [ { "name": "Period", "type": "integer", "required": false, "description": "续费周期。 单位：月。 取值范围: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36]", "example": "1" }, { "name": "RenewFlag", "type": "string", "required": false, "description": "自动续费标识。 取值范围： NOTIFY_AND_AUTO_RENEW：通知过期且自动续费 NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费，用户需要手动续费DISABLE_NOTIFY_AND_MANUAL_RENEW：不自动续费，且不通知 默认取值：NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，云硬盘到期后将按月自动续费。", "example": "NOTIFY_AND_AUTO_RENEW" }, { "name": "TimeUnit", "type": "string", "required": false, "description": "周期单位。取值范围：“m”(月)。默认值: \"m\"。", "example": "m" }, { "name": "CurInstanceDeadline", "type": "string", "required": false, "description": "当前实例到期时间。如“2018-01-01 00:00:00”。 指定该参数即可对齐云硬盘所挂载的实例到期时间。 该参数与Period必须指定其一，且不支持同时指定。 该参数值必须大于入参中云硬盘的过期时间。", "example": "2018-01-01 00:00:00" } ] }, { "name": "AutoVoucher", "type": "boolean", "required": false, "description": "是否自动使用代金券。默认不使用。", "example": "true" } ], "required": [ "DiskIds", "RenewDiskChargePrepaid" ] }, { "name": "RenewInstances", "description": "本接口(RenewInstances)用于续费一个或多个轻量应用服务器实例。 * 只有状态为 RUNNING，STOPPED 或 SHUTDOWN 的实例才可以进行此操作。 * 支持批量操作。每次请求批量实例的上限为 100。 * 本接口为异步接口，请求发送成功后会返回一个 RequestId，此时操作并未立即完成。实例操作结果可以通过调用 DescribeInstances 接口查询，如果实例的最新操作状态（LatestOperationState）为“SUCCESS”，则\ufffd\ufffd...", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "实例ID列表。一个或多个待操作的实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。每次请求批量实例的上限为100。", "example": "[\"lhins-7ofik5q9\"]", "item_type": "string" }, { "name": "InstanceChargePrepaid", "type": "object", "required": true, "description": "预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。", "example": "无", "children": [ { "name": "Period", "type": "integer", "required": true, "description": "购买实例的时长，单位：月。 - 创建实例时，取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60。 - 续费实例时，取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36。", "example": "1" }, { "name": "RenewFlag", "type": "string", "required": false, "description": "自动续费标识。取值范围：NOTIFY_AND_AUTO_RENEW：通知过期且自动续费NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费，用户需要手动续费DISABLE_NOTIFY_AND_MANUAL_RENEW：不自动续费，且不通知默认取值：NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，实例到期后将按月自动续费。", "example": "NOTIFY_AND_AUTO_RENEW" } ] }, { "name": "RenewDataDisk", "type": "boolean", "required": false, "description": "是否续费弹性数据盘。取值范围： TRUE：表示续费实例同时续费其挂载的数据盘 FALSE：表示续费实例同时不再续费其挂载的数据盘 默认取值：TRUE。", "example": "true" }, { "name": "AutoVoucher", "type": "boolean", "required": false, "description": "是否自动抵扣代金券。取值范围： TRUE：表示自动抵扣代金券 FALSE：表示不自动抵扣代金券 默认取值：FALSE。", "example": "false" } ], "required": [ "InstanceIds", "InstanceChargePrepaid" ] }, { "name": "ReplaceFirewallTemplateRule", "description": "本接口 (ReplaceFirewallTemplateRules) 用于替换防火墙模板规则。", "status": "online", "parameters": [ { "name": "TemplateId", "type": "string", "required": true, "description": "防火墙模板ID。可通过 [DescribeFirewallTemplates](https://cloud.tencent.com/document/product/1207/96874) 接口返回值中的 TemplateId 获取。", "example": "lhft-p1mlufa9" }, { "name": "TemplateRuleId", "type": "string", "required": true, "description": "防火墙模板规则ID。可通过 [DescribeFirewallTemplateRules](https://cloud.tencent.com/document/product/1207/96875) 接口返回值中的 TemplateRuleId 获取。", "example": "lhftr-cn8z2sf881" }, { "name": "TemplateRule", "type": "object", "required": true, "description": "替换后的防火墙模板规则。", "example": "无", "children": [ { "name": "Protocol", "type": "string", "required": true, "description": "协议，取值：TCP，UDP，ICMP，ALL，ICMPv6。 - 使用ICMP协议时，只支持CidrBlock，不支持使用Port、Ipv6CidrBlock参数； - 使用ICMPv6协议时，只支持Ipv6CidrBlock，不支持使用Port、Ipv6CidrBlock参数；", "example": "TCP" }, { "name": "Port", "type": "string", "required": false, "description": "端口，取值：ALL，单独的端口，逗号分隔的离散端口，减号分隔的端口范围。注意：单独的端口与离散端口不能同时存在。", "example": "80" }, { "name": "CidrBlock", "type": "string", "required": false, "description": "IPv4网段或 IPv4地址(互斥)。 示例值：0.0.0.0/0。 和Ipv6CidrBlock互斥，两者都不指定时，如果Protocol不是ICMPv6，则取默认值0.0.0.0/0。", "example": "0.0.0.0/0" }, { "name": "Ipv6CidrBlock", "type": "string", "required": false, "description": "IPv6网段或IPv6地址(互斥)。 示例值：::/0。 和CidrBlock互斥，两者都不指定时，如果Protocol是ICMPv6，则取默认值::/0。", "example": "::/0" }, { "name": "Action", "type": "string", "required": false, "description": "取值：ACCEPT（允许），DROP（拒绝）。默认为 ACCEPT。", "example": "ACCEPT" }, { "name": "FirewallRuleDescription", "type": "string", "required": false, "description": "防火墙规则描述。", "example": "firewallrule description" } ] } ], "required": [ "TemplateId", "TemplateRuleId", "TemplateRule" ] }, { "name": "RerunDockerContainer", "description": "重新创建并运行实例内的Docker容器，之后可以通过返回的ActivityId调用[DescribeDockerActivities](https://cloud.tencent.com/document/product/1207/95476)接口查询重建情况。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/product/1207/47573)接口返回值中的InstanceId获取。", "example": "lhins-nwycpjl3" }, { "name": "ContainerConfiguration", "type": "object", "required": true, "description": "重新创建的容器配置。", "example": "无", "children": [ { "name": "ContainerImage", "type": "string", "required": true, "description": "容器镜像地址", "example": "nginx" }, { "name": "ContainerName", "type": "string", "required": false, "description": "容器名称", "example": "Container1" }, { "name": "Envs", "type": "array", "required": false, "description": "环境变量列表", "example": "[{\"Key\":\"Key1\",\"Value\":\"Value1\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "环境变量Key 注意：此字段可能返回 null，表示取不到有效值。", "example": "K1" }, { "name": "Value", "type": "string", "required": true, "description": "环境变量值 注意：此字段可能返回 null，表示取不到有效值。", "example": "V1" } ] }, { "name": "PublishPorts", "type": "array", "required": false, "description": "容器端口主机端口映射列表", "example": "[{\"ContainerPort\":80,\"HostPort\":8081}]", "item_type": "object", "children": [ { "name": "HostPort", "type": "integer", "required": true, "description": "主机端口", "example": "80" }, { "name": "ContainerPort", "type": "integer", "required": true, "description": "容器端口", "example": "80" }, { "name": "Ip", "type": "string", "required": false, "description": "对外绑定IP，默认0.0.0.0", "example": "0.0.0.0" }, { "name": "Protocol", "type": "string", "required": false, "description": "协议，默认tcp，支持tcp/udp/sctp", "example": "tcp" } ] }, { "name": "Volumes", "type": "array", "required": false, "description": "容器加载本地卷列表", "example": "[{\"ContainerPath\":\"/data/nginx\",\"HostPath\":\"/data/nginx\"}]", "item_type": "object", "children": [ { "name": "ContainerPath", "type": "string", "required": true, "description": "容器路径", "example": "/data/container" }, { "name": "HostPath", "type": "string", "required": false, "description": "主机路径", "example": "/data/host" } ] }, { "name": "Command", "type": "string", "required": false, "description": "运行的命令", "example": "ls -l" }, { "name": "RestartPolicy", "type": "string", "required": false, "description": "容器重启策略。 - no -默认策略，在容器退出时不重启容器 - on-failure -在容器非正常退出时（退出状态非0），才会重启容器 - on-failure:3 -在容器非正常退出时重启容器，最多重启3次 - always -在容器退出时总是重启容器", "example": "always" } ] }, { "name": "ContainerId", "type": "string", "required": true, "description": "容器ID。可通过[DescribeDockerContainers](https://cloud.tencent.com/document/product/1207/95473)接口返回值中的ContainerId获取。", "example": "809e9d4014f08811779c07639ec13a53ee70ba1662016112986" } ], "required": [ "InstanceId", "ContainerConfiguration", "ContainerId" ] }, { "name": "ResetAttachCcn", "description": "本接口 (ResetAttachCcn) 用于关联云联网实例申请过期时，重新申请关联操作。", "status": "online", "parameters": [ { "name": "CcnId", "type": "string", "required": true, "description": "云联网实例ID。可通过[DescribeCcns](https://cloud.tencent.com/document/product/215/19199)接口返回值中的CcnId获取。", "example": "ccn-f49l6u0z" } ], "required": [ "CcnId" ] }, { "name": "ResetFirewallTemplateRules", "description": "本接口 (ResetFirewallTemplateRules) 用于重置防火墙模板下所有规则。", "status": "online", "parameters": [ { "name": "TemplateId", "type": "string", "required": true, "description": "防火墙模板ID。可通过 [DescribeFirewallTemplates](https://cloud.tencent.com/document/product/1207/96874) 接口返回值中的 TemplateId 获取。", "example": "lhft-abcd1234" }, { "name": "TemplateRules", "type": "array", "required": true, "description": "重置后的防火墙模板规则列表。每次请求批量防火墙规则的上限为 100。", "example": "无", "item_type": "object", "children": [ { "name": "Protocol", "type": "string", "required": true, "description": "协议，取值：TCP，UDP，ICMP，ALL，ICMPv6。 - 使用ICMP协议时，只支持CidrBlock，不支持使用Port、Ipv6CidrBlock参数； - 使用ICMPv6协议时，只支持Ipv6CidrBlock，不支持使用Port、Ipv6CidrBlock参数；", "example": "TCP" }, { "name": "Port", "type": "string", "required": false, "description": "端口，取值：ALL，单独的端口，逗号分隔的离散端口，减号分隔的端口范围。注意：单独的端口与离散端口不能同时存在。", "example": "80" }, { "name": "CidrBlock", "type": "string", "required": false, "description": "IPv4网段或 IPv4地址(互斥)。 示例值：0.0.0.0/0。 和Ipv6CidrBlock互斥，两者都不指定时，如果Protocol不是ICMPv6，则取默认值0.0.0.0/0。", "example": "0.0.0.0/0" }, { "name": "Ipv6CidrBlock", "type": "string", "required": false, "description": "IPv6网段或IPv6地址(互斥)。 示例值：::/0。 和CidrBlock互斥，两者都不指定时，如果Protocol是ICMPv6，则取默认值::/0。", "example": "::/0" }, { "name": "Action", "type": "string", "required": false, "description": "取值：ACCEPT（允许），DROP（拒绝）。默认为 ACCEPT。", "example": "ACCEPT" }, { "name": "FirewallRuleDescription", "type": "string", "required": false, "description": "防火墙规则描述。", "example": "firewallrule description" } ] } ], "required": [ "TemplateId", "TemplateRules" ] }, { "name": "ResetInstance", "description": "本接口（ResetInstance）用于重装指定实例上的镜像。 * 仅`RUNNING`，`STOPPED`状态的机器，且当前机器无变更中的操作，才支持重装系统。 * 如果指定了 BlueprintId 参数，则使用指定的镜像重装，否则按照当前实例使用的镜像进行重装。 * 非中国大陆地域的实例不支持使用该接口实现LIUNX_UNIX和WINDOWS操作系统切换。 * 系统盘将会被格式化，并重置，请确保系统盘中无重要文件。 * 本接\ufffd...", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。", "example": "lhins-ruy9d2tw" }, { "name": "BlueprintId", "type": "string", "required": false, "description": "镜像 ID。可通过[DescribeBlueprints](https://cloud.tencent.com/document/product/1207/47689)接口返回值中的BlueprintId获取。", "example": "lhbp-5e8807lo" }, { "name": "Containers", "type": "array", "required": false, "description": "要创建的容器配置列表。 注意：仅重装的镜像类型为Docker时支持传入该参数。", "example": "无", "item_type": "object", "children": [ { "name": "ContainerImage", "type": "string", "required": true, "description": "容器镜像地址", "example": "nginx" }, { "name": "ContainerName", "type": "string", "required": false, "description": "容器名称", "example": "Container1" }, { "name": "Envs", "type": "array", "required": false, "description": "环境变量列表", "example": "[{\"Key\":\"Key1\",\"Value\":\"Value1\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "环境变量Key 注意：此字段可能返回 null，表示取不到有效值。", "example": "K1" }, { "name": "Value", "type": "string", "required": true, "description": "环境变量值 注意：此字段可能返回 null，表示取不到有效值。", "example": "V1" } ] }, { "name": "PublishPorts", "type": "array", "required": false, "description": "容器端口主机端口映射列表", "example": "[{\"ContainerPort\":80,\"HostPort\":8081}]", "item_type": "object", "children": [ { "name": "HostPort", "type": "integer", "required": true, "description": "主机端口", "example": "80" }, { "name": "ContainerPort", "type": "integer", "required": true, "description": "容器端口", "example": "80" }, { "name": "Ip", "type": "string", "required": false, "description": "对外绑定IP，默认0.0.0.0", "example": "0.0.0.0" }, { "name": "Protocol", "type": "string", "required": false, "description": "协议，默认tcp，支持tcp/udp/sctp", "example": "tcp" } ] }, { "name": "Volumes", "type": "array", "required": false, "description": "容器加载本地卷列表", "example": "[{\"ContainerPath\":\"/data/nginx\",\"HostPath\":\"/data/nginx\"}]", "item_type": "object", "children": [ { "name": "ContainerPath", "type": "string", "required": true, "description": "容器路径", "example": "/data/container" }, { "name": "HostPath", "type": "string", "required": false, "description": "主机路径", "example": "/data/host" } ] }, { "name": "Command", "type": "string", "required": false, "description": "运行的命令", "example": "ls -l" }, { "name": "RestartPolicy", "type": "string", "required": false, "description": "容器重启策略。 - no -默认策略，在容器退出时不重启容器 - on-failure -在容器非正常退出时（退出状态非0），才会重启容器 - on-failure:3 -在容器非正常退出时重启容器，最多重启3次 - always -在容器退出时总是重启容器", "example": "always" } ] }, { "name": "LoginConfiguration", "type": "object", "required": false, "description": "实例登录信息配置。默认缺失情况下代表用户选择实例创建后设置登录密码或绑定密钥。", "example": "无", "children": [ { "name": "AutoGeneratePassword", "type": "string", "required": false, "description": "\"YES\"代表选择自动生成密码，这时不指定Password字段。 \"NO\"代表选择自定义密码，这时要指定Password字段。", "example": "NO" }, { "name": "Password", "type": "string", "required": false, "description": "实例登录密码。具体按照操作系统的复杂度要求。 `LINUX_UNIX` 实例密码必须 8-30 位，推荐使用 12 位以上密码，不能包含空格，不能以“/”开头，至少包含以下字符中的三种不同字符，字符种类： 小写字母：[a-z] 大写字母：[A-Z] 数字：0-9 特殊字符： ()\\`\\~!@#$%^\u0026\\*-+=\\_|{}[]:;' ,.?/ `WINDOWS` 实例密码必须 12-30 位，不能包含空格，不能以“/”开头且不包括用户名，至少包含以下字符中的...", "example": " HelloTgHd123_\u0026*" }, { "name": "KeyIds", "type": "array", "required": false, "description": "密钥ID列表，最多同时指定5个密钥。关联密钥后，就可以通过对应的私钥来访问实例。密钥与密码不能同时指定，同时WINDOWS操作系统不支持指定密钥。密钥ID列表可以通过[DescribeKeyPairs](https://cloud.tencent.com/document/product/1207/55540)接口获取。", "example": "[\"lhkp-7f7lh1fv\"]", "item_type": "string" } ] } ], "required": [ "InstanceId" ] }, { "name": "ResetInstancesPassword", "description": "本接口（ResetInstancesPassword）用于将实例操作系统的密码重置为用户指定的密码。 * 只修改管理员账号的密码。实例的操作系统不同，管理员账号也会不一样（Windows 为 Administrator，Ubuntu 为 ubuntu ，其它系统为 root）。 * 支持批量操作。将多个实例操作系统的密码重置为相同的密码。每次请求批量实例的上限为 100。 * 建议对运行中的实例先手动关机，然后再进行密码重置。如实例...", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "实例 ID 列表。每次请求批量实例的上限为 100。可通过 DescribeInstances 接口返回值中的 InstanceId 获取。", "example": "[\"lhins-ruy9d2tw\"]", "item_type": "string" }, { "name": "Password", "type": "string", "required": true, "description": "实例登录密码。不同操作系统类型密码复杂度限制不一样，具体如下： `LINUX_UNIX` 实例密码必须 8-30 位，推荐使用 12 位以上密码，不能以“/”开头，至少包含以下字符中的三种不同字符，字符种类： 小写字母：[a-z] 大写字母：[A-Z] 数字：0-9 特殊字符： ()\\`\\~!@#$%^\u0026\\*-+=\\_|{}[]:;' ,.?/ `WINDOWS` 实例密码必须 12-30 位，不能以“/”开头且不包括用户名，至少包含以下字符中的三种不同字...", "example": "a!LightHouse@123" }, { "name": "UserName", "type": "string", "required": false, "description": "待重置密码的实例操作系统用户名。不得超过 64 个字符。", "example": "root" } ], "required": [ "InstanceIds", "Password" ] }, { "name": "ResizeDisks", "description": "本接口(ResizeDisks)用于扩容云硬盘。该操作目前仅支持云硬盘类型为数据盘且状态处于ATTACHED（已挂载）或 UNATTACHED（待挂载）的云硬盘。", "status": "online", "parameters": [ { "name": "DiskIds", "type": "array", "required": true, "description": "云硬盘ID列表，可通过[DescribeDisks](https://cloud.tencent.com/document/api/1207/66093)接口查询。列表最大长度为15。", "example": "[\"lhdisk-guzg7nsa\"]\t", "item_type": "string" }, { "name": "DiskSize", "type": "integer", "required": true, "description": "扩容后的云硬盘大小。单位: GB。高性能云硬盘大小取值范围：[10, 4000] ,SSD云硬盘大小取值范围：[20, 4000]。扩容后的云硬盘大小必须大于当前云硬盘大小。", "example": "40" } ], "required": [ "DiskIds", "DiskSize" ] }, { "name": "RestartDockerContainers", "description": "重启实例内的Docker容器，之后可以通过返回的ActivityId调用[DescribeDockerActivities](https://cloud.tencent.com/document/product/1207/95476)接口查询重启情况。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/product/1207/47573)接口返回值中的InstanceId获取。", "example": "lhins-nwycpjl3" }, { "name": "ContainerIds", "type": "array", "required": true, "description": "容器ID列表。可通过[DescribeDockerContainers](https://cloud.tencent.com/document/product/1207/95473)接口返回值中的ContainerId获取。", "example": "[\"809e9d4014f08811779c07639ec13a53ee70ba166201611298611c883e5534\"]", "item_type": "string" } ], "required": [ "InstanceId", "ContainerIds" ] }, { "name": "RestartMcpServers", "description": "本接口（RestartMcpServers）用于重启实例中的MCP Server。 - 本接口为异步接口，API返回时操作并未立即完成。MCP Server的操作结果可以通过调用 DescribeMcpServers 接口查询。 - 本接口在操作多个MCP Server时，不会因为某一个失败而停止。您需要通过调用 DescribeMcpServers 接口查询最终操作结果。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。", "example": "lhins-5h3s0lht" }, { "name": "McpServerIds", "type": "array", "required": true, "description": "MCP Server ID列表。可通过DescribeMcpServers接口返回值中的McpServerId获取。最大长度：10", "example": "[\"lhms-p2dophob\"]", "item_type": "string" } ], "required": [ "InstanceId", "McpServerIds" ] }, { "name": "RunDockerContainers", "description": "创建并运行多个Docker容器，之后可以通过返回的ActivityIds调用DescribeDockerActivities接口查询创建情况。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/product/1207/47573)接口返回值中的InstanceId获取。", "example": "lhins-nwycpjl3" }, { "name": "Containers", "type": "array", "required": true, "description": "要创建的容器列表。", "example": "无", "item_type": "object", "children": [ { "name": "ContainerImage", "type": "string", "required": true, "description": "容器镜像地址", "example": "nginx" }, { "name": "ContainerName", "type": "string", "required": false, "description": "容器名称", "example": "Container1" }, { "name": "Envs", "type": "array", "required": false, "description": "环境变量列表", "example": "[{\"Key\":\"Key1\",\"Value\":\"Value1\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "环境变量Key 注意：此字段可能返回 null，表示取不到有效值。", "example": "K1" }, { "name": "Value", "type": "string", "required": true, "description": "环境变量值 注意：此字段可能返回 null，表示取不到有效值。", "example": "V1" } ] }, { "name": "PublishPorts", "type": "array", "required": false, "description": "容器端口主机端口映射列表", "example": "[{\"ContainerPort\":80,\"HostPort\":8081}]", "item_type": "object", "children": [ { "name": "HostPort", "type": "integer", "required": true, "description": "主机端口", "example": "80" }, { "name": "ContainerPort", "type": "integer", "required": true, "description": "容器端口", "example": "80" }, { "name": "Ip", "type": "string", "required": false, "description": "对外绑定IP，默认0.0.0.0", "example": "0.0.0.0" }, { "name": "Protocol", "type": "string", "required": false, "description": "协议，默认tcp，支持tcp/udp/sctp", "example": "tcp" } ] }, { "name": "Volumes", "type": "array", "required": false, "description": "容器加载本地卷列表", "example": "[{\"ContainerPath\":\"/data/nginx\",\"HostPath\":\"/data/nginx\"}]", "item_type": "object", "children": [ { "name": "ContainerPath", "type": "string", "required": true, "description": "容器路径", "example": "/data/container" }, { "name": "HostPath", "type": "string", "required": false, "description": "主机路径", "example": "/data/host" } ] }, { "name": "Command", "type": "string", "required": false, "description": "运行的命令", "example": "ls -l" }, { "name": "RestartPolicy", "type": "string", "required": false, "description": "容器重启策略。 - no -默认策略，在容器退出时不重启容器 - on-failure -在容器非正常退出时（退出状态非0），才会重启容器 - on-failure:3 -在容器非正常退出时重启容器，最多重启3次 - always -在容器退出时总是重启容器", "example": "always" } ] } ], "required": [ "InstanceId", "Containers" ] }, { "name": "ShareBlueprintAcrossAccounts", "description": "本接口（ShareBlueprintAcrossAccounts）用于跨账号共享镜像。 仅支持共享自定义镜像， 且用于共享的镜像状态必须为NORMAL。 共享的账号必须为主账号。", "status": "online", "parameters": [ { "name": "BlueprintId", "type": "string", "required": true, "description": "镜像ID, 可以通过[DescribeBlueprints](https://cloud.tencent.com/document/product/1207/47689)接口返回的BlueprintId获取。", "example": "lhbp-6jc6l8yb" }, { "name": "AccountIds", "type": "array", "required": true, "description": "接收共享镜像的[账号ID](https://cloud.tencent.com/document/product/213/4944#.E8.8E.B7.E5.8F.96.E4.B8.BB.E8.B4.A6.E5.8F.B7.E7.9A.84.E8.B4.A6.E5.8F.B7-id)列表。账号ID不同于QQ号，查询用户账号ID请查看账号信息中的账号ID栏。账号个数取值最大为10。", "example": "[\"700000164995\"]", "item_type": "string" } ], "required": [ "BlueprintId", "AccountIds" ] }, { "name": "StartDockerContainers", "description": "启动实例内的Docker容器，之后可以通过返回的ActivityId调用[DescribeDockerActivities](https://cloud.tencent.com/document/product/1207/95476)接口查询启动情况。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/product/1207/47573)接口返回值中的InstanceId获取。", "example": "lhins-nwycpjl3" }, { "name": "ContainerIds", "type": "array", "required": true, "description": "容器ID列表。可通过[DescribeDockerContainers](https://cloud.tencent.com/document/product/1207/95473)接口返回值中的ContainerId获取。", "example": "[\"809e9d4014f08811779c07639ec13a53ee70ba166201611298611c883e5534\"]", "item_type": "string" } ], "required": [ "InstanceId", "ContainerIds" ] }, { "name": "StartInstances", "description": "本接口（StartInstances）用于启动一个或多个实例。 * 只有状态为 STOPPED 的实例才可以进行此操作。 * 接口调用成功时，实例会进入 STARTING 状态；启动实例成功时，实例会进入 RUNNING 状态。 * 支持批量操作。每次请求批量实例的上限为 100。 * 本接口为异步接口，请求发送成功后会返回一个 RequestId，此时操作并未立即完成。实例操作结果可以通过调用 DescribeInstances 接口查询，如\ufffd\ufffd...", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "实例 ID 列表。每次请求批量实例的上限为 100。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。", "example": "[\"lhins-ruy9d2tw\",\"lhins-rusdke45\"]", "item_type": "string" } ], "required": [ "InstanceIds" ] }, { "name": "StartMcpServers", "description": "本接口（StartMcpServers）用于开启实例中的MCP Server。 - 本接口为异步接口，API返回时操作并未立即完成。MCP Server的操作结果可以通过调用 DescribeMcpServers 接口查询。 - 本接口在操作多个MCP Server时，不会因为某一个失败而停止。您需要通过调用 DescribeMcpServers 接口查询最终操作结果。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。", "example": "lhins-5h3s0lht" }, { "name": "McpServerIds", "type": "array", "required": true, "description": "MCP Server ID列表。可通过DescribeMcpServers接口返回值中的McpServerId获取。最大长度：10", "example": "[\"lhms-p2dophob\"]", "item_type": "string" } ], "required": [ "InstanceId", "McpServerIds" ] }, { "name": "StopDockerContainers", "description": "停止实例内的Docker容器，之后可以通过返回的ActivityId调用[DescribeDockerActivities](https://cloud.tencent.com/document/product/1207/95476)接口查询停止情况。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/product/1207/47573)接口返回值中的InstanceId获取。", "example": "lhins-nwycpjl3" }, { "name": "ContainerIds", "type": "array", "required": true, "description": "容器ID列表。可通过[DescribeDockerContainers](https://cloud.tencent.com/document/product/1207/95473)接口返回值中的ContainerId获取。", "example": "[\"809e9d4014f08811779c07639ec13a53ee70ba166201611298611c883e5534\"]", "item_type": "string" } ], "required": [ "InstanceId", "ContainerIds" ] }, { "name": "StopInstances", "description": "本接口（StopInstances）用于关闭一个或多个实例。 * 只有状态为 RUNNING 的实例才可以进行此操作。 * 接口调用成功时，实例会进入 STOPPING 状态；关闭实例成功时，实例会进入 STOPPED 状态。 * 支持批量操作。每次请求批量实例的上限为 100。 * 本接口为异步接口，请求发送成功后会返回一个 RequestId，此时操作并未立即完成。实例操作结果可以通过调用 DescribeInstances 接口查询，如果...", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "实例 ID 列表。每次请求批量实例的上限为 100。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。", "example": "[\"lhins-ruy9d2tw\",\"lhins-rusdke45\"]", "item_type": "string" }, { "name": "StopType", "type": "string", "required": false, "description": "关机类型。取值范围： SOFT：表示软关机 HARD：表示硬关机 SOFT_FIRST：表示优先软关机，失败再执行硬关机 默认取值：SOFT_FIRST", "example": "\"SOFT_FIRST\"" } ], "required": [ "InstanceIds" ] }, { "name": "StopMcpServers", "description": "本接口（StopMcpServers）用于关闭实例中的MCP Server。 - 本接口为异步接口，API返回时操作并未立即完成。MCP Server的操作结果可以通过调用 DescribeMcpServers 接口查询。 - 本接口在操作多个MCP Server时，不会因为某一个失败而停止。您需要通过调用 DescribeMcpServers 接口查询最终操作结果。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。", "example": "lhins-5h3s0lht" }, { "name": "McpServerIds", "type": "array", "required": true, "description": "MCP Server ID列表。可通过DescribeMcpServers接口返回值中的McpServerId获取。最大长度：10", "example": "[\"lhms-p2dophob\"]", "item_type": "string" } ], "required": [ "InstanceId", "McpServerIds" ] }, { "name": "SyncBlueprint", "description": "本接口 (SyncBlueprint) 用于将自定义镜像同步到其它地域。 * 支持向多个地域同步。最多10个地域。 * 不支持向源地域同步。 * 只支持NORMAL状态的镜像进行同步。 * 不支持中国大陆地域和非中国大陆地域之间同步。 * 可以通过[DescribeBlueprints](https://cloud.tencent.com/document/api/1207/47689)查询镜像状态，当镜像状态为NORMAL时表示源地域同步结束。", "status": "online", "parameters": [ { "name": "BlueprintId", "type": "string", "required": true, "description": "镜像ID。", "example": "lhbp-sdeji832" }, { "name": "DestinationRegions", "type": "array", "required": true, "description": "同步镜像的目的地域列表。", "example": "[\"ap-beijing\",\"ap-shanghai\"]", "item_type": "string" } ], "required": [ "BlueprintId", "DestinationRegions" ] }, { "name": "TerminateDisks", "description": "本接口（TerminateDisks）用于销毁一个或多个云硬盘。 云硬盘状态必须处于SHUTDOWN（已隔离）状态。", "status": "online", "parameters": [ { "name": "DiskIds", "type": "array", "required": true, "description": "云硬盘ID列表。可通过[DescribeDisks](https://cloud.tencent.com/document/product/1207/66093)接口返回值中的DiskId获取。 每次批量请求云硬盘的上限数量为100。", "example": "[\"lhdisk-p1zflrif\"]", "item_type": "string" } ], "required": [ "DiskIds" ] }, { "name": "TerminateInstances", "description": "本接口 (TerminateInstances) 用于销毁实例。 * 处于 SHUTDOWN 状态的实例，可通过本接口销毁，且不可恢复。 * 支持批量操作，每次请求批量实例的上限为100。 * 本接口为异步接口，请求发送成功后会返回一个 RequestId，此时操作并未立即完成。实例操作结果可以通过调用 DescribeInstances 接口查询，如果返回列表中不存在该实例，则代表操作成功。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "实例ID列表。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。", "example": "[\"lhins-ruy9d2tw\"]", "item_type": "string" } ], "required": [ "InstanceIds" ] } ] }