tccli-intl-en 3.0.1274.1__py2.py3-none-any.whl → 3.0.1276.1__py2.py3-none-any.whl

tccli/services/mongodb/mongodb_client.py

@@ -69,6 +69,58 @@ def doTerminateDBInstances(args, parsed_globals):
     FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
 
 
+def doDescribeDBInstanceNodeProperty(args, parsed_globals):
+    g_param = parse_global_arg(parsed_globals)
+
+    if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
+        cred = credential.CVMRoleCredential()
+    elif g_param[OptionsDefine.RoleArn.replace('-', '_')] and g_param[OptionsDefine.RoleSessionName.replace('-', '_')]:
+        cred = credential.STSAssumeRoleCredential(
+            g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.RoleArn.replace('-', '_')],
+            g_param[OptionsDefine.RoleSessionName.replace('-', '_')], endpoint=g_param["sts_cred_endpoint"]
+        )
+    elif os.getenv(OptionsDefine.ENV_TKE_REGION)             and os.getenv(OptionsDefine.ENV_TKE_PROVIDER_ID)             and os.getenv(OptionsDefine.ENV_TKE_WEB_IDENTITY_TOKEN_FILE)             and os.getenv(OptionsDefine.ENV_TKE_ROLE_ARN):
+        cred = credential.DefaultTkeOIDCRoleArnProvider().get_credentials()
+    else:
+        cred = credential.Credential(
+            g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.Token]
+        )
+    http_profile = HttpProfile(
+        reqTimeout=60 if g_param[OptionsDefine.Timeout] is None else int(g_param[OptionsDefine.Timeout]),
+        reqMethod="POST",
+        endpoint=g_param[OptionsDefine.Endpoint],
+        proxy=g_param[OptionsDefine.HttpsProxy.replace('-', '_')]
+    )
+    profile = ClientProfile(httpProfile=http_profile, signMethod="HmacSHA256")
+    if g_param[OptionsDefine.Language]:
+        profile.language = g_param[OptionsDefine.Language]
+    mod = CLIENT_MAP[g_param[OptionsDefine.Version]]
+    client = mod.MongodbClient(cred, g_param[OptionsDefine.Region], profile)
+    client._sdkVersion += ("_CLI_" + __version__)
+    models = MODELS_MAP[g_param[OptionsDefine.Version]]
+    model = models.DescribeDBInstanceNodePropertyRequest()
+    model.from_json_string(json.dumps(args))
+    start_time = time.time()
+    while True:
+        rsp = client.DescribeDBInstanceNodeProperty(model)
+        result = rsp.to_json_string()
+        try:
+            json_obj = json.loads(result)
+        except TypeError as e:
+            json_obj = json.loads(result.decode('utf-8'))  # python3.3
+        if not g_param[OptionsDefine.Waiter] or search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj) == g_param['OptionsDefine.WaiterInfo']['to']:
+            break
+        cur_time = time.time()
+        if cur_time - start_time >= g_param['OptionsDefine.WaiterInfo']['timeout']:
+            raise ClientError('Request timeout, wait `%s` to `%s` timeout, last request is %s' %
+            (g_param['OptionsDefine.WaiterInfo']['expr'], g_param['OptionsDefine.WaiterInfo']['to'],
+            search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj)))
+        else:
+            print('Inquiry result is %s.' % search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj))
+        time.sleep(g_param['OptionsDefine.WaiterInfo']['interval'])
+    FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
+
+
 def doDescribeDBInstanceDeal(args, parsed_globals):
     g_param = parse_global_arg(parsed_globals)
 
