tccli-intl-en 3.0.1168.1__py2.py3-none-any.whl → 3.1.16.1__py2.py3-none-any.whl

tccli/services/csip/v20221121/examples.json

@@ -96,6 +96,22 @@
         "title": "Sample 1"
       }
     ],
+    "DescribeOrganizationInfo": [
+      {
+        "document": " Check group account details",
+        "input": "POST / HTTP/1.1\nHost: csip.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeOrganizationInfo\n<Common request parameters>\n\n{\n    \"MemberId\": [\n        \"mem-cn1***o24ca\"\n    ]\n}",
+        "output": "{\n    \"Response\": {\n        \"Data\": [\n            {\n                \"NickName\": \"Unnamed\",\n                \"NodeName\": \"Root\",\n                \"CFWProtect\": \"Ultimate\",\n                \"WAFProtect\": \"\",\n                \"CWPProtect\": \"Ultimate\",\n                \"Role\": \"admin\",\n                \"MemberId\": \"mem-625****c09**3c901\",\n                \"JoinType\": \"create\",\n                \"GroupName\": \"Unnamed\",\n                \"AdminName\": \"2027925252\",\n                \"AdminUin\": \"100014592178\",\n                \"CreateTime\": \"2023-04-11 10:47:07\",\n                \"MemberCreateTime\": \"2023-04-11 10:47:08\",\n                \"NodeCount\": 3,\n                \"MemberCount\": 19,\n                \"SubAccountCount\": 151,\n                \"AbnormalSubUserCount\": 14,\n                \"GroupPayMode\": 0,\n                \"MemberPayMode\": 0,\n                \"GroupPermission\": [\n                    \"\"\n                ],\n                \"MemberPermission\": [\n                    \"View Account\",\n                    \"Check balance\",\n                    \"Funds transfer\",\n                    \"Combined payment\",\n                    \"Invoicing\"\n                ],\n                \"Departments\": [\n                    \"Root\",\n                    \"Development Team\",\n                    \"Test Group\"\n                ],\n                \"CloudCountDesc\": [\n                    {\n                        \"CloudType\": 0,\n                        \"CloudCount\": 14,\n                        \"CloudDesc\": \"Cloud\"\n                    },\n                    {\n                        \"CloudType\": 1,\n                        \"CloudCount\": 5,\n                        \"CloudDesc\": \"AWS\"\n                    },\n                    {\n                        \"CloudType\": 2,\n                        \"CloudCount\": 2,\n                        \"CloudDesc\": \"Azure\"\n                    }\n                ],\n                \"EnableAdminCount\": 2,\n                \"AdminCount\": 2\n            }\n        ],\n        \"RequestId\": \"9c3abcf0-0860-4bd7-ae02-5825a8ee4638\",\n        \"TotalCount\": 1\n    }\n}",
+        "title": "Check group account details"
+      }
+    ],
+    "DescribeOrganizationUserInfo": [
+      {
+        "document": " Query group account user list",
+        "input": "POST / HTTP/1.1\nHost: csip.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeOrganizationUserInfo\n<Common request parameters>\n\n{\n    \"MemberId\": [\n        \"mem-5b28e2010c18f07a\"\n    ],\n    \"Filter\": {\n        \"Limit\": 10,\n        \"Offset\": 0,\n        \"Order\": \"SubUserCount\",\n        \"By\": \"desc\",\n        \"Filters\": [\n            {\n                \"Name\": \"NickName\",\n                \"Values\": [\n                    \"Andy\"\n                ],\n                \"OperatorType\": 7\n            }\n        ]\n    },\n    \"NotSupportCloud\": true\n}",
+        "output": "{\n    \"Response\": {\n        \"TotalCount\": 1,\n        \"Data\": [\n            {\n                \"Uin\": \"100014592178\",\n                \"AppId\": \"1302396000\",\n                \"NickName\": \"Andy\",\n                \"NodeName\": \"Root\",\n                \"CFWProtect\": \"Ultimate\",\n                \"WAFProtect\": \"Advanced\",\n                \"CWPProtect\": \"Ultimate\",\n                \"CSIPProtect\": \"Ultimate\",\n                \"Role\": \"admin\",\n                \"MemberId\": \"mem-68b8087a65268000\",\n                \"JoinType\": \"create\",\n                \"AssetCount\": 1235,\n                \"RiskCount\": 1599,\n                \"AttackCount\": 1839,\n                \"SubUserCount\": 11,\n                \"Enable\": 1,\n                \"QuotaConsumer\": 1,\n                \"CloudType\": 0,\n                \"PermissionList\": [\n                    \"readhost\"\n                ],\n                \"AuthType\": 0,\n                \"SyncFrequency\": 0,\n                \"IsExpired\": false,\n                \"TcMemberType\": 0,\n                \"JoinTypeInfo\": \"sub account\"\n            }\n        ],\n        \"JoinTypeLst\": [\n            {\n                \"Text\": \"Group Account\",\n                \"Value\": \"0\"\n            }\n        ],\n        \"RequestId\": \"f9184c15-9721-456d-8ca0-4263967b5ead\"\n    }\n}",
+        "title": "Query group account user list"
+      }
+    ],
     "DescribePublicIpAssets": [
       {
         "document": "",
@@ -192,6 +208,14 @@
         "title": "Example"
       }
     ],
