tccli 3.0.1126.1__py2.py3-none-any.whl → 3.0.1128.1__py2.py3-none-any.whl

tccli/services/mongodb/v20190725/api.json

@@ -70,6 +70,13 @@
       "output": "DescribeBackupDownloadTaskResponse",
       "status": "online"
     },
+    "DescribeBackupRules": {
+      "document": "本接口（DescribeBackupRules）用于获取实例自动备份配置信息。",
+      "input": "DescribeBackupRulesRequest",
+      "name": "获取云数据库实例自动备份配置",
+      "output": "DescribeBackupRulesResponse",
+      "status": "online"
+    },
     "DescribeClientConnections": {
       "document": "本接口（DescribeClientConnections）用于查询实例客户端连接信息，包括连接 IP 和连接数量。",
       "input": "DescribeClientConnectionsRequest",
@@ -147,6 +154,20 @@
       "output": "DescribeSpecInfoResponse",
       "status": "online"
     },
+    "DescribeTransparentDataEncryptionStatus": {
+      "document": "获取实例透明加密的开启状态",
+      "input": "DescribeTransparentDataEncryptionStatusRequest",
+      "name": "获取实例透明加密的开启状态",
+      "output": "DescribeTransparentDataEncryptionStatusResponse",
+      "status": "online"
+    },
+    "EnableTransparentDataEncryption": {
+      "document": "本接口(EnableTransparentDataEncryption)用于开启云数据库 MongoDB 的透明加密能力。",
+      "input": "EnableTransparentDataEncryptionRequest",
+      "name": "开启实例数据透明加密",
+      "output": "EnableTransparentDataEncryptionResponse",
+      "status": "online"
+    },
     "FlashBackDBInstance": {
       "document": "该接口用于发起按 Key 闪回任务，依据数据的闪回 Key（默认为 id）对数据进行极速回档，快速恢复业务。\n**说明：按 Key 闪回于2023年09月11日正式进行公测，在此期间，该接口仅对公测用户开放。**",
       "input": "FlashBackDBInstanceRequest",
@@ -252,6 +273,13 @@
       "output": "SetAccountUserPrivilegeResponse",
       "status": "online"
     },
+    "SetBackupRules": {
+      "document": "本接口(SetBackupRules)用于设置 MongoDB 云数据库的自动备份规则。",
+      "input": "SetBackupRulesRequest",
+      "name": "设置云数据库实例的自动备份规则",
+      "output": "SetBackupRulesResponse",
+      "status": "online"
+    },
     "SetInstanceMaintenance": {
       "document": "本接口（SetInstanceMaintenance ） 用于设置实例维护时间窗。",
       "input": "SetInstanceMaintenanceRequest",
@@ -1802,6 +1830,63 @@
       ],
       "type": "object"
     },
