tccli 3.0.1156.1__py2.py3-none-any.whl → 3.0.1158.1__py2.py3-none-any.whl

tccli/services/mongodb/v20190725/api.json

@@ -42,6 +42,13 @@
       "output": "CreateDBInstanceHourResponse",
       "status": "online"
     },
+    "CreateDBInstanceParamTpl": {
+      "document": "本接口(CreateDBInstanceParamTpl)用于创建云数据库MongoDB实例的参数模板\n**说明：CreateDBInstanceParamTpl API正在公测中，在此期间，该接口仅对公测用户开放**",
+      "input": "CreateDBInstanceParamTplRequest",
+      "name": "创建数据库参数模板",
+      "output": "CreateDBInstanceParamTplResponse",
+      "status": "online"
+    },
     "DeleteAccountUser": {
       "document": "本接口（DeleteAccountUser）用于删除实例的自定义账号。",
       "input": "DeleteAccountUserRequest",
@@ -112,6 +119,20 @@
       "output": "DescribeDBInstanceNodePropertyResponse",
       "status": "online"
     },
+    "DescribeDBInstanceParamTpl": {
+      "document": "本接口(DescribeDBInstanceParamTpl )用于查询当前账号下所有MongoDB数据库参数模板\n**说明：DescribeDBInstanceParamTpl  API正在公测中，在此期间，该接口仅对公测用户开放**",
+      "input": "DescribeDBInstanceParamTplRequest",
+      "name": "查询实例参数模板列表",
+      "output": "DescribeDBInstanceParamTplResponse",
+      "status": "online"
+    },
+    "DescribeDBInstanceParamTplDetail": {
+      "document": "本接口(DescribeDBInstanceParamTplDetail )用于查询MongoDB云数据库实例的参数模板详情。\n**说明：DescribeDBInstanceParamTplDetail  API正在公测中，在此期间，该接口仅对公测用户开放**",
+      "input": "DescribeDBInstanceParamTplDetailRequest",
+      "name": "参数模板详情",
+      "output": "DescribeDBInstanceParamTplDetailResponse",
+      "status": "online"
+    },
     "DescribeDBInstances": {
       "document": "本接口（DescribeDBInstances）用于查询云数据库实例列表，支持通过项目ID、实例ID、实例状态等过滤条件来筛选主实例、灾备实例和只读实例信息列表。",
       "input": "DescribeDBInstancesRequest",
@@ -161,6 +182,13 @@
       "output": "DescribeTransparentDataEncryptionStatusResponse",
       "status": "online"
     },
+    "DropDBInstanceParamTpl": {
+      "document": "本接口(DropDBInstanceParamTpl )用于删除云数据库MongoDB实例的参数模板\n**说明：DropDBInstanceParamTpl  API正在公测中，在此期间，该接口仅对公测用户开放**",
+      "input": "DropDBInstanceParamTplRequest",
+      "name": "删除参数模板",
+      "output": "DropDBInstanceParamTplResponse",
+      "status": "online"
+    },
     "EnableTransparentDataEncryption": {
       "document": "本接口(EnableTransparentDataEncryption)用于开启云数据库 MongoDB 的透明加密能力。",
       "input": "EnableTransparentDataEncryptionRequest",
@@ -224,6 +252,13 @@
       "output": "ModifyDBInstanceNetworkAddressResponse",
       "status": "online"
     },
+    "ModifyDBInstanceParamTpl": {
+      "document": "本接口(ModifyDBInstanceParamTpl )用于修改MongoDB云数据库实例的参数模板。\n**说明：ModifyDBInstanceParamTpl  API正在公测中，在此期间，该接口仅对公测用户开放**",
+      "input": "ModifyDBInstanceParamTplRequest",
+      "name": "修改数据库参数模板",
+      "output": "ModifyDBInstanceParamTplResponse",
+      "status": "online"
+    },
     "ModifyDBInstanceSecurityGroup": {
       "document": "本接口（ModifyDBInstanceSecurityGroup）用于修改实例绑定的安全组",
       "input": "ModifyDBInstanceSecurityGroupRequest",
@@ -273,6 +308,13 @@
       "output": "ResetDBInstancePasswordResponse",
       "status": "online"
     },