+    "DescribeSubUserInfo": [
+      {
+        "document": "Query the group's sub-account list",
+        "input": "POST / HTTP/1.1\nHost: csip.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeSubUserInfo\n<Common request parameters>\n\n{\n    \"Filter\": {\n        \"Filters\": [\n            {\n                \"Name\": \"OwnerAppID\",\n                \"Values\": [\n                    \"1300448058\"\n                ],\n                \"OperatorType\": 7\n            }\n        ],\n        \"Limit\": 10,\n        \"Offset\": 0\n    }\n}",
+        "output": "{\n    \"Response\": {\n        \"CloudTypeLst\": [\n            {\n                \"Text\": \"Cloud\",\n                \"Value\": \"0\"\n            },\n            {\n                \"Text\": \"AWS\",\n                \"Value\": \"1\"\n            }\n        ],\n        \"Data\": [\n            {\n                \"ID\": 54673597,\n                \"AppID\": \"1330959198\",\n                \"Uin\": \"100040148813\",\n                \"NickName\": \"TC_20241224_Wez4\",\n                \"OwnerAppID\": \"1330***9198\",\n                \"OwnerUin\": \"1000***8855\",\n                \"OwnerNickName\": \"1000***78855\",\n                \"OwnerMemberID\": \"mem-tencent-59de5***9af64\",\n                \"CloudType\": 0,\n                \"ServiceCount\": 379,\n                \"InterfaceCount\": 38408,\n                \"AssetCount\": 1,\n                \"LogCount\": 0,\n                \"ConfigRiskCount\": 0,\n                \"ActionRiskCount\": 0,\n                \"IsAccessCloudAudit\": false,\n                \"IsAccessCheck\": true,\n                \"IsAccessUeba\": false\n            }\n        ],\n        \"OwnerAppIDLst\": [\n            {\n                \"Text\": \"aws-test-api-Cjhk\",\n                \"Value\": \"358***6334\"\n            },\n            {\n                \"Text\": \"TencentCSCSubAccount_20230904_7jpE4\",\n                \"Value\": \"6454***52***51\"\n            },\n            {\n                \"Text\": \"TC_20240510_J0Iz\",\n                \"Value\": \"6864***15099\"\n            },\n            {\n                \"Text\": \"TC_20240510_nZFQ\",\n                \"Value\": \"792***4186\"\n            },\n            {\n                \"Text\": \"TC_20241220_ekw3\",\n                \"Value\": \"9054***53255\"\n            }\n        ],\n        \"RequestId\": \"f711b4b6-ed7e-4cc3-8bde-9bba5732e551\",\n        \"TotalCount\": 151\n    }\n}",
+        "title": "Query the group's sub-account list"
+      }
+    ],
     "DescribeSubnetAssets": [
       {
         "document": "Example",

tccli/services/ctsdb/__init__.py

@@ -0,0 +1,4 @@
+# -*- coding: utf-8 -*-
+
+from tccli.services.ctsdb.ctsdb_client import action_caller
+    

tccli/services/ctsdb/ctsdb_client.py

@@ -0,0 +1,266 @@
+# -*- coding: utf-8 -*-
+import os
+import sys
+import six
+import json
+import tccli.options_define as OptionsDefine
+import tccli.format_output as FormatOutput
+from tccli import __version__
+from tccli.utils import Utils
+from tccli.exceptions import ConfigurationError, ClientError, ParamError
+from tencentcloud.common import credential
+from tencentcloud.common.profile.http_profile import HttpProfile
+from tencentcloud.common.profile.client_profile import ClientProfile
+from tencentcloud.ctsdb.v20230202 import ctsdb_client as ctsdb_client_v20230202
+from tencentcloud.ctsdb.v20230202 import models as models_v20230202
+
+from jmespath import search
+import time
+
+def doDescribeClusters(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="TC3-HMAC-SHA256")
+    if g_param[OptionsDefine.Language]:
+        profile.language = g_param[OptionsDefine.Language]
+    mod = CLIENT_MAP[g_param[OptionsDefine.Version]]
+    client = mod.CtsdbClient(cred, g_param[OptionsDefine.Region], profile)
+    client._sdkVersion += ("_CLI_" + __version__)
+    models = MODELS_MAP[g_param[OptionsDefine.Version]]
+    model = models.DescribeClustersRequest()
+    model.from_json_string(json.dumps(args))
+    start_time = time.time()
+    while True:
+        rsp = client.DescribeClusters(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 doDescribeDatabases(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="TC3-HMAC-SHA256")
+    if g_param[OptionsDefine.Language]:
+        profile.language = g_param[OptionsDefine.Language]
+    mod = CLIENT_MAP[g_param[OptionsDefine.Version]]
+    client = mod.CtsdbClient(cred, g_param[OptionsDefine.Region], profile)
+    client._sdkVersion += ("_CLI_" + __version__)
+    models = MODELS_MAP[g_param[OptionsDefine.Version]]
+    model = models.DescribeDatabasesRequest()
+    model.from_json_string(json.dumps(args))
+    start_time = time.time()
+    while True:
+        rsp = client.DescribeDatabases(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])
+
+
+CLIENT_MAP = {
+    "v20230202": ctsdb_client_v20230202,
+
+}
+
+MODELS_MAP = {
+    "v20230202": models_v20230202,
+
+}
+
+ACTION_MAP = {
+    "DescribeClusters": doDescribeClusters,
+    "DescribeDatabases": doDescribeDatabases,
+
+}
+
+AVAILABLE_VERSION_LIST = [
+    "v20230202",
+
+]
+
+
+def action_caller():
+    return ACTION_MAP
+
+
+def parse_global_arg(parsed_globals):
+    g_param = parsed_globals
+    cvm_role_flag = True
+    for param in parsed_globals.keys():
+        if param in [OptionsDefine.SecretKey, OptionsDefine.SecretId, OptionsDefine.RoleArn,
+                     OptionsDefine.RoleSessionName]:
+            if parsed_globals[param] is not None:
+                cvm_role_flag = False
+                break
+    is_exist_profile = True
+    if not parsed_globals["profile"]:
+        is_exist_profile = False
+        g_param["profile"] = os.environ.get("TCCLI_PROFILE", "default")
+
+    configure_path = os.path.join(os.path.expanduser("~"), ".tccli")
+    is_conf_exist, conf_path = Utils.file_existed(configure_path, g_param["profile"] + ".configure")
+    is_cred_exist, cred_path = Utils.file_existed(configure_path, g_param["profile"] + ".credential")
+
+    conf = {}
+    cred = {}
+
+    if is_conf_exist:
+        conf = Utils.load_json_msg(conf_path)
+    if is_cred_exist:
+        cred = Utils.load_json_msg(cred_path)
+
+    if not (isinstance(conf, dict) and isinstance(cred, dict)):
+        raise ConfigurationError(
+            "file: %s or %s is not json format"
+            % (g_param["profile"] + ".configure", g_param["profile"] + ".credential"))
+
+    if OptionsDefine.Token not in cred:
+        cred[OptionsDefine.Token] = None
+
+    if not is_exist_profile:
+        if os.environ.get(OptionsDefine.ENV_SECRET_ID) and os.environ.get(OptionsDefine.ENV_SECRET_KEY):
+            cred[OptionsDefine.SecretId] = os.environ.get(OptionsDefine.ENV_SECRET_ID)
+            cred[OptionsDefine.SecretKey] = os.environ.get(OptionsDefine.ENV_SECRET_KEY)
+            cred[OptionsDefine.Token] = os.environ.get(OptionsDefine.ENV_TOKEN)
+            cvm_role_flag = False
+
+        if os.environ.get(OptionsDefine.ENV_REGION):
+            conf[OptionsDefine.SysParam][OptionsDefine.Region] = os.environ.get(OptionsDefine.ENV_REGION)
+
+        if os.environ.get(OptionsDefine.ENV_ROLE_ARN) and os.environ.get(OptionsDefine.ENV_ROLE_SESSION_NAME):
+            cred[OptionsDefine.RoleArn] = os.environ.get(OptionsDefine.ENV_ROLE_ARN)
+            cred[OptionsDefine.RoleSessionName] = os.environ.get(OptionsDefine.ENV_ROLE_SESSION_NAME)
+            cvm_role_flag = False
+    
+    if cvm_role_flag:
+        if "type" in cred and cred["type"] == "cvm-role":
+            g_param[OptionsDefine.UseCVMRole.replace('-', '_')] = True
+
+    for param in g_param.keys():
+        if g_param[param] is None:
+            if param in [OptionsDefine.SecretKey, OptionsDefine.SecretId, OptionsDefine.Token]:
+                if param in cred:
+                    g_param[param] = cred[param]
+                elif not (g_param[OptionsDefine.UseCVMRole.replace('-', '_')]
+                          or os.getenv(OptionsDefine.ENV_TKE_ROLE_ARN)):
+                    raise ConfigurationError("%s is invalid" % param)
+            elif param in [OptionsDefine.Region, OptionsDefine.Output, OptionsDefine.Language]:
+                if param in conf[OptionsDefine.SysParam]:
+                    g_param[param] = conf[OptionsDefine.SysParam][param]
+                elif param != OptionsDefine.Language:
+                    raise ConfigurationError("%s is invalid" % param)
+            elif param.replace('_', '-') in [OptionsDefine.RoleArn, OptionsDefine.RoleSessionName]:
+                if param.replace('_', '-') in cred:
+                    g_param[param] = cred[param.replace('_', '-')]
+
+    try:
+        if g_param[OptionsDefine.ServiceVersion]:
+            g_param[OptionsDefine.Version] = "v" + g_param[OptionsDefine.ServiceVersion].replace('-', '')
+        else:
+            version = conf["ctsdb"][OptionsDefine.Version]
+            g_param[OptionsDefine.Version] = "v" + version.replace('-', '')
+
+        if g_param[OptionsDefine.Endpoint] is None:
+            g_param[OptionsDefine.Endpoint] = conf["ctsdb"][OptionsDefine.Endpoint]
+        g_param["sts_cred_endpoint"] = conf.get("sts", {}).get("endpoint")
+    except Exception as err:
+        raise ConfigurationError("config file:%s error, %s" % (conf_path, str(err)))
+
+    if g_param[OptionsDefine.Version] not in AVAILABLE_VERSION_LIST:
+        raise Exception("available versions: %s" % " ".join(AVAILABLE_VERSION_LIST))
+
+    if g_param[OptionsDefine.Waiter]:
+        param = eval(g_param[OptionsDefine.Waiter])
+        if 'expr' not in param:
+            raise Exception('`expr` in `--waiter` must be defined')
+        if 'to' not in param:
+            raise Exception('`to` in `--waiter` must be defined')
+        if 'timeout' not in param:
+            if 'waiter' in conf and 'timeout' in conf['waiter']:
+                param['timeout'] = conf['waiter']['timeout']
+            else:
+                param['timeout'] = 180
+        if 'interval' not in param:
+            if 'waiter' in conf and 'interval' in conf['waiter']:
+                param['interval'] = conf['waiter']['interval']
+            else:
+                param['interval'] = 5
+        param['interval'] = min(param['interval'], param['timeout'])
+        g_param['OptionsDefine.WaiterInfo'] = param
+
+    if six.PY2:
+        for key, value in g_param.items():
+            if isinstance(value, six.text_type):
+                g_param[key] = value.encode('utf-8')
+    return g_param
+