tccli 3.0.1407.1__py2.py3-none-any.whl → 3.1.6.1__py2.py3-none-any.whl

tccli/services/thpc/v20230321/api.json

@@ -161,6 +161,13 @@
       "output": "DetachNodesResponse",
       "status": "online"
     },
+    "ModifyClusterDeletionProtection": {
+      "document": "修改集群删除保护状态",
+      "input": "ModifyClusterDeletionProtectionRequest",
+      "name": "修改集群删除保护状态",
+      "output": "ModifyClusterDeletionProtectionResponse",
+      "status": "online"
+    },
     "ModifyInitNodeScripts": {
       "document": "本接口 (ModifyInitNodeScripts) 用于修改节点初始化脚本。",
       "input": "ModifyInitNodeScriptsRequest",
@@ -556,7 +563,7 @@
           "value_allowed_null": false
         },
         {
-          "disabled": false,
+          "disabled": true,
           "document": "表示所选训练框架，支持可选参数\n \n- PyTorch：表示提交PyTorch训练作业\n- Custom：表示用户自定义作业\n\n默认参数为：Custom",
           "example": "Custom",
           "member": "string",
@@ -565,6 +572,17 @@
           "required": false,
           "type": "string",
           "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "表示所选训练框架，支持可选参数\n \n- PyTorch：表示提交PyTorch训练作业\n- Custom：表示用户自定义作业\n\n默认参数为：Custom",
+          "example": "Custom",
+          "member": "string",
+          "name": "TaskType",
+          "output_required": false,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": false
         }
       ],
       "usage": "both"
@@ -616,6 +634,15 @@
           "name": "ResourceType",
           "required": false,
           "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "提供给实例使用的用户数据，需要以 base64 方式编码，支持的最大数据大小为 16KB。关于获取此参数的详细介绍，请参阅[Windows](https://cloud.tencent.com/document/product/213/17526)和[Linux](https://cloud.tencent.com/document/product/213/17525)启动时运行命令。",
+          "example": "IyEvYmluL2Jhc2gKZWNobyAiSGVsbG8gV29ybGQuIFRoZSB0aW1lIGlzIG5vdyAkKGRhdGUgLVIpISIgPiAgL3RtcC91c3JfZGF0YS50eHQ=",
+          "member": "string",
+          "name": "UserData",
+          "required": false,
+          "type": "string"
         }
       ],
       "type": "object"