+    "RestartNodes": {
+      "document": "本接口用于重启数据库节点。",
+      "input": "RestartNodesRequest",
+      "name": "重启数据库节点",
+      "output": "RestartNodesResponse",
+      "status": "online"
+    },
     "SetAccountUserPrivilege": {
       "document": "本接口（SetAccountUserPrivilege）用于设置实例的账号权限。",
       "input": "SetAccountUserPrivilegeRequest",
@@ -1125,6 +1167,15 @@
           "name": "HiddenZone",
           "required": false,
           "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "参数模板 ID。参数模板是一组 MongoDB 的参数并为预设置了参数值的集合，将一组有相同诉求的参数及值 存为模板，在创建实例时，可直接引用参数值到新实例。合理使用参数模板，可以提高MongoDB数据库的效率。模板列表从 DescribeDBInstanceParamTpl 接口获取，注意模板支持的版本。",
+          "example": "tpl-0vswufxag",
+          "member": "string",
+          "name": "ParamTemplateId",
+          "required": false,
+          "type": "string"
         }
       ],
       "type": "object"
@@ -1161,6 +1212,88 @@
       ],
       "type": "object"
     },
+    "CreateDBInstanceParamTplRequest": {
+      "document": "CreateDBInstanceParamTpl请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "参数模板名称。",
+          "example": "高性能模板",
+          "member": "string",
+          "name": "TplName",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "版本号，该参数模板支持的售卖版本请参照查询云数据库的售卖规格（DescribeSpecInfo）返回结果。参数与版本对应关系是：MONGO_36_WT：MongoDB 3.6 WiredTiger存储引擎版本，MONGO_40_WT：MongoDB 4.0 WiredTiger存储引擎版本，MONGO_42_WT：MongoDB 4.2 WiredTiger存储引擎版本。当MirrorTplId为空时，该字段必填。",
+          "example": "MONGO_42_WT",
+          "member": "string",
+          "name": "MongoVersion",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "实例类型，REPLSET-副本集，SHARD-分片集群，STANDALONE-单节点\n当MirrorTplId为空时，该字段必填。",
+          "example": "SHARD",
+          "member": "string",
+          "name": "ClusterType",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "模板描述信息。",
+          "example": "用于压测场景",
+          "member": "string",
+          "name": "TplDesc",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "模板参数，若为空，则以系统默认模板作为新版本参数。",
+          "example": "无",
+          "member": "ParamType",
+          "name": "Params",
+          "required": false,
+          "type": "list"
+        },
+        {
+          "disabled": false,
+          "document": "镜像模板ID，若该字段不为空，则以该模板为镜像，克隆出一个新的模板。注意：MirrorTplId不为空时，MongoVersion及ClusterType将以MirrorTpl模板的版本及实例类型为准。",
+          "example": "tpl-sdah144hg",
+          "member": "string",
+          "name": "MirrorTplId",
+          "required": false,
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "CreateDBInstanceParamTplResponse": {
+      "document": "CreateDBInstanceParamTpl返回参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "模板ID",
+          "example": "tpl-sdah144hg",
+          "member": "string",
+          "name": "TplId",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "CreateDBInstanceRequest": {
       "document": "CreateDBInstance请求参数结构体",
       "members": [
@@ -1424,6 +1557,15 @@
           "name": "HiddenZone",
           "required": false,
           "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "参数模板 ID。参数模板是一组 MongoDB 的参数并为预设置了参数值的集合，将一组有相同诉求的参数及值 存为模板，在创建实例时，可直接引用参数值到新实例。合理使用参数模板，可以提高MongoDB数据库的效率。模板列表从 DescribeDBInstanceParamTpl 接口获取，注意模板支持的版本及实例类型。",
+          "example": "tpl-0vswufxag",
+          "member": "string",
+          "name": "ParamTemplateId",
+          "required": false,
+          "type": "string"
         }
       ],
       "type": "object"
@@ -2367,6 +2509,196 @@
       ],
       "type": "object"
     },
