tccli 3.0.896.1__py2.py3-none-any.whl → 3.0.898.1__py2.py3-none-any.whl

tccli/services/ckafka/v20190819/api.json

@@ -112,6 +112,13 @@
       "output": "CreatePartitionResponse",
       "status": "online"
     },
+    "CreatePostPaidInstance": {
+      "document": "当前接口用来替代 CreateInstancePost 接口。创建按量计费实例。通常用于 SDK 或云 API 控制台调用接口，创建后付费 CKafka 实例。调用接口与在 CKafka 控制台购买按量付费实例效果相同。",
+      "input": "CreatePostPaidInstanceRequest",
+      "name": "创建按量计费实例（新）",
+      "output": "CreatePostPaidInstanceResponse",
+      "status": "online"
+    },
     "CreateRoute": {
       "document": "添加实例路由",
       "input": "CreateRouteRequest",
@@ -3407,6 +3414,52 @@
       ],
       "type": "object"
     },
+    "CreateInstancePostData": {
+      "document": "创建后付费接口返回的 Data 数据结构",
+      "members": [
+        {
+          "disabled": false,
+          "document": "CreateInstancePre返回固定为0，不能作为CheckTaskStatus的查询条件。只是为了保证和后台数据结构对齐。\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "0",
+          "member": "int64",
+          "name": "FlowId",
+          "required": true,
+          "type": "int",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "订单号列表\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "[\"20230608002033882210000\"]",
+          "member": "string",
+          "name": "DealNames",
+          "required": true,
+          "type": "list",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "实例Id，当购买多个实例时，默认返回购买的第一个实例 id\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "ckafka-e5vjxxxx",
+          "member": "string",
+          "name": "InstanceId",
+          "required": true,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "订单和购买实例对应映射列表\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "无",
+          "member": "DealInstanceDTO",
+          "name": "DealNameInstanceIdMapping",
+          "required": false,
+          "type": "list",
+          "value_allowed_null": true
+        }
+      ],
+      "usage": "out"
+    },
     "CreateInstancePostRequest": {
       "document": "CreateInstancePost请求参数结构体",
       "members": [
@@ -3575,6 +3628,42 @@
       ],
       "type": "object"
     },
+    "CreateInstancePostResp": {
+      "document": "后付费实例相关接口返回结构",
+      "members": [
+        {
+          "disabled": false,
+          "document": "返回的code，0为正常，非0为错误",
+          "example": "0",
+          "member": "string",
+          "name": "ReturnCode",
+          "required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "接口返回消息，当接口报错时提示错误信息",
+          "example": "success",
+          "member": "string",
+          "name": "ReturnMessage",
+          "required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "返回的Data数据\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "无",
+          "member": "CreateInstancePostData",
+          "name": "Data",
+          "required": true,
+          "type": "object",
+          "value_allowed_null": true
+        }
+      ],
+      "usage": "out"
+    },
     "CreateInstancePostResponse": {
       "document": "CreateInstancePost返回参数结构体",
       "members": [
@@ -3939,6 +4028,195 @@
       ],
       "type": "object"
     },
+    "CreatePostPaidInstanceRequest": {
+      "document": "CreatePostPaidInstance请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "实例名称，是一个不超过 64 个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)",
+          "example": "testInstance",
+          "member": "string",
+          "name": "InstanceName",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "创建的实例默认接入点所在的 vpc 对应 vpcId。目前不支持创建基础网络实例，因此该参数必填",
+          "example": "vpc-xxxxxxxx",
+          "member": "string",
+          "name": "VpcId",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "子网id。创建实例默认接入点所在的子网对应的子网 id",
+          "example": "subnet-xxxxxxxx",
+          "member": "string",
+          "name": "SubnetId",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "实例规格。当创建标准版实例时必填，创建专业版实例时不需要填写。1：入门型；2：标准型；3：进阶型；4：容量型；5：高阶型1；6：高阶性2；7：高阶型3；8：高阶型4；9 ：独占型",
+          "example": "1",
+          "member": "int64",
+          "name": "InstanceType",
+          "required": false,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "实例日志的默认最长保留时间，单位分钟。不传入该参数时默认为 1440 分钟（1天），最大30天。当 topic 显式设置消息保留时间时，以 topic 保留时间为准",
+          "example": "1440",
+          "member": "int64",
+          "name": "MsgRetentionTime",
+          "required": false,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "创建实例时可以选择集群Id, 该入参表示集群Id。不指定实例所在集群则不传入该参数",
+          "example": "5914",
+          "member": "int64",
+          "name": "ClusterId",
+          "required": false,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "实例版本。目前支持 \"0.10.2\",\"1.1.1\",\"2.4.2\",\"2.8.1\"",
+          "example": "2.4.2",
+          "member": "string",
+          "name": "KafkaVersion",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "实例类型。\"standard\"：标准版，\"profession\"：专业版",
+          "example": "profession",
+          "member": "string",
+          "name": "SpecificationsType",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "实例硬盘类型，\"CLOUD_BASIC\"：云硬盘，\"CLOUD_SSD\"：高速云硬盘。不传默认为 \"CLOUD_BASIC\"",
+          "example": "CLOUD_BASIC",
+          "member": "string",
+          "name": "DiskType",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "实例内网峰值带宽。单位 MB/s。标准版需传入当前实例规格所对应的峰值带宽。注意如果创建的实例为专业版实例，峰值带宽，分区数等参数配置需要满足专业版的计费规格。",
+          "example": "20",
+          "member": "int64",
+          "name": "BandWidth",
+          "required": false,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "实例硬盘大小，需要满足当前实例的计费规格",
+          "example": "200",
+          "member": "int64",
+          "name": "DiskSize",
+          "required": false,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "实例最大分区数量，需要满足当前实例的计费规格",
+          "example": "400",
+          "member": "int64",
+          "name": "Partition",
+          "required": false,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "实例最大 topic 数量，需要满足当前实例的计费规格",
+          "example": "200",
+          "member": "int64",
+          "name": "TopicNum",
+          "required": false,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "实例所在的可用区。当创建多可用区实例时，该参数为创建的默认接入点所在子网的可用区 id",
+          "example": "100006",
+          "member": "int64",
+          "name": "ZoneId",
+          "required": false,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "当前实例是否为多可用区实例。",
+          "example": "true",
+          "member": "bool",
+          "name": "MultiZoneFlag",
+          "required": false,
+          "type": "bool"
+        },
+        {
+          "disabled": false,
+          "document": "当实例为多可用区实例时，多可用区 id 列表。注意参数 ZoneId 对应的多可用区需要包含在该参数数组中",
+          "example": "[100006,100007]",
+          "member": "int64",
+          "name": "ZoneIds",
+          "required": false,
+          "type": "list"
+        },
+        {
+          "disabled": false,
+          "document": "购买实例数量。非必填，默认值为 1。当传入该参数时，会创建多个 instanceName 加后缀区分的实例",
+          "example": "1",
+          "member": "int64",
+          "name": "InstanceNum",
+          "required": false,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "公网带宽大小，单位 Mbps。默认是没有加上免费 3Mbps 带宽。例如总共需要 3Mbps 公网带宽，此处传 0；总共需要 4Mbps 公网带宽，此处传 1",
+          "example": "12",
+          "member": "int64",
+          "name": "PublicNetworkMonthly",
+          "required": false,
+          "type": "int"
+        }
+      ],
+      "type": "object"
+    },
+    "CreatePostPaidInstanceResponse": {
+      "document": "CreatePostPaidInstance返回参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "返回结果",
+          "example": "无",
+          "member": "CreateInstancePostResp",
+          "name": "Result",
+          "type": "object",
+          "value_allowed_null": false
+        },
+        {
+          "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "CreateRouteRequest": {
       "document": "CreateRoute请求参数结构体",
       "members": [
@@ -11911,6 +12189,7 @@
           "example": "false",
           "member": "bool",
           "name": "SelfBuilt",
+          "output_required": true,
           "required": true,
           "type": "bool",
           "value_allowed_null": false
@@ -11921,6 +12200,7 @@
           "example": "ckafka-xxx",
           "member": "string",
           "name": "Resource",
+          "output_required": true,
           "required": true,
           "type": "string",
           "value_allowed_null": false
@@ -11931,6 +12211,7 @@
           "example": "test",
           "member": "string",
           "name": "Topic",
+          "output_required": true,
           "required": false,
           "type": "string",
           "value_allowed_null": false
@@ -11941,6 +12222,7 @@
           "example": "timestamp",
           "member": "string",
           "name": "OffsetType",
+          "output_required": true,
           "required": false,
           "type": "string",
           "value_allowed_null": true
@@ -11951,6 +12233,7 @@
           "example": "1635339533",
           "member": "uint64",
           "name": "StartTime",
+          "output_required": true,
           "required": false,
           "type": "int",
           "value_allowed_null": true
@@ -11961,6 +12244,7 @@
           "example": "MyCkafkaName",
           "member": "string",
           "name": "ResourceName",
+          "output_required": true,
           "required": false,
           "type": "string",
           "value_allowed_null": true
@@ -11971,6 +12255,7 @@
           "example": "200005",
           "member": "int64",
           "name": "ZoneId",
+          "output_required": true,
           "required": false,
           "type": "int",
           "value_allowed_null": true
@@ -11981,6 +12266,7 @@
           "example": "xxx",
           "member": "string",
           "name": "TopicId",
+          "output_required": true,
           "required": false,
           "type": "string",
           "value_allowed_null": true
@@ -11991,6 +12277,7 @@
           "example": "1",
           "member": "int64",
           "name": "PartitionNum",
+          "output_required": true,
           "required": false,
           "type": "int",
           "value_allowed_null": true
@@ -12001,6 +12288,7 @@
           "example": "false",
           "member": "bool",
           "name": "EnableToleration",
+          "output_required": true,
           "required": false,
           "type": "bool",
           "value_allowed_null": true
@@ -12011,6 +12299,7 @@
           "example": "4000",
           "member": "uint64",
           "name": "QpsLimit",
+          "output_required": true,
           "required": false,
           "type": "int",
           "value_allowed_null": true
@@ -12021,6 +12310,7 @@
           "example": "xxx",
           "member": "TableMapping",
           "name": "TableMappings",
+          "output_required": true,
           "required": false,
           "type": "list",
           "value_allowed_null": true
@@ -12031,6 +12321,7 @@
           "example": "false",
           "member": "bool",
           "name": "UseTableMapping",
+          "output_required": true,
           "required": false,
           "type": "bool",
           "value_allowed_null": true
@@ -12041,6 +12332,7 @@
           "example": "false",
           "member": "bool",
           "name": "UseAutoCreateTopic",
+          "output_required": true,
           "required": false,
           "type": "bool",
           "value_allowed_null": true
@@ -12051,6 +12343,7 @@
           "example": "none",
           "member": "string",
           "name": "CompressionType",
+          "output_required": true,
           "required": false,
           "type": "string",
           "value_allowed_null": true
@@ -12061,6 +12354,7 @@
           "example": "1",
           "member": "int64",
           "name": "MsgMultiple",
+          "output_required": true,
           "required": false,
           "type": "int",
           "value_allowed_null": true
@@ -12071,6 +12365,7 @@
           "example": "DATA_SYNC_TYPE",
           "member": "string",
           "name": "ConnectorSyncType",
+          "output_required": true,
           "required": false,
           "type": "string",
           "value_allowed_null": true
@@ -12081,6 +12376,7 @@
           "example": "false",
           "member": "bool",
           "name": "KeepPartition",
+          "output_required": true,
           "required": false,
           "type": "bool",
           "value_allowed_null": true
@@ -16529,78 +16825,78 @@
       "document": "Topic配置",
       "members": [
         {
-          "default": "",
           "disabled": false,
           "document": "单独售卖Topic的Topic名称",
           "example": "1234-xxx",
           "member": "string",
           "name": "Resource",
+          "output_required": true,
           "required": true,
           "type": "string",
           "value_allowed_null": false
         },
         {
-          "default": "",
           "disabled": false,
           "document": "Offset类型，最开始位置earliest，最新位置latest，时间点位置timestamp\n注意：此字段可能返回 null，表示取不到有效值。",
           "example": "timestamp",
           "member": "string",
           "name": "OffsetType",
+          "output_required": true,
           "required": false,
           "type": "string",
           "value_allowed_null": true
         },
         {
-          "default": "",
           "disabled": false,
           "document": "Offset类型为timestamp时必传，传时间戳，精确到秒\n注意：此字段可能返回 null，表示取不到有效值。",
           "example": "1635339533",
           "member": "uint64",
           "name": "StartTime",
+          "output_required": true,
           "required": false,
           "type": "int",
           "value_allowed_null": true
         },
         {
-          "default": "",
           "disabled": false,
           "document": "Topic的TopicId【出参】\n注意：此字段可能返回 null，表示取不到有效值。",
           "example": "xxx",
           "member": "string",
           "name": "TopicId",
+          "output_required": true,
           "required": false,
           "type": "string",
           "value_allowed_null": true
         },
         {
-          "default": "",
           "disabled": false,
           "document": "写入Topic时是否进行压缩，不开启填\"none\"，开启的话，可选择\"gzip\", \"snappy\", \"lz4\"中的一个进行填写。\n注意：此字段可能返回 null，表示取不到有效值。",
           "example": "none",
           "member": "string",
           "name": "CompressionType",
+          "output_required": true,
           "required": false,
           "type": "string",
           "value_allowed_null": true
         },
         {
-          "default": "",
           "disabled": false,
           "document": "使用的Topic是否需要自动创建（目前只支持SOURCE流入任务）\n注意：此字段可能返回 null，表示取不到有效值。",
           "example": "false",
           "member": "bool",
           "name": "UseAutoCreateTopic",
+          "output_required": true,
           "required": false,
           "type": "bool",
           "value_allowed_null": true
         },
         {
-          "default": "",
           "disabled": false,
           "document": "源topic消息1条扩增成msgMultiple条写入目标topic(该参数目前只有ckafka流入ckafka适用)\n注意：此字段可能返回 null，表示取不到有效值。",
           "example": "1",
           "member": "int64",
           "name": "MsgMultiple",
+          "output_required": true,
           "required": false,
           "type": "int",
           "value_allowed_null": true

tccli/services/ckafka/v20190819/examples.json

@@ -158,6 +158,26 @@
         "title": "增加主题分区"
       }
     ],
+    "CreatePostPaidInstance": [
+      {
+        "document": "创建硬盘大小 200GB，峰值带宽 20MB/s 的专业版后付费实例",
+        "input": "POST / HTTP/1.1\nHost: ckafka.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreatePostPaidInstance\n<公共请求参数>\n\n{\n    \"InstanceName\": \"test55\",\n    \"VpcId\": \"vpc-rmcgxxxx\",\n    \"SubnetId\": \"subnet-mnzcxxxx\",\n    \"ZoneId\": 450001,\n    \"InstanceType\": 1,\n    \"KafkaVersion\": \"1.1.1\",\n    \"SpecificationsType\": \"profession\",\n    \"DiskSize\": 200,\n    \"BandWidth\": 20,\n    \"Partition\": 400,\n    \"DiskType\": \"CLOUD_BASIC\",\n    \"PublicNetworkMonthly\": 0\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"323c3bbe-db79-48c3-9b76-63aacd65b169\",\n        \"Result\": {\n            \"Data\": {\n                \"DealNameInstanceIdMapping\": [\n                    {\n                        \"DealName\": \"20230608002033899990000\",\n                        \"InstanceIdList\": [\n                            \"ckafka-mom5xxxx\"\n                        ]\n                    }\n                ],\n                \"DealNames\": [\n                    \"2023060800203389990000\"\n                ],\n                \"FlowId\": 0,\n                \"InstanceId\": \"ckafka-mom5xxxx\"\n            },\n            \"ReturnCode\": \"0\",\n            \"ReturnMessage\": \"ok[apply ok]\"\n        }\n    }\n}",
+        "title": "创建后付费专业版实例"
+      },
+      {
+        "document": "同时创建三个后付费专业版实例",
+        "input": "POST / HTTP/1.1\nHost: ckafka.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreatePostPaidInstance\n<公共请求参数>\n\n{\n    \"InstanceName\": \"test58\",\n    \"VpcId\": \"vpc-rmcg5cpf\",\n    \"SubnetId\": \"subnet-mnzcs7gk\",\n    \"KafkaVersion\": \"2.4.2\",\n    \"SpecificationsType\": \"profession\",\n    \"BandWidth\": 20,\n    \"DiskSize\": 200,\n    \"Partition\": 400,\n    \"TopicNum\": 200,\n    \"ZoneId\": 450001,\n    \"InstanceNum\": 3,\n    \"PublicNetworkMonthly\": 12\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"cda79237-6424-482a-b2d2-97d4853b33b4\",\n        \"Result\": {\n            \"Data\": {\n                \"DealNameInstanceIdMapping\": [\n                    {\n                        \"DealName\": \"20230608002033915320000\",\n                        \"InstanceIdList\": [\n                            \"ckafka-bz4dxxxx\",\n                            \"ckafka-o9gdxxxx\",\n                            \"ckafka-aj5gxxxx\"\n                        ]\n                    }\n                ],\n                \"DealNames\": [\n                    \"20230608002033915320000\"\n                ],\n                \"FlowId\": 0,\n                \"InstanceId\": \"ckafka-bz4dxxxx\"\n            },\n            \"ReturnCode\": \"0\",\n            \"ReturnMessage\": \"ok[apply ok]\"\n        }\n    }\n}",
+        "title": "批量创建后付费专业版实例"
+      },
+      {
+        "document": "创建一个三可用区的专业版实例",
+        "input": "POST / HTTP/1.1\nHost: ckafka.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreatePostPaidInstance\n<公共请求参数>\n\n{\n    \"InstanceName\": \"test55\",\n    \"VpcId\": \"vpc-rmcgxxxx\",\n    \"SubnetId\": \"subnet-mnzcxxxx\",\n    \"ZoneId\": 450001,\n    \"InstanceType\": 1,\n    \"KafkaVersion\": \"1.1.1\",\n    \"SpecificationsType\": \"profession\",\n    \"DiskSize\": 200,\n    \"BandWidth\": 20,\n    \"Partition\": 400,\n    \"DiskType\": \"CLOUD_BASIC\",\n    \"PublicNetworkMonthly\": 0,\n    \"MultiZoneFlag\": true,\n    \"ZoneIds\": [\n        450001,\n        450002,\n        450003\n    ]\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"323c3bbe-db79-48c3-9b76-63aacd65b169\",\n        \"Result\": {\n            \"Data\": {\n                \"DealNameInstanceIdMapping\": [\n                    {\n                        \"DealName\": \"20230608002033899990000\",\n                        \"InstanceIdList\": [\n                            \"ckafka-mom5xxxx\"\n                        ]\n                    }\n                ],\n                \"DealNames\": [\n                    \"2023060800203389990000\"\n                ],\n                \"FlowId\": 0,\n                \"InstanceId\": \"ckafka-mom5xxxx\"\n            },\n            \"ReturnCode\": \"0\",\n            \"ReturnMessage\": \"ok[apply ok]\"\n        }\n    }\n}",
+        "title": "创建后付费多可用区专业版实例"
+      }
+    ],
     "CreateRoute": [
       {
         "document": "",

tccli/services/clb/v20180317/api.json

@@ -2784,7 +2784,7 @@
         },
         {
           "disabled": false,
-          "document": "仅适用于公网负载均衡。IP版本，可取值：IPV4、IPV6、IPv6FullChain，默认值 IPV4。说明：取值为IPV6表示为IPV6 NAT64版本；取值为IPv6FullChain，表示为IPv6版本。",
+          "document": "仅适用于公网负载均衡。IP版本，可取值：IPV4、IPV6、IPv6FullChain，不区分大小写，默认值 IPV4。说明：取值为IPV6表示为IPV6 NAT64版本；取值为IPv6FullChain，表示为IPv6版本。",
           "example": "IPV4",
           "member": "string",
           "name": "AddressIPVersion",
@@ -2965,6 +2965,7 @@
           "example": "[\"lb-6efswuxa\"]",
           "member": "string",
           "name": "LoadBalancerIds",
+          "output_required": true,
           "type": "list",
           "value_allowed_null": true
         },
@@ -2974,6 +2975,7 @@
           "example": "2022XXXX",
           "member": "string",
           "name": "DealName",
+          "output_required": true,
           "type": "string",
           "value_allowed_null": true
         },