@@ -1693,6 +1745,7 @@ MODELS_MAP = {
 
 ACTION_MAP = {
     "TerminateDBInstances": doTerminateDBInstances,
+    "DescribeDBInstanceNodeProperty": doDescribeDBInstanceNodeProperty,
     "DescribeDBInstanceDeal": doDescribeDBInstanceDeal,
     "DescribeDBInstanceNamespace": doDescribeDBInstanceNamespace,
     "DescribeClientConnections": doDescribeClientConnections,

tccli/services/mongodb/v20190725/api.json

@@ -77,6 +77,13 @@
       "output": "DescribeDBInstanceNamespaceResponse",
       "status": "online"
     },
+    "DescribeDBInstanceNodeProperty": {
+      "document": "This API is used to query node attributes, such as the AZ, node name, address, role, status, delay between primary and secondary nodes, priority, voting right, and tags.",
+      "input": "DescribeDBInstanceNodePropertyRequest",
+      "name": "Queries node attributes",
+      "output": "DescribeDBInstanceNodePropertyResponse",
+      "status": "online"
+    },
     "DescribeDBInstances": {
       "document": "This API is used to query the list of TencentDB for MongoDB instances. It supports filtering primary instances, disaster recovery instances, and read-only instances by project ID, instance ID, instance status, and other conditions.",
       "input": "DescribeDBInstancesRequest",
@@ -1835,6 +1842,107 @@
       ],
       "type": "object"
     },
