tccli 3.0.827.1__py2.py3-none-any.whl → 3.0.829.1__py2.py3-none-any.whl

tccli/services/live/v20180801/api.json

@@ -113,7 +113,7 @@
       "status": "online"
     },
     "CreateLiveTranscodeRule": {
-      "document": "创建转码规则，需要先调用[CreateLiveTranscodeTemplate](/document/product/267/32646)接口创建转码模板，将返回的模板id绑定到流使用。\n<br>转码相关文档：[直播转封装及转码](/document/product/267/32736)。",
+      "document": "创建转码规则，数量上限：50，需要先调用[CreateLiveTranscodeTemplate](/document/product/267/32646)接口创建转码模板，将返回的模板id绑定到流使用。\n<br>转码相关文档：[直播转封装及转码](/document/product/267/32736)。",
       "input": "CreateLiveTranscodeRuleRequest",
       "name": "创建转码规则",
       "output": "CreateLiveTranscodeRuleResponse",
@@ -3154,7 +3154,6 @@
       "document": "CreateLiveTranscodeRule请求参数结构体",
       "members": [
         {
-          "default": "",
           "document": "播放域名。",
           "example": "xxx.xx.com",
           "member": "string",
@@ -3163,8 +3162,7 @@
           "type": "string"
         },
         {
-          "default": "",
-          "document": "推流路径，与推流和播放地址中的AppName保持一致。如果只绑定域名，则此处填空。",
+          "document": "推流路径，与推流和播放地址中的AppName保持一致。如果只绑定域名，则此处填\"\"。",
           "example": "live",
           "member": "string",
           "name": "AppName",
@@ -3172,7 +3170,6 @@
           "type": "string"
         },
         {
-          "default": "",
           "document": "流名称。如果只绑定域名或路径，则此处填空。",
           "example": "stream",
           "member": "string",
@@ -3181,7 +3178,6 @@
           "type": "string"
         },
         {
-          "default": "",
           "document": "指定已有的模板Id。",
           "example": "1000",
           "member": "int64",

tccli/services/live/v20180801/examples.json

@@ -154,7 +154,7 @@
     ],
     "CreateLiveTranscodeRule": [
       {
-        "document": "",
+        "document": "CreateLiveTranscodeRule 默认示例。",
         "input": "https://live.tencentcloudapi.com/?Action=CreateLiveTranscodeRule\n&DomainName=5000.liveplay.myqcloud.com\n&AppName=live\n&StreamName=stream1\n&TemplateId=1000\n&<公共请求参数>",
         "output": "{\n    \"Response\": {\n        \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n    }\n}",
         "title": "请求示例"

tccli/services/mongodb/v20190725/api.json

@@ -36,7 +36,7 @@
       "status": "online"
     },
     "CreateDBInstanceHour": {
-      "document": "本接口(CreateDBInstanceHour)用于创建按量计费的MongoDB云数据库实例。",
+      "document": "本接口（CreateDBInstanceHour）用于创建按量计费的MongoDB云数据库实例。",
       "input": "CreateDBInstanceHourRequest",
       "name": "创建云数据库实例（按量计费）",
       "output": "CreateDBInstanceHourResponse",
@@ -772,8 +772,7 @@
       "document": "CreateDBInstanceHour请求参数结构体",
       "members": [
         {
-          "default": "",
-          "document": "实例内存大小，单位：GB",
+          "document": "实例内存大小，单位：GB。",
           "example": "4",
           "member": "uint64",
           "name": "Memory",
@@ -781,8 +780,7 @@
           "type": "int"
         },
         {
-          "default": "",
-          "document": "实例硬盘大小，单位：GB",
+          "document": "实例硬盘大小，单位：GB。",
           "example": "250",
           "member": "uint64",
           "name": "Volume",
@@ -790,8 +788,7 @@
           "type": "int"
         },
         {
-          "default": "",
-          "document": "副本集个数，创建副本集实例时，该参数必须设置为1；创建分片实例时，具体参照查询云数据库的售卖规格返回参数",
+          "document": "指副本集数量。\n- 创建副本集实例，该参数只能为1。\n- 创建分片实例，指分片的数量。具体售卖规格，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。",
           "example": "1",
           "member": "uint64",
           "name": "ReplicateSetNum",
@@ -799,8 +796,7 @@
           "type": "int"
         },
         {
-          "default": "",
-          "document": "每个副本集内节点个数，具体参照查询云数据库的售卖规格返回参数",
+          "document": "指每个副本集内节点个数。具体售卖规格，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。",
           "example": "2",
           "member": "uint64",
           "name": "NodeNum",
@@ -808,8 +804,7 @@
           "type": "int"
         },
         {
-          "default": "",
-          "document": "版本号，具体支持的售卖版本请参照查询云数据库的售卖规格（DescribeSpecInfo）返回结果。参数与版本对应关系是MONGO_3_WT：MongoDB 3.2 WiredTiger存储引擎版本，MONGO_3_ROCKS：MongoDB 3.2 RocksDB存储引擎版本，MONGO_36_WT：MongoDB 3.6 WiredTiger存储引擎版本，MONGO_40_WT：MongoDB 4.0 WiredTiger存储引擎版本，MONGO_42_WT：MongoDB 4.2 WiredTiger存储引擎版本",
+          "document": "指版本信息。具体售卖规格，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。\n- MONGO_36_WT：MongoDB 3.6 WiredTiger存储引擎版本。\n- MONGO_40_WT：MongoDB 4.0 WiredTiger存储引擎版本。\n- MONGO_42_WT：MongoDB 4.2 WiredTiger存储引擎版本。\n- MONGO_44_WT：MongoDB 4.4 WiredTiger存储引擎版本。",
           "example": "MONGO_3_WT",
           "member": "string",
           "name": "MongoVersion",
@@ -817,8 +812,7 @@
           "type": "string"
         },
         {
-          "default": "",
-          "document": "机器类型，HIO：高IO型；HIO10G：高IO万兆",
+          "document": "机器类型。\n- HIO：高IO型。\n- HIO10G：高IO万兆。",
           "example": "HIO10G",
           "member": "string",
           "name": "MachineCode",
@@ -826,8 +820,7 @@
           "type": "string"
         },
         {
-          "default": "",
-          "document": "实例数量，最小值1，最大值为10",
+          "document": "实例数量，最小值1，最大值为10。",
           "example": "1",
           "member": "uint64",
           "name": "GoodsNum",
@@ -835,8 +828,7 @@
           "type": "int"
         },
         {
-          "default": "",
-          "document": "可用区信息，格式如：ap-guangzhou-2。注：此参数填写的是主可用区，如果选择多可用区部署，Zone必须是AvailabilityZoneList中的一个",
+          "document": "可用区信息，输入格式如：ap-guangzhou-2。\n- 具体信息，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。\n- 该参数为主可用区，如果多可用区部署，Zone必须是AvailabilityZoneList中的一个。",
           "example": "ap-guangzhou-3",
           "member": "string",
           "name": "Zone",
@@ -844,8 +836,7 @@
           "type": "string"
         },
         {
-          "default": "",
-          "document": "实例类型，REPLSET-副本集，SHARD-分片集群",
+          "document": "实例架构类型。\n- REPLSET：副本集。\n- SHARD：分片集群。",
           "example": "REPLSET",
           "member": "string",
           "name": "ClusterType",
@@ -853,8 +844,7 @@
           "type": "string"
         },
         {
-          "default": "",
-          "document": "私有网络ID，如果不设置该参数则默认选择基础网络",
+          "document": "私有网络ID，如果不设置该参数，则默认选择基础网络。",
           "example": "无",
           "member": "string",
           "name": "VpcId",
@@ -862,8 +852,7 @@
           "type": "string"
         },
         {
-          "default": "",
-          "document": "私有网络下的子网ID，如果设置了 VpcId，则 SubnetId必填",
+          "document": "私有网络下的子网 ID，如果配置参数 VpcId，则 SubnetId必须配置。",
           "example": "无",
           "member": "string",
           "name": "SubnetId",
@@ -871,8 +860,7 @@
           "type": "string"
         },
         {
-          "default": "",
-          "document": "实例密码，不设置该参数则默认密码规则为 实例ID+\"@\"+主账户uin。举例实例id为cmgo-higv73ed，uin为100000001，则默认密码为\"cmgo-higv73ed@100000001\"。密码必须是8-16位字符，且至少包含字母、数字和字符 !@#%^*() 中的两种",
+          "document": "实例密码。\n- 不设置该参数，则默认密码格式为：实例ID+@+主账户uin。例如：实例 ID 为cmgo-higv73ed，UIN 为100000001，则默认密码为：cmgo-higv73ed@100000001。 \n- 自定义密码长度为8-32个字符，至少包含字母、数字和字符（!@#%^*()_）中的两种。",
           "example": "无",
           "member": "string",
           "name": "Password",
@@ -880,8 +868,7 @@
           "type": "string"
         },
         {
-          "default": "",
-          "document": "项目ID，不设置为默认项目",
+          "document": "项目ID。若不设置该参数，则为默认项目。",
           "example": "无",
           "member": "int64",
           "name": "ProjectId",
@@ -889,8 +876,7 @@
           "type": "int"
         },
         {
-          "default": "",
-          "document": "实例标签信息",
+          "document": "实例标签信息。",
           "example": "无",
           "member": "TagInfo",
           "name": "Tags",
@@ -898,8 +884,7 @@
           "type": "list"
         },
         {
-          "default": "",
-          "document": "1:正式实例,2:临时实例,3:只读实例,4:灾备实例,5:克隆实例",
+          "document": "实例类型。\n- 1：正式实例。\n- 3：只读实例。\n- 4：灾备实例。",
           "example": "1",
           "member": "int64",
           "name": "Clone",
@@ -907,8 +892,7 @@
           "type": "int"
         },
         {
-          "default": "",
-          "document": "父实例Id，当Clone为3或者4时，这个必须填",
+          "document": "父实例 ID。当参数**Clone**为3或者4时，即实例为只读或灾备实例时，该参数必须配置。",
           "example": "无",
           "member": "string",
           "name": "Father",
@@ -916,8 +900,7 @@
           "type": "string"
         },
         {
-          "default": "",
-          "document": "安全组",
+          "document": "安全组。",
           "example": "无",
           "member": "string",
           "name": "SecurityGroup",
@@ -925,8 +908,7 @@
           "type": "list"
         },
         {
-          "default": "",
-          "document": "克隆实例回档时间。若是克隆实例，则必须填写，示例：2021-08-13 16:30:00。注：只能回档7天内的时间点",
+          "document": "克隆实例回档时间。\n- 若为克隆实例，则必须配置该参数。输入格式示例：2021-08-13 16:30:00。\n- 回档时间范围：仅能回档7天内时间点的数据。",
           "example": "无",
           "member": "string",
           "name": "RestoreTime",
@@ -934,8 +916,7 @@
           "type": "string"
         },
         {
-          "default": "",
-          "document": "实例名称。注：名称只支持长度为60个字符的中文、英文、数字、下划线_、分隔符-",
+          "document": "实例名称。仅支持长度为60个字符的中文、英文、数字、下划线_、分隔符- 。",
           "example": "无",
           "member": "string",
           "name": "InstanceName",
@@ -943,8 +924,7 @@
           "type": "string"
         },
         {
-          "default": "",
-          "document": "多可用区部署的节点列表，具体支持的售卖版本请参照查询云数据库的售卖规格（DescribeSpecInfo）返回结果。注：1、多可用区部署节点只能部署在3个不同可用区；2、为了保障跨可用区切换，不支持将集群的大多数节点部署在同一个可用区（如3节点集群不支持2个节点部署在同一个区）；3、不支持4.2及以上版本；4、不支持只读灾备实例；5、不能选择基础网络",
+          "document": "多可用区部署的节点列表。具体信息，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)获取。\n- 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如：3节点集群不支持2个节点部署在同一个区。\n- 不支持4.2及以上版本。\n- 不支持只读灾备实例。\n- 不能选择基础网络。",
           "example": "无",
           "member": "string",
           "name": "AvailabilityZoneList",
@@ -952,8 +932,7 @@
           "type": "list"
         },
         {
-          "default": "",
-          "document": "mongos cpu数量，购买MongoDB 4.2 WiredTiger存储引擎版本的分片集群时必须填写，具体支持的售卖版本请参照查询云数据库的售卖规格（DescribeSpecInfo）返回结果",
+          "document": "Mongos CPU 核数。\n- 购买MongoDB 3.6 WiredTiger存储引擎版本以上的分片集群时，可选择性配置该参数。\n- 若不配置该参数，则根据Mongod节点规格默认适配 Mongos 规格，默认规格免费。",
           "example": "无",
           "member": "uint64",
           "name": "MongosCpu",
@@ -961,8 +940,7 @@
           "type": "int"
         },
         {
-          "default": "",
-          "document": "mongos 内存大小，购买MongoDB 4.2 WiredTiger存储引擎版本的分片集群时必须填写，具体支持的售卖版本请参照查询云数据库的售卖规格（DescribeSpecInfo）返回结果",
+          "document": "Mongos 内存大小。\n- 购买MongoDB 3.6 WiredTiger存储引擎版本以上的分片集群时，可选择性配置该参数。\n- 若不配置该参数，则根据Mongod节点规格默认适配 Mongos 规格，默认规格免费。",
           "example": "无",
           "member": "uint64",
           "name": "MongosMemory",
@@ -970,13 +948,36 @@
           "type": "int"
         },
         {
-          "default": "",
-          "document": "mongos 数量，购买MongoDB 4.2 WiredTiger存储引擎版本的分片集群时必须填写，具体支持的售卖版本请参照查询云数据库的售卖规格（DescribeSpecInfo）返回结果。注：为了保障高可用，最低需要购买3个mongos，上限为32个",
+          "document": "Mongos 数量。\n- 购买MongoDB 3.6 WiredTiger存储引擎版本以上的分片集群时，可选择性配置该参数。\n- 若不配置该参数，则根据Mongod节点规格默认适配 Mongos 规格，默认规格免费。",
           "example": "无",
           "member": "uint64",
           "name": "MongosNodeNum",
           "required": false,
           "type": "int"
+        },
+        {
+          "document": "只读节点数量，最大不超过7个。",
+          "example": "无",
+          "member": "uint64",
+          "name": "ReadonlyNodeNum",
+          "required": false,
+          "type": "int"
+        },
+        {
+          "document": "指只读节点所属可用区。跨可用区部署实例，参数**ReadonlyNodeNum**不为**0**时，必须配置该参数。",
+          "example": "无",
+          "member": "string",
+          "name": "ReadonlyNodeAvailabilityZoneList",
+          "required": false,
+          "type": "list"
+        },
+        {
+          "document": "Hidden节点所属可用区。跨可用区部署实例，必须配置该参数。",
+          "example": "无",
+          "member": "string",
+          "name": "HiddenZone",
+          "required": false,
+          "type": "string"
         }
       ],
       "type": "object"
@@ -985,20 +986,18 @@
       "document": "CreateDBInstanceHour返回参数结构体",
       "members": [
         {
-          "document": "订单ID",
+          "document": "订单ID。",
           "example": "20190709160000003502416120946732",
           "member": "string",
           "name": "DealId",
-          "required": true,
           "type": "string",
           "value_allowed_null": false
         },
         {
-          "document": "创建的实例ID列表",
+          "document": "创建的实例ID列表。",
           "example": "[\"cmgo-m26c6jsf\"]",
           "member": "string",
           "name": "InstanceIds",
-          "required": true,
           "type": "list",
           "value_allowed_null": false
         },

tccli/services/mongodb/v20190725/examples.json

@@ -43,7 +43,7 @@
     "CreateDBInstanceHour": [
       {
         "document": "当前示例仅适合4.0版本，其余版本请严格参考传入参数中各版本说明项",
-        "input": "https://mongodb.tencentcloudapi.com/?Action=CreateDBInstanceHour\n&Memory=4\n&Volume=250\n&ReplicateSetNum=1\n&NodeNum=2\n&MongoVersion=MONGO_40_WT\n&MachineCode=HIO10G\n&GoodsNum=1\n&Zone=ap-guangzhou-3\n&Clone=1\n&ClusterType=REPLSET\n&<公共请求参数>",
+        "input": "POST / HTTP/1.1\nHost: mongodb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateDBInstanceHour\n<公共请求参数>\n\n{\n    \"Zone\": \"ap-guangzhou-3\",\n    \"GoodsNum\": \"1\",\n    \"Clone\": \"1\",\n    \"Memory\": \"4\",\n    \"ClusterType\": \"REPLSET\",\n    \"Volume\": \"250\",\n    \"NodeNum\": \"2\",\n    \"ReplicateSetNum\": \"1\",\n    \"MachineCode\": \"HIO10G\",\n    \"MongoVersion\": \"MONGO_40_WT\"\n}",
         "output": "{\n    \"Response\": {\n        \"RequestId\": \"eaf9b19d-5ad4-4ca2-9fc4-a319aeb9181f\",\n        \"DealId\": \"20190709160000003502416120946732\",\n        \"InstanceIds\": [\n            \"cmgo-m26c6jsf\"\n        ]\n    }\n}",
         "title": "创建云数据库实例（按量计费）"
       }