tccli-intl-en 3.0.1188.1__py2.py3-none-any.whl → 3.1.28.1__py2.py3-none-any.whl

tccli/services/cdz/cdz_client.py

@@ -0,0 +1,210 @@
+# -*- 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.cdz.v20221123 import cdz_client as cdz_client_v20221123
+from tencentcloud.cdz.v20221123 import models as models_v20221123
+
+from jmespath import search
+import time
+
+def doDescribeCloudDedicatedZoneResourceSummary(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.CdzClient(cred, g_param[OptionsDefine.Region], profile)
+    client._sdkVersion += ("_CLI_" + __version__)
+    models = MODELS_MAP[g_param[OptionsDefine.Version]]
+    model = models.DescribeCloudDedicatedZoneResourceSummaryRequest()
+    model.from_json_string(json.dumps(args))
+    start_time = time.time()
+    while True:
+        rsp = client.DescribeCloudDedicatedZoneResourceSummary(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 = {
+    "v20221123": cdz_client_v20221123,
+
+}
+
+MODELS_MAP = {
+    "v20221123": models_v20221123,
+
+}
+
+ACTION_MAP = {
+    "DescribeCloudDedicatedZoneResourceSummary": doDescribeCloudDedicatedZoneResourceSummary,
+
+}
+
+AVAILABLE_VERSION_LIST = [
+    "v20221123",
+
+]
+
+
+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["cdz"][OptionsDefine.Version]
+            g_param[OptionsDefine.Version] = "v" + version.replace('-', '')
+
+        if g_param[OptionsDefine.Endpoint] is None:
+            g_param[OptionsDefine.Endpoint] = conf["cdz"][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
+

tccli/services/cdz/v20221123/api.json

@@ -0,0 +1,233 @@
+{
+  "actions": {
+    "DescribeCloudDedicatedZoneResourceSummary": {
+      "document": "This API is used to query resource usage of each vertical product in Cloud Dedicated Zone.",
+      "input": "DescribeCloudDedicatedZoneResourceSummaryRequest",
+      "name": "Query CDZ resource utilization overview",
+      "output": "DescribeCloudDedicatedZoneResourceSummaryResponse",
+      "status": "online"
+    }
+  },
+  "metadata": {
+    "apiVersion": "2022-11-23",
+    "serviceNameCN": "专属可用区",
+    "serviceShortName": "cdz"
+  },
+  "objects": {
+    "CloudDedicatedZoneResourceStatisticsInfo": {
+      "document": "Details of the queried data for the statistical item of the CDZ resource, corresponding to a specific vertical product resource statistics.",
+      "members": [
+        {
+          "disabled": false,
+          "document": "Specifies the item name of resource statistics.",
+          "example": "CPU",
+          "member": "string",
+          "name": "Item",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Resource statistics item measurement unit.",
+          "example": "核",
+          "member": "string",
+          "name": "Unit",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Total resource amount.",
+          "example": "300",
+          "member": "string",
+          "name": "Total",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Used resources.",
+          "example": "16",
+          "member": "string",
+          "name": "Usage",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Specifies the percentage of used resources.",
+          "example": "5.33%",
+          "member": "string",
+          "name": "UsageRate",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Remaining resource.",
+          "example": "284",
+          "member": "string",
+          "name": "Remain",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Remaining resource percentage.",
+          "example": "94.67%",
+          "member": "string",
+          "name": "RemainRate",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Resource utilization rate at midnight this monday.",
+          "example": "17.29%",
+          "member": "string",
+          "name": "ThisMondayUsageRate",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Resource growth rate this week.",
+          "example": "0.50%",
+          "member": "string",
+          "name": "ThisMondayUsageGrowthRate",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Resource growth rate last week.",
+          "example": "-0.12%",
+          "member": "string",
+          "name": "LastMondayUsageGrowthRate",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        }
+      ],
+      "usage": "out"
+    },
+    "CloudDedicatedZoneResourceSummaryInfo": {
+      "document": "Details of the CDZ resource water level, corresponding to a specific vertical product.",
+      "members": [
+        {
+          "disabled": false,
+          "document": "Product name",
+          "example": "云服务器",
+          "member": "string",
+          "name": "ProductName",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Subproduct name",
+          "example": "标准型S5",
+          "member": "string",
+          "name": "SubProductName",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Statistical detail of the resource.",
+          "example": "[     {         \"Item\": \"CPU\",         \"ItemEn\": \"CPU\",         \"Unit\": \"核\",         \"UnitEn\": \"核\",         \"Total\": \"28160\",         \"Usage\": \"27920\",         \"UsageRate\": \"99.15%\",         \"Remain\": \"240\",         \"RemainRate\": \"0.85%\",         \"ThisMondayUsageRate\": \"99.15%\",         \"ThisMondayUsageGrowthRate\": \"0.00%\",         \"LastMondayUsageGrowthRate\": \"0.00%\"     } ]",
+          "member": "CloudDedicatedZoneResourceStatisticsInfo",
+          "name": "Statistics",
+          "output_required": false,
+          "type": "list",
+          "value_allowed_null": false
+        }
+      ],
+      "usage": "out"
+    },
+    "DescribeCloudDedicatedZoneResourceSummaryRequest": {
+      "document": "DescribeCloudDedicatedZoneResourceSummary request structure.",
+      "members": [
+        {
+          "disabled": false,
+          "document": "Unique id of the cloud dedicated zone.",
+          "example": "cdz-8wbc41r9",
+          "member": "string",
+          "name": "CdzId",
+          "required": true,
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "DescribeCloudDedicatedZoneResourceSummaryResponse": {
+      "document": "DescribeCloudDedicatedZoneResourceSummary response structure.",
+      "members": [
+        {
+          "disabled": false,
+          "document": "Resource utilization.",
+          "example": "无",
+          "member": "CloudDedicatedZoneResourceSummaryInfo",
+          "name": "ResourceSummarySet",
+          "output_required": true,
+          "type": "list",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Extended information of resource utilization.",
+          "example": "无",
+          "member": "ExtraInfo",
+          "name": "ExtraInfo",
+          "output_required": false,
+          "type": "object",
+          "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"
+    },
+    "ExtraInfo": {
+      "document": "Extended information of CDZ resource water level data, including availability zone local time and wait for data.",
+      "members": [
+        {
+          "disabled": false,
+          "document": "Cloud dedicated zone local time this monday date.",
+          "example": "2024-01-22",
+          "member": "string",
+          "name": "ThisMondayLocalDate",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Cloud dedicated zone local time last monday date.",
+          "example": "2024-01-15",
+          "member": "string",
+          "name": "LastMondayLocalDate",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        }
+      ],
+      "usage": "out"
+    }
+  }
+}

tccli/services/cdz/v20221123/examples.json

@@ -0,0 +1,12 @@
+{
+  "actions": {
+    "DescribeCloudDedicatedZoneResourceSummary": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: cdz.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCloudDedicatedZoneResourceSummary\n<Common request parameters>\n\n{\n    \"CdzId\": \"cdz-mgk971xw\"\n}",
+        "output": "{\n    \"Response\": {\n        \"ResourceSummarySet\": [\n            {\n\"ProductName\": \"Cloud Virtual Machine\"\n\"SubProductName\": \"Standard S5\",\n                \"Statistics\": [\n                    {\n                        \"Item\": \"CPU\",\n                        \"Unit\": \"Core\",\n                        \"Total\": \"41996\",\n                        \"Usage\": \"32875\",\n                        \"UsageRate\": \"78.28%\",\n                        \"Remain\": \"9121\",\n                        \"RemainRate\": \"21.72%\",\n                        \"ThisMondayUsageRate\": \"78.33%\",\n                        \"ThisMondayUsageGrowthRate\": \"-0.05%\",\n                        \"LastMondayUsageGrowthRate\": \"-4.41%\"\n                    },\n                    {\n                        \"Item\": \"Memory\",\n                        \"Unit\": \"GB\",\n                        \"Total\": \"135520\",\n                        \"Usage\": \"101202\",\n                        \"UsageRate\": \"74.68%\",\n                        \"Remain\": \"34318\",\n                        \"RemainRate\": \"25.32%\",\n                        \"ThisMondayUsageRate\": \"74.72%\",\n                        \"ThisMondayUsageGrowthRate\": \"-0.05%\",\n                        \"LastMondayUsageGrowthRate\": \"-6.19%\"\n                    }\n                ]\n            },\n            {\n                \"ProductName\": \"Cloud Block Storage\"\n                \"SubProductName\": \"SSD Cloud Disk\"\n                \"Statistics\": [\n                    {\n                        \"Item\": \"Disk\",\n                        \"Unit\": \"TB\",\n                        \"Total\": \"64\",\n                        \"Usage\": \"53.34\",\n                        \"UsageRate\": \"83.34%\",\n                        \"Remain\": \"10.66\",\n                        \"RemainRate\": \"16.66%\",\n                        \"ThisMondayUsageRate\": \"83.34%\",\n                        \"ThisMondayUsageGrowthRate\": \"0.00%\",\n                        \"LastMondayUsageGrowthRate\": \"4.58%\"\n                    }\n                ]\n            },\n            {\n                \"ProductName\": \"Cloud Block Storage\"\n                \"SubProductName\": \"High-performance CBS\"\n                \"Statistics\": [\n                    {\n                        \"Item\": \"Disk\",\n                        \"Unit\": \"TB\",\n                        \"Total\": \"1392\",\n                        \"Usage\": \"1157.32\",\n                        \"UsageRate\": \"83.14%\",\n                        \"Remain\": \"234.68\",\n                        \"RemainRate\": \"16.86%\",\n                        \"ThisMondayUsageRate\": \"82.03%\",\n                        \"ThisMondayUsageGrowthRate\": \"1.11%\",\n                        \"LastMondayUsageGrowthRate\": \"6.08%\"\n                    }\n                ]\n            },\n            {\n                \"ProductName\": \"TencentDB for MySQL\"\n                \"SubProductName\": \"TencentDB for MySQL\"\n                \"Statistics\": [\n                    {\n                        \"Item\": \"Memory\",\n                        \"Unit\": \"GB\",\n                        \"Total\": \"3600\",\n                        \"Usage\": \"2031\",\n                        \"UsageRate\": \"56.42%\",\n                        \"Remain\": \"1569\",\n                        \"RemainRate\": \"43.58%\",\n                        \"ThisMondayUsageRate\": \"0.00%\",\n                        \"ThisMondayUsageGrowthRate\": \"56.42%\",\n                        \"LastMondayUsageGrowthRate\": \"-56.42%\"\n                    },\n                    {\n                        \"Item\": \"Disk\",\n                        \"Unit\": \"TB\",\n                        \"Total\": \"180\",\n                        \"Usage\": \"82.12\",\n                        \"UsageRate\": \"45.62%\",\n                        \"Remain\": \"97.88\",\n                        \"RemainRate\": \"54.38%\",\n                        \"ThisMondayUsageRate\": \"0.00%\",\n                        \"ThisMondayUsageGrowthRate\": \"45.62%\",\n                        \"LastMondayUsageGrowthRate\": \"-45.62%\"\n                    }\n                ]\n            },\n            {\n                \"ProductName\": \"TencentDB for PostgreSQL\"\n                \"SubProductName\": \"TencentDB for PostgreSQL\"\n                \"Statistics\": [\n                    {\n                        \"Item\": \"Memory\",\n                        \"Unit\": \"GB\",\n                        \"Total\": \"22320\",\n                        \"Usage\": \"14559\",\n                        \"UsageRate\": \"65.23%\",\n                        \"Remain\": \"7761\",\n                        \"RemainRate\": \"34.77%\",\n                        \"ThisMondayUsageRate\": \"65.23%\",\n                        \"ThisMondayUsageGrowthRate\": \"0.00%\",\n                        \"LastMondayUsageGrowthRate\": \"0.50%\"\n                    },\n                    {\n                        \"Item\": \"Disk\",\n                        \"Unit\": \"TB\",\n                        \"Total\": \"470\",\n                        \"Usage\": \"304.68\",\n                        \"UsageRate\": \"64.83%\",\n                        \"Remain\": \"165.32\",\n                        \"RemainRate\": \"35.17%\",\n                        \"ThisMondayUsageRate\": \"64.83%\",\n                        \"ThisMondayUsageGrowthRate\": \"0.00%\",\n                        \"LastMondayUsageGrowthRate\": \"0.31%\"\n                    }\n                ]\n            },\n            {\n                \"ProductName\": \"TencentDB for Redis\"\n                \"SubProductName\": \"TencentDB for Redis\"\n                \"Statistics\": [\n                    {\n                        \"Item\": \"Memory\",\n                        \"Unit\": \"GB\",\n                        \"Total\": \"2400\",\n                        \"Usage\": \"0\",\n                        \"UsageRate\": \"0.00%\",\n                        \"Remain\": \"2400\",\n                        \"RemainRate\": \"100.00%\",\n                        \"ThisMondayUsageRate\": \"0.00%\",\n                        \"ThisMondayUsageGrowthRate\": \"0.00%\",\n                        \"LastMondayUsageGrowthRate\": \"0.00%\"\n                    }\n                ]\n            }\n        ],\n        \"RequestId\": \"0b2b5dda-8245-4a5a-b0ac-cbf2e7e47bca\"\n    }\n}",
+        "title": "Querying Resource utilization in Cloud Dedicated Zone"
+      }
+    ]
+  }
+}