+    "DescribeDBInstanceNodePropertyRequest": {
+      "document": "DescribeDBInstanceNodeProperty request structure.",
+      "members": [
+        {
+          "disabled": false,
+          "document": "Instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list.",
+          "example": "cmgo-p8vnipr5",
+          "member": "string",
+          "name": "InstanceId",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "Node ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), go to Node Management, and copy the node ID.",
+          "example": "[\"cmgo-6heje4jp_0-node-slave0\",\"cmgo-6heje4jp_1-node-slave0\"]",
+          "member": "string",
+          "name": "NodeIds",
+          "required": false,
+          "type": "list"
+        },
+        {
+          "disabled": false,
+          "document": "Node role. Valid values:\n- PRIMARY: primary node.\n- SECONDARY: secondary node.\n- READONLY: read-only node.\n- ARBITER: arbitration node.",
+          "example": "[\"PRIMARY\"]",
+          "member": "string",
+          "name": "Roles",
+          "required": false,
+          "type": "list"
+        },
+        {
+          "disabled": false,
+          "document": "Whether the node is a hidden node. Default value: false.",
+          "example": "false",
+          "member": "bool",
+          "name": "OnlyHidden",
+          "required": false,
+          "type": "bool"
+        },
+        {
+          "disabled": false,
+          "document": "Priority of the node for electing it as the new primary node. Value range: [0, 100]. A larger value indicates a higher priority.",
+          "example": "10",
+          "member": "int64",
+          "name": "Priority",
+          "required": false,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "Node voting right.- 1: The node has the right to vote.\n- 0: The node does not have the right to vote.",
+          "example": "1",
+          "member": "int64",
+          "name": "Votes",
+          "required": false,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "Node tag.",
+          "example": "无",
+          "member": "NodeTag",
+          "name": "Tags",
+          "required": false,
+          "type": "list"
+        }
+      ],
+      "type": "object"
+    },
+    "DescribeDBInstanceNodePropertyResponse": {
+      "document": "DescribeDBInstanceNodeProperty response structure.",
+      "members": [
+        {
+          "disabled": false,
+          "document": "Mongos node attributes.",
+          "example": "无",
+          "member": "NodeProperty",
+          "name": "Mongos",
+          "output_required": false,
+          "type": "list",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Replica set node information.",
+          "example": "无",
+          "member": "ReplicateSetInfo",
+          "name": "ReplicateSets",
+          "output_required": true,
+          "type": "list",
+          "value_allowed_null": false
+        },
+        {
+          "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "DescribeDBInstancesRequest": {
       "document": "DescribeDBInstances request structure.",
       "members": [
@@ -3967,6 +4075,160 @@
       ],
       "usage": "in"
     },
+    "NodeProperty": {
+      "document": "Node attributes.",
+      "members": [
+        {
+          "disabled": false,
+          "document": "Node AZ.",
+          "example": "ap-guangzhou-1",
+          "member": "string",
+          "name": "Zone",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Node name.",
+          "example": "cmgo-ocdv****_0-node-primary",
+          "member": "string",
+          "name": "NodeName",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Node access address.",
+          "example": "10.4.0.7:30000",
+          "member": "string",
+          "name": "Address",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Public network access address (IP address or domain name) of the node. The example value is an IP address.",
+          "example": "113.0.**.**:27017",
+          "member": "string",
+          "name": "WanServiceAddress",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Node role.\n- PRIMARY: primary node.\n- SECONDARY: secondary node.\n- READONLY: read-only node.\n- ARBITER: arbitration node.",
+          "example": "PRIMARY",
+          "member": "string",
+          "name": "Role",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Whether the node is a hidden node.\n- true: a hidden node.\n- false: not a hidden node.",
+          "example": "false",
+          "member": "bool",
+          "name": "Hidden",
+          "output_required": false,
+          "type": "bool",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Node status.\n- NORMAL: running normally.\n- STARTUP: starting.\n- STARTUP2: starting and processing the intermediate data.\n- RECOVERING: recovering and not available.\n- DOWN: offline.\n- UNKNOWN: unknown status.\n- ROLLBACK: rolling back.\n- REMOVED: removed.",
+          "example": "NORMAL",
+          "member": "string",
+          "name": "Status",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Delay time of primary-secondary synchronization, in seconds.",
+          "example": "1",
+          "member": "int64",
+          "name": "SlaveDelay",
+          "output_required": false,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Node priority. Value range: [0, 100]. A larger value indicates a higher priority.",
+          "example": "10",
+          "member": "int64",
+          "name": "Priority",
+          "output_required": false,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Node voting right.\n- 1: The node has the right to vote.\n- 0: The node does not have the right to vote.",
+          "example": "1",
+          "member": "int64",
+          "name": "Votes",
+          "output_required": false,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Node tag.\nNote: This field may return null, indicating that no valid values can be obtained.",
+          "example": "[{\"TagKey\":\"role-cmgo\",\"TagValue\":\"primary-secondary-group\"}]",
+          "member": "NodeTag",
+          "name": "Tags",
+          "output_required": false,
+          "type": "list",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "Replica set ID.",
+          "example": "cmgo-ocdv****_0",
+          "member": "string",
+          "name": "ReplicateSetId",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        }
+      ],
+      "usage": "out"
+    },
+    "NodeTag": {
+      "document": "Node tag.",
+      "members": [
+        {
+          "disabled": false,
+          "document": "Node tag key.",
+          "example": "testKey",
+          "member": "string",
+          "name": "TagKey",
+          "output_required": false,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Node tag value.",
+          "example": "testValue",
+          "member": "string",
+          "name": "TagValue",
+          "output_required": false,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": false
+        }
+      ],
+      "usage": "both"
+    },
     "OfflineIsolatedDBInstanceRequest": {
       "document": "OfflineIsolatedDBInstance request structure.",
       "members": [
@@ -4124,6 +4386,22 @@
       ],
       "usage": "in"
     },
+    "ReplicateSetInfo": {
+      "document": "Replica set information.",
+      "members": [
+        {
+          "disabled": false,
+          "document": "Node attributes.",
+          "example": "无",
+          "member": "NodeProperty",
+          "name": "Nodes",
+          "output_required": false,
+          "type": "list",
+          "value_allowed_null": false
+        }
+      ],
+      "usage": "out"
+    },
     "ResetDBInstancePasswordRequest": {
       "document": "ResetDBInstancePassword request structure.",
       "members": [

tccli/services/mongodb/v20190725/examples.json

@@ -94,6 +94,14 @@
         "title": "Querying All Collections of the Specified Database"
       }
     ],
+    "DescribeDBInstanceNodeProperty": [
+      {
+        "document": "This example shows you how to query the detailed attributes of an instance node.",
+        "input": "POST / HTTP/1.1\nHost: mongodb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDBInstanceNodeProperty\n<Common request parameters>\n\n{\n    \"InstanceId\": \"cmgo-by909vwp\"\n}",
+        "output": "{\n    \"Response\": {\n        \"Mongos\": [\n            {\n                \"Address\": \"10.8.16.37:30000\",\n                \"Hidden\": false,\n                \"NodeName\": \"mongos-0\",\n                \"Priority\": 0,\n                \"ReplicateSetId\": \"\",\n                \"Role\": \"MONGOS\",\n                \"SlaveDelay\": 0,\n                \"Status\": \"NORMAL\",\n                \"Tags\": [\n                    {\n                        \"TagKey\": \"role-cmgo\",\n                        \"TagValue\": \"primary-secondary-group\"\n                    }\n                ],\n                \"Votes\": 0,\n                \"Zone\": \"ap-guangzhou-3\",\n                \"WanServiceAddress\": \"\"\n            }\n        ],\n        \"ReplicateSets\": [\n            {\n                \"Nodes\": [\n                    {\n                        \"Address\": \"\",\n                        \"Hidden\": false,\n                        \"NodeName\": \"cmgo-by909vwp_0-node-slave0\",\n                        \"Priority\": 1,\n                        \"ReplicateSetId\": \"cmgo-by909vwp_0\",\n                        \"Role\": \"SECONDARY\",\n                        \"SlaveDelay\": 0,\n                        \"Status\": \"NORMAL\",\n                        \"WanServiceAddress\": \"\",\n                        \"Tags\": [\n                            {\n                                \"TagKey\": \"role-cmgo\",\n                                \"TagValue\": \"primary-secondary-group\"\n                            }\n                        ],\n                        \"Votes\": 1,\n                        \"Zone\": \"ap-guangzhou-3\"\n                    }\n                ]\n            },\n            {\n                \"Nodes\": [\n                    {\n                        \"Address\": \"\",\n                        \"Hidden\": false,\n                        \"NodeName\": \"cmgo-by909vwp_1-node-slave0\",\n                        \"Priority\": 1,\n                        \"ReplicateSetId\": \"cmgo-by909vwp_1\",\n                        \"Role\": \"SECONDARY\",\n                        \"SlaveDelay\": 0,\n                        \"Status\": \"NORMAL\",\n                        \"WanServiceAddress\": \"\",\n                        \"Tags\": [\n                            {\n                                \"TagKey\": \"role-cmgo\",\n                                \"TagValue\": \"primary-secondary-group\"\n                            }\n                        ],\n                        \"Votes\": 1,\n                        \"Zone\": \"ap-guangzhou-3\"\n                    },\n                    {\n                        \"Address\": \"\",\n                        \"Hidden\": false,\n                        \"NodeName\": \"cmgo-by909vwp_1-node-primary\",\n                        \"Priority\": 1,\n                        \"ReplicateSetId\": \"cmgo-by909vwp_1\",\n                        \"Role\": \"PRIMARY\",\n                        \"SlaveDelay\": 0,\n                        \"Status\": \"NORMAL\",\n                        \"WanServiceAddress\": \"\",\n                        \"Tags\": [\n                            {\n                                \"TagKey\": \"role-cmgo\",\n                                \"TagValue\": \"primary-secondary-group\"\n                            }\n                        ],\n                        \"Votes\": 1,\n                        \"Zone\": \"ap-guangzhou-3\"\n                    },\n                    {\n                        \"Address\": \"\",\n                        \"Hidden\": true,\n                        \"NodeName\": \"cmgo-by909vwp_1-node-slave1\",\n                        \"Priority\": 0,\n                        \"ReplicateSetId\": \"cmgo-by909vwp_1\",\n                        \"Role\": \"SECONDARY\",\n                        \"SlaveDelay\": 0,\n                        \"Status\": \"NORMAL\",\n                        \"WanServiceAddress\": \"\",\n                        \"Tags\": [\n                            {\n                                \"TagKey\": \"role-cmgo\",\n                                \"TagValue\": \"primary-secondary-group\"\n                            }\n                        ],\n                        \"Votes\": 1,\n                        \"Zone\": \"ap-guangzhou-3\"\n                    }\n                ]\n            }\n        ],\n        \"RequestId\": \"14ab088a-9d69-44b4-b39d-e4b8fbbb8f25\"\n    }\n}",
+        "title": "Querying the Information on an Instance Node"
+      }
+    ],
     "DescribeDBInstances": [
       {
         "document": "Query Instance List",