+    "DescribeBackupRulesRequest": {
+      "document": "DescribeBackupRules请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "指定实例ID。例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。",
+          "example": "cmgo-7pjedvz7",
+          "member": "string",
+          "name": "InstanceId",
+          "required": true,
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "DescribeBackupRulesResponse": {
+      "document": "DescribeBackupRules返回参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "备份数据保留期限。单位为：天。",
+          "example": "7",
+          "member": "uint64",
+          "name": "BackupSaveTime",
+          "output_required": true,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "自动备份开始时间。",
+          "example": "1",
+          "member": "uint64",
+          "name": "BackupTime",
+          "output_required": true,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "备份方式。\n- 0：逻辑备份。\n- 1：物理备份。",
+          "example": "1",
+          "member": "uint64",
+          "name": "BackupMethod",
+          "output_required": true,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "DescribeClientConnectionsRequest": {
       "document": "DescribeClientConnections请求参数结构体",
       "members": [
@@ -2759,6 +2844,108 @@
       ],
       "type": "object"
     },
+    "DescribeTransparentDataEncryptionStatusRequest": {
+      "document": "DescribeTransparentDataEncryptionStatus请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "指定实例 ID。例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。",
+          "example": "\"cmgo-jyjcw8yv\"",
+          "member": "string",
+          "name": "InstanceId",
+          "required": true,
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "DescribeTransparentDataEncryptionStatusResponse": {
+      "document": "DescribeTransparentDataEncryptionStatus返回参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "表示是否开启了透明加密。 \n- close：未开启。\n- open：已开启。",
+          "example": "open或close",
+          "member": "string",
+          "name": "TransparentDataEncryptionStatus",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "已绑定的密钥列表，如未绑定，返回null。\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "无",
+          "member": "KMSInfoDetail",
+          "name": "KeyInfoList",
+          "output_required": false,
+          "type": "list",
+          "value_allowed_null": true
+        },
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "EnableTransparentDataEncryptionRequest": {
+      "document": "EnableTransparentDataEncryption请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "实例 ID，例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。目前支持通用版本包含：4.4、5.0，云盘版暂不支持。",
+          "example": "cmgo-p8vnipr5",
+          "member": "string",
+          "name": "InstanceId",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": " [密钥管理系统（Key Management Service，KMS）](https://cloud.tencent.com/document/product/573/18809)服务所在地域，例如 ap-shanghai。",
+          "example": "无",
+          "member": "string",
+          "name": "KmsRegion",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "密钥 ID。若不设置该参数，不指定具体的密钥 ID，由腾讯云自动生成密钥。",
+          "example": "无",
+          "member": "string",
+          "name": "KeyId",
+          "required": false,
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "EnableTransparentDataEncryptionResponse": {
+      "document": "EnableTransparentDataEncryption返回参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "开启透明加密的异步流程id，用于查询流程状态。",
+          "example": "无",
+          "member": "int64",
+          "name": "FlowId",
+          "output_required": false,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "FBKeyValue": {
       "document": "按key回档，用于筛选数据的键值对",
       "members": [
@@ -4142,6 +4329,78 @@
       ],
       "type": "object"
     },
+    "KMSInfoDetail": {
+      "document": "KMS密钥信息",
+      "members": [
+        {
+          "disabled": false,
+          "document": "主密钥 ID。\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "无",
+          "member": "string",
+          "name": "KeyId",
+          "output_required": false,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "主密钥名称。\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "无",
+          "member": "string",
+          "name": "KeyName",
+          "output_required": false,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "实例与密钥绑定时间。\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "无",
+          "member": "string",
+          "name": "CreateTime",
+          "output_required": false,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "密钥状态。\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "无",
+          "member": "string",
+          "name": "Status",
+          "output_required": false,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "密钥用途。\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "无",
+          "member": "string",
+          "name": "KeyUsage",
+          "output_required": false,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "密钥来源。\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "无",
+          "member": "string",
+          "name": "KeyOrigin",
+          "output_required": false,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": true
+        }
+      ],
+      "usage": "both"
+    },
     "KillOpsRequest": {
       "document": "KillOps请求参数结构体",
       "members": [
@@ -5045,6 +5304,69 @@
       ],
       "type": "object"
     },
+    "SetBackupRulesRequest": {
+      "document": "SetBackupRules请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "实例 ID，例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。",
+          "example": "cmgo-p8vnipr5",
+          "member": "string",
+          "name": "InstanceId",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "设置自动备份方式。- 0：逻辑备份。- 1：物理备份。-3：快照备份(仅云盘版支持)。",
+          "example": "1",
+          "member": "uint64",
+          "name": "BackupMethod",
+          "required": true,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "设置自动备份开始时间。取值范围为：[0,23]，例如：该参数设置为2，表示02:00开始备份。",
+          "example": "2",
+          "member": "uint64",
+          "name": "BackupTime",
+          "required": true,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "设置自动备份发生错误时，是否发送失败告警。\n- true：发送。\n- false：不发送。",
+          "example": "true",
+          "member": "bool",
+          "name": "Notify",
+          "required": false,
+          "type": "bool"
+        },
+        {
+          "disabled": false,
+          "document": "指定备份数据保存天数。默认为 7 天，支持设置为7、30、90、180、365。",
+          "example": "7",
+          "member": "uint64",
+          "name": "BackupRetentionPeriod",
+          "required": false,
+          "type": "int"
+        }
+      ],
+      "type": "object"
+    },
+    "SetBackupRulesResponse": {
+      "document": "SetBackupRules返回参数结构体",
+      "members": [
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "SetInstanceMaintenanceRequest": {
       "document": "SetInstanceMaintenance请求参数结构体",
       "members": [

tccli/services/mongodb/v20190725/examples.json

@@ -80,6 +80,14 @@
         "title": "查询备份下载任务"
       }
     ],
+    "DescribeBackupRules": [
+      {
+        "document": "查询实例的自动备份规则信息",
+        "input": "POST / HTTP/1.1\nHost: mongodb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeBackupRules\n<公共请求参数>\n\n{\n    \"InstanceId\": \"cmgo-9d0p****\"\n}",
+        "output": "{\n    \"Response\": {\n        \"BackupMethod\": 0,\n        \"BackupSaveTime\": 7,\n        \"BackupTime\": 1,\n        \"RequestId\": \"07ec4290-d682-11ed-aa06-f56fb86dae78\"\n    }\n}",
+        "title": "查询实例的自动备份规则信息"
+      }
+    ],
     "DescribeClientConnections": [
       {
         "document": "查询云数据库实例的客户端连接情况",
@@ -168,6 +176,22 @@
         "title": "查询云数据库售卖"
       }
     ],
+    "DescribeTransparentDataEncryptionStatus": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: mongodb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeTransparentDataEncryptionStatus\n<公共请求参数>\n\n{\n    \"InstanceId\": \"cmgo-igjysqkr\"\n}",
+        "output": "{\n    \"Response\": {\n        \"TransparentDataEncryptionStatus\": \"open\",\n        \"KeyInfoList\": [\n            {\n                \"KeyId\": \"abc\",\n                \"KeyName\": \"abc\",\n                \"CreateTime\": \"abc\",\n                \"Status\": \"abc\",\n                \"KeyUsage\": \"abc\",\n                \"KeyOrigin\": \"abc\"\n            }\n        ],\n        \"RequestId\": \"abc\"\n    }\n}",
+        "title": "获取当前实例是否已开启数据加密"
+      }
+    ],
+    "EnableTransparentDataEncryption": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: mongodb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: EnableTransparentDataEncryption\n<公共请求参数>\n\n{\n    \"InstanceId\": \"cmgo-igjysqkr\",\n    \"KmsRegion\": \"ap-guangzhou\",\n    \"KeyId\": \"abcabc\"\n}",
+        "output": "{\n    \"Response\": {\n        \"FlowId\": 0,\n        \"RequestId\": \"abcd\"\n    }\n}",
+        "title": "开启实例数据透明加密"
+      }
+    ],
     "FlashBackDBInstance": [
       {
         "document": "",
@@ -300,6 +324,14 @@
         "title": "为当前实例设置账号权限"
       }
     ],
+    "SetBackupRules": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: mongodb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: SetBackupRules\n<公共请求参数>\n\n{\n    \"InstanceId\": \"cmgo-abcede\",\n    \"BackupTime\": 22,\n    \"BackupMethod\": 1,\n    \"BackupRetentionPeriod\": 7,\n    \"Notify\": true\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"58f3a6a0-2330-11ef-ad75-7139c2c3f68c\"\n    }\n}",
+        "title": "设置实例的自动备份规则"
+      }
+    ],
     "SetInstanceMaintenance": [
       {
         "document": "修改实例维护时间窗口",

tccli/services/monitor/v20180724/api.json

@@ -526,7 +526,7 @@
       "status": "online"
     },
     "DescribePluginOverviews": {
-      "document": "列出可安装的所有 Grafana 插件",
+      "document": "列出可安装的所有 Grafana 插件。",
       "input": "DescribePluginOverviewsRequest",
       "name": "列出所有 Grafana 插件",
       "output": "DescribePluginOverviewsResponse",
@@ -659,11 +659,11 @@
       "status": "online"
     },
     "DescribePrometheusRecordRuleYaml": {
-      "document": "拉取Prometheus聚合规则yaml列表",
+      "document": "DescribePrometheusRecordRules 接口可完全代替该接口。近30天仅有3次调用，且都是报错请求\n\n拉取Prometheus聚合规则yaml列表",
       "input": "DescribePrometheusRecordRuleYamlRequest",
       "name": "拉取Prometheus聚合规则yaml列表",
       "output": "DescribePrometheusRecordRuleYamlResponse",
-      "status": "online"
+      "status": "deprecated"
     },
     "DescribePrometheusRecordRules": {
       "document": "获取聚合规则列表，包含关联集群内crd资源创建的record rule",
@@ -708,7 +708,7 @@
       "status": "online"
     },
     "DescribePrometheusZones": {
-      "document": "列出 Prometheus 服务可用区",
+      "document": "列出 Prometheus 服务可用区。",
       "input": "DescribePrometheusZonesRequest",
       "name": "列出 Prometheus 服务可用区",
       "output": "DescribePrometheusZonesResponse",
@@ -8792,7 +8792,7 @@
           "example": "[]",
           "member": "GrafanaPlugin",
           "name": "PluginSet",
-          "required": true,
+          "output_required": true,
           "type": "list",
           "value_allowed_null": false
         },
@@ -12660,6 +12660,7 @@
           "example": "无",
           "member": "PrometheusZoneItem",
           "name": "ZoneSet",
+          "output_required": true,
           "type": "list",
           "value_allowed_null": true
         },

tccli/services/monitor/v20180724/examples.json

@@ -974,7 +974,7 @@
       {
         "document": "列出 Prometheus 服务可用区",
         "input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribePrometheusZones\n<公共请求参数>\n\n{\n    \"RegionId\": \"1234\"\n}",
-        "output": "{\n    \"Response\": {\n        \"ZoneSet\": [\n            {\n                \"ZoneState\": 1,\n                \"ZoneName\": \"xx\",\n                \"RegionId\": 0,\n                \"Zone\": \"xx\",\n                \"ZoneId\": 160001\n            }\n        ],\n        \"RequestId\": \"xx\"\n    }\n}",
+        "output": "{\n    \"Response\": {\n        \"ZoneSet\": [\n            {\n                \"Zone\": \"abc\",\n                \"ZoneId\": 0,\n                \"ZoneState\": 0,\n                \"RegionId\": 0,\n                \"ZoneName\": \"abc\",\n                \"ZoneResourceState\": 0\n            }\n        ],\n        \"RequestId\": \"abc\"\n    }\n}",
         "title": "列出 Prometheus 服务可用区"
       }
     ],

tccli/services/tmt/v20180321/api.json

@@ -335,7 +335,7 @@
           "example": "session-00001",
           "member": "string",
           "name": "SessionUuid",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -345,7 +345,7 @@
           "example": "zh",
           "member": "string",
           "name": "Source",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -355,7 +355,7 @@
           "example": "en",
           "member": "string",
           "name": "Target",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -365,7 +365,7 @@
           "example": "无",
           "member": "ImageRecord",
           "name": "ImageRecord",
-          "required": true,
+          "output_required": true,
           "type": "object",
           "value_allowed_null": false
         },
@@ -477,6 +477,7 @@
           "example": "zh",
           "member": "string",
           "name": "Lang",
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },

tccli/services/trtc/v20190722/api.json

@@ -5845,7 +5845,7 @@
         },
         {
           "disabled": false,
-          "document": "云存储相关的参数，目前支持腾讯云对象存储，不支持第三方云存储以及VOD",
+          "document": "云存储相关的参数，目前支持腾讯云对象存储以及腾讯云云点播VOD，不支持第三方云存储",
           "example": "无",
           "member": "StorageParams",
           "name": "StorageParams",

tccli/services/tse/v20201207/api.json

@@ -9597,7 +9597,7 @@
           "example": "20",
           "member": "uint64",
           "name": "TotalCount",
-          "required": true,
+          "output_required": true,
           "type": "int",
           "value_allowed_null": false
         },
@@ -9607,7 +9607,7 @@
           "example": "无",
           "member": "ZookeeperServerInterface",
           "name": "Content",
-          "required": true,
+          "output_required": true,
           "type": "list",
           "value_allowed_null": false
         },

tccli/services/tse/v20201207/examples.json

@@ -673,8 +673,8 @@
     "DescribeZookeeperServerInterfaces": [
       {
         "document": "查询nacos服务接口列表",
-        "input": "POST / HTTP/1.1\nHost: tse.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeZookeeperServerInterfaces\n<公共请求参数>\n\n{\n    \"InstanceId\": \"xx\",\n    \"Limit\": 1,\n    \"Offset\": 1\n}",
-        "output": "{\n    \"Response\": {\n        \"Content\": [\n            {\n                \"Interface\": \"xx\"\n            }\n        ],\n        \"TotalCount\": 1,\n        \"RequestId\": \"xx\"\n    }\n}",
+        "input": "POST / HTTP/1.1\nHost: tse.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeZookeeperServerInterfaces\n<公共请求参数>\n\n{\n    \"InstanceId\": \"abc\",\n    \"Limit\": 1,\n    \"Offset\": 1\n}",
+        "output": "{\n    \"Response\": {\n        \"TotalCount\": 1,\n        \"Content\": [\n            {\n                \"Interface\": \"abc\"\n            }\n        ],\n        \"RequestId\": \"abc\"\n    }\n}",
         "title": "查询nacos服务接口列表"
       }
     ],