@@ -900,7 +927,7 @@
         {
           "disabled": false,
           "document": "集群位置信息。",
-          "example": "{ \"Zone\": \"ap-guangzhou-6\" }\t",
+          "example": "无",
           "member": "Placement",
           "name": "Placement",
           "output_required": true,
@@ -910,7 +937,7 @@
         {
           "disabled": false,
           "document": "集群创建时间。",
-          "example": "2024-12-18T13:46:34Z\t",
+          "example": "2025-10-29T09:55:45Z",
           "member": "datetime_iso",
           "name": "CreateTime",
           "output_required": true,
@@ -950,7 +977,7 @@
         {
           "disabled": false,
           "document": "计算节点概览。",
-          "example": "[{\"NodeId\":\"ins-riredadfj6\"},{\"NodeId\":\"ins-mdafdsai\"},{\"NodeId\":\"ins-5icofadac\"},{\"NodeId\":\"ins-icfdadfy\"}]\t",
+          "example": "无",
           "member": "ComputeNodeOverview",
           "name": "ComputeNodeSet",
           "output_required": true,
@@ -970,7 +997,7 @@
         {
           "disabled": false,
           "document": "管控节点概览。",
-          "example": "[{\"NodeId\":\"node-rirfdafa\"}]\t",
+          "example": "无",
           "member": "ManagerNodeOverview",
           "name": "ManagerNodeSet",
           "output_required": true,
@@ -980,7 +1007,7 @@
         {
           "disabled": false,
           "document": "登录节点概览。",
-          "example": "[{\"NodeId\":\"ins-riredadfj6\"},{\"NodeId\":\"ins-mdafdsai\"},{\"NodeId\":\"ins-5icofadac\"},{\"NodeId\":\"ins-icfdadfy\"}]\t",
+          "example": "无",
           "member": "LoginNodeOverview",
           "name": "LoginNodeSet",
           "output_required": true,
@@ -1026,6 +1053,16 @@
           "output_required": false,
           "type": "string",
           "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "集群销毁保护开关状态，当前支持参数：\n\n- ON: 集群销毁保护打开\n- OFF: 集群销毁保护关闭",
+          "example": "OFF",
+          "member": "string",
+          "name": "DeletionProtection",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": false
         }
       ],
       "usage": "out"
@@ -1156,16 +1193,16 @@
         {
           "disabled": false,
           "document": "集群中实例所在的位置。",
-          "example": "{ \"Zone\": \"ap-guangzhou-6\" }\t",
+          "example": "无",
           "member": "Placement",
           "name": "Placement",
-          "required": true,
+          "required": false,
           "type": "object"
         },
         {
           "disabled": false,
           "document": "指定管理节点。",
-          "example": "{\"InstanceType\": \"S2.SMALL2\"}",
+          "example": "无",
           "member": "ManagerNode",
           "name": "ManagerNode",
           "required": false,
@@ -1183,7 +1220,7 @@
         {
           "disabled": false,
           "document": "指定计算节点。",
-          "example": "{\"InstanceType\": \"S2.SMALL2\"}",
+          "example": "无",
           "member": "ComputeNode",
           "name": "ComputeNode",
           "required": false,
@@ -1228,7 +1265,7 @@
         {
           "disabled": false,
           "document": "私有网络相关信息配置。",
-          "example": "{ \"VpcId\": \"vpc-rhfaxx31\", \"SubnetId\": \"subnet-x7vxgqe\" }",
+          "example": "无",
           "member": "VirtualPrivateCloud",
           "name": "VirtualPrivateCloud",
           "required": false,
@@ -1237,7 +1274,7 @@
         {
           "disabled": false,
           "document": "集群登录设置。",
-          "example": "{ \"KeyIds\": [ \"skey-9tzxxb4j\" ] }",
+          "example": "无",
           "member": "LoginSettings",
           "name": "LoginSettings",
           "required": false,
@@ -1264,7 +1301,7 @@
         {
           "disabled": false,
           "document": "是否只预检此次请求。\ntrue：发送检查请求，不会创建实例。检查项包括是否填写了必需参数，请求格式，业务限制和云服务器库存。\n如果检查不通过，则返回对应错误码；\n如果检查通过，则返回RequestId.\nfalse（默认）：发送正常请求，通过检查后直接创建实例",
-          "example": "False",
+          "example": "false",
           "member": "bool",
           "name": "DryRun",
           "required": false,
@@ -1291,7 +1328,7 @@
         {
           "disabled": false,
           "document": "集群存储选项",
-          "example": "{\"CFSOptions\":[{\"LocalPath\":\"/mnt/\",\"RemotePath\":\"127.0.0.1@tcp0:/test/cfs/\",\"Protocol\":\"TURBO\",\"StorageType\":\"TP\"}]}\t",
+          "example": "无",
           "member": "StorageOption",
           "name": "StorageOption",
           "required": false,
@@ -1300,7 +1337,7 @@
         {
           "disabled": false,
           "document": "指定登录节点。",
-          "example": "{\"InstanceType\": \"S2.SMALL2\"}",
+          "example": "无",
           "member": "LoginNode",
           "name": "LoginNode",
           "required": false,
@@ -1318,7 +1355,7 @@
         {
           "disabled": false,
           "document": "创建集群时同时绑定的标签对说明。",
-          "example": "[{\"Key\": \"test\", \"Value\": \"test\"}]",
+          "example": "无",
           "member": "Tag",
           "name": "Tags",
           "required": false,
@@ -1336,7 +1373,7 @@
         {
           "disabled": false,
           "document": "节点初始化脚本信息列表。",
-          "example": "{\"ScriptPath\": \"cos://demo-xxxxxxxx.cos.ap-guangzhou.myqcloud.com/test/echo.sh\", \"Timeout\": \"30\"}",
+          "example": "无",
           "member": "NodeScript",
           "name": "InitNodeScripts",
           "required": false,
@@ -1489,7 +1526,7 @@
         },
         {
           "disabled": false,
-          "document": "工作空间登陆设置",
+          "document": "工作空间登录设置",
           "example": "{ \"KeyIds\": [ \"skey-9tzxxb4j\" ] }",
           "member": "LoginSettings",
           "name": "LoginSettings",
@@ -2123,12 +2160,52 @@
     },
     "DescribeJobsOverviewRequest": {
       "document": "DescribeJobsOverview请求参数结构体",
-      "members": [],
+      "members": [
+        {
+          "disabled": false,
+          "document": "集群ID",
+          "example": "hpc-xxx",
+          "member": "string",
+          "name": "ClusterId",
+          "required": true,
+          "type": "string"
+        }
+      ],
       "type": "object"
     },
     "DescribeJobsOverviewResponse": {
       "document": "DescribeJobsOverview返回参数结构体",
       "members": [
+        {
+          "disabled": false,
+          "document": "作业任务数量",
+          "example": "10",
+          "member": "uint64",
+          "name": "JobTotal",
+          "output_required": true,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "排队中的作业任务数量",
+          "example": "2",
+          "member": "uint64",
+          "name": "QueuingJobTotal",
+          "output_required": true,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "运行中的作业数量",
+          "example": "3",
+          "member": "uint64",
+          "name": "RunningJobTotal",
+          "output_required": true,
+          "type": "int",
+          "value_allowed_null": false
+        },
         {
           "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
           "member": "string",
@@ -2144,7 +2221,7 @@
         {
           "disabled": false,
           "document": "作业任务ID列表",
-          "example": "无",
+          "example": "[\"job-xxx\"]",
           "member": "string",
           "name": "JobIds",
           "required": false,
@@ -2814,9 +2891,8 @@
           "example": "[\"172.16.0.2:55533\",\"172.16.0.3:55533\",\"172.16.0.4:55533\"]",
           "member": "string",
           "name": "Masters",
-          "required": true,
-          "type": "list",
-          "value_allowed_null": true
+          "required": false,
+          "type": "list"
         },
         {
           "disabled": false,
@@ -2824,9 +2900,17 @@
           "example": "/goosefsx/x_c60_54oi5id3_proxy/",
           "member": "string",
           "name": "LocalPath",
-          "required": true,
-          "type": "string",
-          "value_allowed_null": true
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "GooseFSx文件系统ID 文件系统ID通过调用接口[DescribeFileSystems](https://cloud.tencent.com/document/api/1424/95789)获取。",
+          "example": "x-c60-fc9373xp",
+          "member": "string",
+          "name": "FileSystemId",
+          "required": false,
+          "type": "string"
         }
       ],
       "usage": "in"
@@ -3297,6 +3381,42 @@
       ],
       "usage": "out"
     },
+    "ModifyClusterDeletionProtectionRequest": {
+      "document": "ModifyClusterDeletionProtection请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "集群ID。",
+          "example": "hpc-cjaqo2i7",
+          "member": "string",
+          "name": "ClusterId",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "集群删除保护开关。 \n可选值：<li>OFF：关闭集群删除保护。</li><li>ON：打开集群删除保护。</li>",
+          "example": "OFF",
+          "member": "string",
+          "name": "DeletionProtection",
+          "required": true,
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "ModifyClusterDeletionProtectionResponse": {
+      "document": "ModifyClusterDeletionProtection返回参数结构体",
+      "members": [
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "ModifyInitNodeScriptsRequest": {
       "document": "ModifyInitNodeScripts请求参数结构体",
       "members": [
@@ -4624,12 +4744,50 @@
     },
     "SubmitJobRequest": {
       "document": "SubmitJob请求参数结构体",
-      "members": [],
+      "members": [
+        {
+          "disabled": false,
+          "document": "集群id",
+          "example": "hpc-cy4pnyp9",
+          "member": "string",
+          "name": "ClusterId",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "作业任务参数配置",
+          "example": "无",
+          "member": "Job",
+          "name": "Job",
+          "required": true,
+          "type": "object"
+        },
+        {
+          "disabled": false,
+          "document": "队列名称。不指定则为默认队列：\nSLURM默认队列为：compute。 \nSGE默认队列为：all.q。",
+          "example": "compute",
+          "member": "string",
+          "name": "QueueName",
+          "required": false,
+          "type": "string"
+        }
+      ],
       "type": "object"
     },
     "SubmitJobResponse": {
       "document": "SubmitJob返回参数结构体",
       "members": [
+        {
+          "disabled": false,
+          "document": "作业任务ID",
+          "example": "job-xxxx",
+          "member": "string",
+          "name": "JobId",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
         {
           "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
           "member": "string",

tccli/services/thpc/v20230321/examples.json

@@ -3,7 +3,7 @@
     "AddClusterStorageOption": [
       {
         "document": "集群添加CFS挂载选项。",
-        "input": "POST / HTTP/1.1\nHost: thpc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: AddClusterStorageOption\n<公共请求参数>\n\n{\n    \"ClusterId\": \"hpc-eq97tf4u\",\n    \"StorageOption\": {\n        \"CFSOptions\": [\n            {\n                \"LocalPath\": \"/data/\",\n                \"RemotePath\": \"172.30.3.90:/\",\n                \"Protocol\": \"NFS 4.0\",\n                \"StorageType\": \"SD\"\n            },\n            {\n                \"LocalPath\": \"/tmp/\",\n                \"RemotePath\": \"172.30.2.180@tcp0:/4fe1839b/cfs\",\n                \"Protocol\": \"TURBO\",\n                \"StorageType\": \"TB\"\n            }\n        ]\n    }\n}",
+        "input": "POST / HTTP/1.1\nHost: thpc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: AddClusterStorageOption\n<公共请求参数>\n\n{\n    \"ClusterId\": \"hpc-eq97tf4u\",\n    \"StorageOption\": {\n        \"CFSOptions\": [\n            {\n                \"LocalPath\": \"/data/\",\n                \"RemotePath\": \"172.30.3.90:/\",\n                \"Protocol\": \"NFS 4.0\",\n                \"StorageType\": \"SD\"\n            },\n            {\n                \"LocalPath\": \"/tmp/\",\n                \"FileSystemId\": \"cfs-odp2ivgf\"\n            }\n        ]\n    }\n}",
         "output": "{\n    \"Response\": {\n        \"RequestId\": \"b2ac2379-6453-4eab-8f63-7ade00cb67b0\"\n    }\n}",
         "title": "添加集群存储选项"
       }
@@ -27,7 +27,7 @@
     "AttachNodes": [
       {
         "document": "往集群ID为hpc-2j8ntf9l的集群的compute队列绑定一个计算节点。",
-        "input": "POST / HTTP/1.1\nHost: thpc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: AttachNodes\n<公共请求参数>\n\n{\n    \"ClusterId\": \"hpc-2j8ntf9l\",\n    \"QueueName\": \"compute\",\n    \"ImageId\": \"img-39ywauzd\",\n    \"ResourceType\": \"CVM\",\n    \"ResourceSet\": [\n        \"ins-7i4yut4b\"\n    ]\n}",
+        "input": "POST / HTTP/1.1\nHost: thpc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: AttachNodes\n<公共请求参数>\n\n{\n    \"ClusterId\": \"hpc-2j8ntf9l\",\n    \"QueueName\": \"compute\",\n    \"ImageId\": \"img-39ywauzd\",\n    \"ResourceType\": \"CVM\",\n    \"ResourceSet\": [\n        \"ins-7i4yut4b\"\n    ],\n    \"UserData\": \"IyEvYmluL2Jhc2gKZWNobyAiSGFwcHnvvIEgVGhlIHRpbWUgaXMgbm93ICQoZGF0ZSAtUikhIiA+ICAvdG1wL3Vzcl9kYXRhLnR4dA==\"\n}",
         "output": "{\n    \"Response\": {\n        \"RequestId\": \"e81d404b-4fa2-49de-bce7-6499a3529f04\"\n    }\n}",
         "title": "绑定计算节点到集群"
       }
@@ -140,15 +140,15 @@
       {
         "document": "查询指定作业ID的任务列表信息",
         "input": "POST / HTTP/1.1\nHost: thpc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeJobs\n<公共请求参数>\n\n{\n    \"JobIds\": [\n        \"job-mudo8mj\"\n    ]\n}",
-        "output": "{\n    \"Response\": {\n        \"JobSet\": [\n            {\n                \"ClusterId\": \"hpc-59wddafa\",\n                \"CreateTime\": \"2024-12-17 15:31:14\",\n                \"EndTime\": \"1753-01-01 00:00:00\",\n                \"JobDescription\": \"job test\",\n                \"JobId\": \"job-mudo8mij\",\n                \"JobName\": \"nj-test\",\n                \"JobState\": \"RUNNING\",\n                \"Priority\": 1,\n                \"QueueName\": \"compute\"\n            }\n        ],\n        \"RequestId\": \"a0a8bfa0-43cd-424e-9b12-eb01fadfadc6c1\",\n        \"TotalCount\": 1\n    }\n}",
+        "output": "{\n    \"Response\": {\n        \"JobSet\": [\n            {\n                \"ClusterId\": \"hpc-59wddafa\",\n                \"CreateTime\": \"2024-12-17 15:31:14\",\n                \"EndTime\": \"1753-01-01 00:00:00\",\n                \"JobDescription\": \"job test\",\n                \"JobId\": \"job-mudo8mij\",\n                \"JobName\": \"nj-test\",\n                \"JobState\": \"RUNNING\",\n                \"Priority\": 1,\n                \"QueueName\": \"compute\",\n                \"OccupyResources\": \"计算节点: 2\"\n            }\n        ],\n        \"RequestId\": \"a0a8bfa0-43cd-424e-9b12-eb01fadfadc6c1\",\n        \"TotalCount\": 1\n    }\n}",
         "title": "查询指定作业ID的任务列表信息"
       }
     ],
     "DescribeJobsOverview": [
       {
         "document": "thpc查看集群下的作业概览信息",
-        "input": "POST / HTTP/1.1\nHost: thpc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeJobs\n<公共请求参数>\n\n{}",
-        "output": "{\n    \"Response\": {\n        \"RequestId\": \"a0a8bfa0-43cd-424e-9b12-eb01fadfadc6c1\"\n    }\n}",
+        "input": "POST / HTTP/1.1\nHost: thpc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeJobs\n<公共请求参数>\n\n{\n    \"ClusterId\": \"hpc-xxx\"\n}",
+        "output": "{\n    \"Response\": {\n        \"JobTotal\": 3,\n        \"QueuingJobTotal\": 2,\n        \"RunningJobTotal\": 1,\n        \"RequestId\": \"a0a8bfa0-43cd-424e-9b12-eb01fadfadc6c1\"\n    }\n}",
         "title": "thpc查看集群下的作业概览信息"
       }
     ],
@@ -184,6 +184,14 @@
         "title": "从集群解绑计算节点"
       }
     ],
+    "ModifyClusterDeletionProtection": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: thpc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyClusterDeletionProtection\n<公共请求参数>\n\n{\n    \"ClusterId\": \"hpc-cjaqo2i7\",\n    \"DeletionProtection\": \"OFF\"\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"efbbe00e-0175-4ee7-92c5-debc5763142d\"\n    }\n}",
+        "title": "关闭集群删除保护状态"
+      }
+    ],
     "ModifyInitNodeScripts": [
       {
         "document": "修改节点初始化脚本。",
@@ -219,8 +227,8 @@
     "SubmitJob": [
       {
         "document": "提交一个\"hello world\"作业任务",
-        "input": "POST / HTTP/1.1\nHost: thpc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: SubmitJob\n<公共请求参数>\n\n{}",
-        "output": "{\n    \"Response\": {\n        \"RequestId\": \"ef8a9572-db7f-450b-b736-265feffafda34\"\n    }\n}",
+        "input": "POST / HTTP/1.1\nHost: thpc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: SubmitJob\n<公共请求参数>\n\n{\n    \"ClusterId\": \"hpc-5fdafdsas\",\n    \"Job\": {\n        \"Tasks\": [\n            {\n                \"Application\": {\n                    \"Commands\": [\n                        {\n                            \"Command\": \"echo hello world\"\n                        }\n                    ],\n                    \"StorageMounts\": [\n                        {\n                            \"Source\": \"/mnt/\",\n                            \"Target\": \"/data/\"\n                        }\n                    ],\n                    \"EnvVars\": [\n                        {\n                            \"Name\": \"ENV\",\n                            \"Value\": \"prod\"\n                        }\n                    ],\n                    \"Docker\": {\n                        \"Image\": \"test:test\",\n                        \"RunArgs\": [\n                            \"--privileged\",\n                            \"--cap-add=IPC_LOCK\",\n                            \"--net=host\",\n                            \"--ipc=host\",\n                            \" --gpus all\"\n                        ]\n                    },\n                    \"OutputRedirect\": {\n                        \"Driver\": \"local\",\n                        \"Options\": [\n                            \"stdout=/data/${BATCH_JOB_ID}.log\",\n                            \"stderr=/data/${BATCH_JOB_ID}.log\"\n                        ]\n                    }\n                },\n                \"TaskName\": \"task-test-v1\",\n                \"TaskInstanceNum\": 2,\n                \"Timeout\": 3600\n            }\n        ],\n        \"JobName\": \"hello world\",\n        \"JobDescription\": \"job test\",\n        \"Priority\": 1\n    },\n    \"QueueName\": \"compute\"\n}",
+        "output": "{\n    \"Response\": {\n        \"JobId\": \"job-mudfdafada\",\n        \"RequestId\": \"ef8a9572-db7f-450b-b736-265feffafda34\"\n    }\n}",
         "title": "提交一个\"hello world\"作业任务"
       }
     ],