+    "DescribeDBInstanceParamTplDetailRequest": {
+      "document": "DescribeDBInstanceParamTplDetail请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "参数模板 ID。",
+          "example": "tpl-sdvj2jh4k",
+          "member": "string",
+          "name": "TplId",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "参数名称，传入该值，则只会获取该字段的参数详情。为空时，返回全部参数。",
+          "example": "operationProfiling.mode",
+          "member": "string",
+          "name": "ParamName",
+          "required": false,
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "DescribeDBInstanceParamTplDetailResponse": {
+      "document": "DescribeDBInstanceParamTplDetail返回参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "枚举类参数详情列表。\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "无",
+          "member": "InstanceEnumParam",
+          "name": "InstanceEnumParams",
+          "output_required": true,
+          "type": "list",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "整形参数详情列表。\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "无",
+          "member": "InstanceIntegerParam",
+          "name": "InstanceIntegerParams",
+          "output_required": true,
+          "type": "list",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "文本参数详情列表。\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "无",
+          "member": "InstanceTextParam",
+          "name": "InstanceTextParams",
+          "output_required": true,
+          "type": "list",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "多值参数详情列表。\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "无",
+          "member": "InstanceMultiParam",
+          "name": "InstanceMultiParams",
+          "output_required": true,
+          "type": "list",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "参数总个数。\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "无",
+          "member": "int64",
+          "name": "TotalCount",
+          "output_required": true,
+          "type": "int",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "模板适配实例版本。\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "MONGO_50_WT",
+          "member": "string",
+          "name": "MongoVersion",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "模板适配集群类型，副本集或分片。。\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "SHARD",
+          "member": "string",
+          "name": "ClusterType",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "参数模板名称。\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "test",
+          "member": "string",
+          "name": "TplName",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "DescribeDBInstanceParamTplRequest": {
+      "document": "DescribeDBInstanceParamTpl请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "参数模板 ID 查询条件。",
+          "example": "[\"tpl-sdjf143qu\"]",
+          "member": "string",
+          "name": "TplIds",
+          "required": false,
+          "type": "list"
+        },
+        {
+          "disabled": false,
+          "document": "模板名称，查询条件。",
+          "example": "[\"test\"]",
+          "member": "string",
+          "name": "TplNames",
+          "required": false,
+          "type": "list"
+        },
+        {
+          "disabled": false,
+          "document": "根据版本号插叙参数模板，具体支持的售卖版本请参照查询云数据库的售卖规格（DescribeSpecInfo）返回结果。参数与版本对应关系是：MONGO_36_WT：MongoDB 3.6 WiredTiger存储引擎版本，MONGO_40_WT：MongoDB 4.0 WiredTiger存储引擎版本，MONGO_42_WT：MongoDB 4.2 WiredTiger存储引擎版本。",
+          "example": "[\"MONGO_42_WT\"]",
+          "member": "string",
+          "name": "MongoVersion",
+          "required": false,
+          "type": "list"
+        },
+        {
+          "disabled": false,
+          "document": "根据模板类型查询参数模板，支持DEFAULT（默认模板）和CUSTOMIZE（自定义模板）两种。",
+          "example": "CUSTOMIZE",
+          "member": "string",
+          "name": "TplType",
+          "required": false,
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "DescribeDBInstanceParamTplResponse": {
+      "document": "DescribeDBInstanceParamTpl返回参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "参数模板列表信息。\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "无",
+          "member": "ParamTpl",
+          "name": "ParamTpls",
+          "output_required": true,
+          "type": "list",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "参数模板总数。\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "无",
+          "member": "uint64",
+          "name": "TotalCount",
+          "output_required": true,
+          "type": "int",
+          "value_allowed_null": true
+        },
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "DescribeDBInstancesRequest": {
       "document": "DescribeDBInstances请求参数结构体",
       "members": [
@@ -2928,6 +3260,33 @@
       ],
       "type": "object"
     },
+    "DropDBInstanceParamTplRequest": {
+      "document": "DropDBInstanceParamTpl请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "参数模板 ID。",
+          "example": "tpl-djtuhy1d",
+          "member": "string",
+          "name": "TplId",
+          "required": true,
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "DropDBInstanceParamTplResponse": {
+      "document": "DropDBInstanceParamTpl返回参数结构体",
+      "members": [
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "EnableTransparentDataEncryptionRequest": {
       "document": "EnableTransparentDataEncryption请求参数结构体",
       "members": [
@@ -4547,6 +4906,60 @@
       ],
       "type": "object"
     },
+    "ModifyDBInstanceParamTplRequest": {
+      "document": "ModifyDBInstanceParamTpl请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "待修改的参数模板 ID，示例：tpl-jglr91vew。",
+          "example": "tpl-sdh134udi",
+          "member": "string",
+          "name": "TplId",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "待修改参数模板名称，为空时，保持原有名称。",
+          "example": "压测模板",
+          "member": "string",
+          "name": "TplName",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "待修改参数模板描述，为空时，保持原有描述。",
+          "example": "用于压测",
+          "member": "string",
+          "name": "TplDesc",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "待修改参数名及参数值，为空时，各参数保持原有值，支持单条或批量修改。",
+          "example": "无",
+          "member": "ParamType",
+          "name": "Params",
+          "required": false,
+          "type": "list"
+        }
+      ],
+      "type": "object"
+    },
+    "ModifyDBInstanceParamTplResponse": {
+      "document": "ModifyDBInstanceParamTpl返回参数结构体",
+      "members": [
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "ModifyDBInstanceSecurityGroupRequest": {
       "document": "ModifyDBInstanceSecurityGroup请求参数结构体",
       "members": [
@@ -5031,6 +5444,98 @@
       ],
       "usage": "in"
     },
+    "ParamTpl": {
+      "document": "数据库参数模板",
+      "members": [
+        {
+          "disabled": false,
+          "document": "参数模板名称",
+          "example": "压测参数模板",
+          "member": "string",
+          "name": "TplName",
+          "required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "参数模板ID",
+          "example": "tpl-adh42hg1y",
+          "member": "string",
+          "name": "TplId",
+          "required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "适用数据库版本",
+          "example": "MONGO_42_WT",
+          "member": "string",
+          "name": "MongoVersion",
+          "required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "适用数据库类型",
+          "example": "SHARD",
+          "member": "string",
+          "name": "ClusterType",
+          "required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "参数模板描述",
+          "example": "用于压测",
+          "member": "string",
+          "name": "TplDesc",
+          "required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "模板类型，包括DEFAULT（默认模板）及CUSTOMIZE（定制模板）两种类型",
+          "example": "DEFAULT",
+          "member": "string",
+          "name": "TplType",
+          "required": true,
+          "type": "string",
+          "value_allowed_null": false
+        }
+      ],
+      "usage": "out"
+    },
+    "ParamType": {
+      "document": "数据库参数",
+      "members": [
+        {
+          "disabled": false,
+          "document": "参数",
+          "example": "balance.window",
+          "member": "string",
+          "name": "Key",
+          "required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "参数值",
+          "example": "1|2",
+          "member": "string",
+          "name": "Value",
+          "required": true,
+          "type": "string",
+          "value_allowed_null": false
+        }
+      ],
+      "usage": "both"
+    },
     "RemoveNodeList": {
       "document": "修改实例节点详情",
       "members": [
@@ -5223,6 +5728,52 @@
       ],
       "type": "object"
     },
+    "RestartNodesRequest": {
+      "document": "RestartNodes请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "实例ID，格式如：cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同。",
+          "example": "cmgo-p8vnipr5",
+          "member": "string",
+          "name": "InstanceId",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "节点Id。",
+          "example": "[\"cmgo-6heje4jp_0-node-slave0\",\"cmgo-6heje4jp_1-node-slave0\"]",
+          "member": "string",
+          "name": "NodeIds",
+          "required": true,
+          "type": "list"
+        }
+      ],
+      "type": "object"
+    },
+    "RestartNodesResponse": {
+      "document": "RestartNodes返回参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "流程Id。",
+          "example": "2313431",
+          "member": "int64",
+          "name": "FlowId",
+          "required": true,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "SecurityGroup": {
       "document": "安全组信息",
       "members": [