tccli 3.0.908.1__py2.py3-none-any.whl → 3.0.910.1__py2.py3-none-any.whl

tccli/services/tcb/v20180608/api.json

@@ -1929,7 +1929,7 @@
           "example": "test-001",
           "member": "string",
           "name": "VersionName",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -1939,7 +1939,7 @@
           "example": "normal",
           "member": "string",
           "name": "Status",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": true
         },
@@ -1949,7 +1949,7 @@
           "example": "1",
           "member": "int64",
           "name": "FlowRatio",
-          "required": true,
+          "output_required": true,
           "type": "int",
           "value_allowed_null": false
         },
@@ -1959,7 +1959,7 @@
           "example": "2020-01-01 12:00:00",
           "member": "string",
           "name": "CreatedTime",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": true
         },
@@ -1969,7 +1969,7 @@
           "example": "2020-01-01 12:00:00",
           "member": "string",
           "name": "UpdatedTime",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": true
         },
@@ -1979,7 +1979,7 @@
           "example": "12345",
           "member": "int64",
           "name": "BuildId",
-          "required": true,
+          "output_required": true,
           "type": "int",
           "value_allowed_null": true
         },
@@ -1989,7 +1989,7 @@
           "example": "Image",
           "member": "string",
           "name": "UploadType",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": true
         },
@@ -1999,7 +1999,7 @@
           "example": "test",
           "member": "string",
           "name": "Remark",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": true
         },
@@ -2009,7 +2009,7 @@
           "example": "test",
           "member": "ObjectKV",
           "name": "UrlParam",
-          "required": true,
+          "output_required": true,
           "type": "object",
           "value_allowed_null": true
         },
@@ -2019,7 +2019,7 @@
           "example": "1",
           "member": "int64",
           "name": "Priority",
-          "required": true,
+          "output_required": true,
           "type": "int",
           "value_allowed_null": true
         },
@@ -2029,7 +2029,7 @@
           "example": "1",
           "member": "bool",
           "name": "IsDefaultPriority",
-          "required": true,
+          "output_required": true,
           "type": "bool",
           "value_allowed_null": true
         },
@@ -2039,7 +2039,7 @@
           "example": "[]",
           "member": "CloudBaseRunKVPriority",
           "name": "FlowParams",
-          "required": true,
+          "output_required": true,
           "type": "list",
           "value_allowed_null": true
         },
@@ -2049,7 +2049,7 @@
           "example": "1",
           "member": "int64",
           "name": "MinReplicas",
-          "required": true,
+          "output_required": true,
           "type": "int",
           "value_allowed_null": true
         },
@@ -2059,7 +2059,7 @@
           "example": "2",
           "member": "int64",
           "name": "MaxReplicas",
-          "required": true,
+          "output_required": true,
           "type": "int",
           "value_allowed_null": true
         },
@@ -2069,7 +2069,7 @@
           "example": "aa123",
           "member": "string",
           "name": "RunId",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": true
         },
@@ -2079,7 +2079,7 @@
           "example": "100",
           "member": "int64",
           "name": "Percent",
-          "required": true,
+          "output_required": true,
           "type": "int",
           "value_allowed_null": true
         },
@@ -2089,7 +2089,7 @@
           "example": "1",
           "member": "int64",
           "name": "CurrentReplicas",
-          "required": true,
+          "output_required": true,
           "type": "int",
           "value_allowed_null": true
         },
@@ -2099,7 +2099,7 @@
           "example": "xx",
           "member": "string",
           "name": "Architecture",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": true
         }
@@ -10425,29 +10425,27 @@
       "document": "安全网关版本路由信息限额配置",
       "members": [
         {
-          "default": "",
           "disabled": false,
-          "document": "限额对象 \"ConnectionsLimit\" 或 \"QPSLimit\"",
+          "document": "限额对象 \"ConnectionsLimit\" 或 \"QPSLimit\"\n注意：此字段可能返回 null，表示取不到有效值。",
           "example": "ConnectionsLimit",
           "member": "string",
           "name": "LimitObject",
           "required": false,
           "type": "string",
-          "value_allowed_null": false
+          "value_allowed_null": true
         },
         {
-          "default": "",
           "disabled": false,
-          "document": "限额配置",
+          "document": "限额配置\n注意：此字段可能返回 null，表示取不到有效值。",
           "example": "{value:1000}",
           "member": "string",
           "name": "LimitConfig",
           "required": false,
           "type": "string",
-          "value_allowed_null": false
+          "value_allowed_null": true
         }
       ],
-      "usage": "in"
+      "usage": "both"
     },
     "FunctionInfo": {
       "document": "函数的信息",
@@ -13199,7 +13197,6 @@
       "document": "安全网关路由",
       "members": [
         {
-          "default": "",
           "disabled": false,
           "document": "安全网关路由名称",
           "example": "无",
@@ -13210,7 +13207,6 @@
           "value_allowed_null": false
         },
         {
-          "default": "",
           "disabled": false,
           "document": "安全网关路由协议",
           "example": "无",
@@ -13221,7 +13217,6 @@
           "value_allowed_null": false
         },
         {
-          "default": "",
           "disabled": false,
           "document": "安全网关路由地址",
           "example": "无",
@@ -13232,7 +13227,6 @@
           "value_allowed_null": false
         },
         {
-          "default": "",
           "disabled": false,
           "document": "安全网关路由描述",
           "example": "无",
@@ -13243,7 +13237,6 @@
           "value_allowed_null": false
         },
         {
-          "default": "",
           "disabled": false,
           "document": "安全网关后端集群id，如果是外网服务，该id与GatewayRountName相同",
           "example": "无",
@@ -13254,7 +13247,6 @@
           "value_allowed_null": false
         },
         {
-          "default": "",
           "disabled": false,
           "document": "安全网关创建时间",
           "example": "无",
@@ -13265,7 +13257,6 @@
           "value_allowed_null": false
         },
         {
-          "default": "",
           "disabled": false,
           "document": "安全网关路由限制\n注意：此字段可能返回 null，表示取不到有效值。",
           "example": "无",
@@ -13276,7 +13267,6 @@
           "value_allowed_null": true
         },
         {
-          "default": "",
           "disabled": false,
           "document": "ip代表绑定后端ip。cbr代表云托管服务\n注意：此字段可能返回 null，表示取不到有效值。",
           "example": "cbr",
@@ -13287,7 +13277,6 @@
           "value_allowed_null": true
         },
         {
-          "default": "",
           "disabled": false,
           "document": "服务名\n注意：此字段可能返回 null，表示取不到有效值。",
           "example": "test",
@@ -13298,7 +13287,6 @@
           "value_allowed_null": true
         },
         {
-          "default": "",
           "disabled": false,
           "document": "ip\n注意：此字段可能返回 null，表示取不到有效值。",
           "example": "1.0.0.1",
@@ -13309,7 +13297,6 @@
           "value_allowed_null": true
         },
         {
-          "default": "",
           "disabled": false,
           "document": "网关版本\n注意：此字段可能返回 null，表示取不到有效值。",
           "example": "gatewayversion",
@@ -13320,7 +13307,6 @@
           "value_allowed_null": true
         },
         {
-          "default": "",
           "disabled": false,
           "document": "请求路径\n注意：此字段可能返回 null，表示取不到有效值。",
           "example": "path",
@@ -13331,7 +13317,6 @@
           "value_allowed_null": true
         },
         {
-          "default": "",
           "disabled": false,
           "document": "请求模式\n注意：此字段可能返回 null，表示取不到有效值。",
           "example": "GET",
@@ -13342,7 +13327,6 @@
           "value_allowed_null": true
         },
         {
-          "default": "",
           "disabled": false,
           "document": "4层端口\n注意：此字段可能返回 null，表示取不到有效值。",
           "example": "80",
@@ -13351,6 +13335,16 @@
           "required": true,
           "type": "int",
           "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "路由环境ID\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "env-xxx",
+          "member": "string",
+          "name": "GatewayRouteEnvId",
+          "required": false,
+          "type": "string",
+          "value_allowed_null": true
         }
       ],
       "usage": "out"

tccli/services/tchd/__init__.py

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

tccli/services/tchd/tchd_client.py

@@ -0,0 +1,194 @@
+# -*- 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.tchd.v20230306 import tchd_client as tchd_client_v20230306
+from tencentcloud.tchd.v20230306 import models as models_v20230306
+
+from jmespath import search
+import time
+
+def doDescribeEvents(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('-', '_')]
+        )
+    elif os.getenv(OptionsDefine.ENV_TKE_REGION)             and os.getenv(OptionsDefine.ENV_TKE_PROVIDER_ID)             and os.getenv(OptionsDefine.ENV_TKE_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.TchdClient(cred, g_param[OptionsDefine.Region], profile)
+    client._sdkVersion += ("_CLI_" + __version__)
+    models = MODELS_MAP[g_param[OptionsDefine.Version]]
+    model = models.DescribeEventsRequest()
+    model.from_json_string(json.dumps(args))
+    start_time = time.time()
+    while True:
+        rsp = client.DescribeEvents(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 = {
+    "v20230306": tchd_client_v20230306,
+
+}
+
+MODELS_MAP = {
+    "v20230306": models_v20230306,
+
+}
+
+ACTION_MAP = {
+    "DescribeEvents": doDescribeEvents,
+
+}
+
+AVAILABLE_VERSION_LIST = [
+    "v20230306",
+
+]
+
+
+def action_caller():
+    return ACTION_MAP
+
+
+def parse_global_arg(parsed_globals):
+    g_param = parsed_globals
+
+    is_exist_profile = True
+    if not parsed_globals["profile"]:
+        is_exist_profile = False
+        g_param["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)
+
+        if os.environ.get(OptionsDefine.ENV_REGION):
+            conf[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)
+
+    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:
+                    g_param[param] = conf[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["tchd"][OptionsDefine.Version]
+            g_param[OptionsDefine.Version] = "v" + version.replace('-', '')
+
+        if g_param[OptionsDefine.Endpoint] is None:
+            g_param[OptionsDefine.Endpoint] = conf["tchd"][OptionsDefine.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/tchd/v20230306/api.json

@@ -0,0 +1,167 @@
+{
+  "actions": {
+    "DescribeEvents": {
+      "document": "本接口用于查询腾讯云健康看板的可用性事件信息，可以通过产品列表、地域列表和事件发生日期进行过滤查询。",
+      "input": "DescribeEventsRequest",
+      "name": "查看事件列表",
+      "output": "DescribeEventsResponse",
+      "status": "online"
+    }
+  },
+  "metadata": {
+    "apiVersion": "2023-03-06",
+    "api_brief": "支持腾讯云用户通过API获取云产品健康看板数据",
+    "serviceNameCN": "腾讯云健康看板",
+    "serviceShortName": "tchd"
+  },
+  "objects": {
+    "DescribeEventsRequest": {
+      "document": "DescribeEvents请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "事件的发生日期",
+          "example": "2023-06-22",
+          "member": "date",
+          "name": "EventDate",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "1. 不指定产品列表时将查询所有产品。\n2. 产品ID示例：cvm、lb、cdb、cdn、crs",
+          "example": "[\"cvm\",\"clb\"]",
+          "member": "string",
+          "name": "ProductIds",
+          "required": false,
+          "type": "list"
+        },
+        {
+          "disabled": false,
+          "document": "1. 不指定地域列表时将查询所有地域。\n2. 查询非区域性产品事件时，地域ID指定为：non-regional\n3. 其他地域ID取值请参考：https://cloud.tencent.com/document/api/213/15692",
+          "example": "[\"ap-guangzhou\",\"ap-shanghai\"]",
+          "member": "string",
+          "name": "RegionIds",
+          "required": false,
+          "type": "list"
+        }
+      ],
+      "type": "object"
+    },
+    "DescribeEventsResponse": {
+      "document": "DescribeEvents返回参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "事件详情列表",
+          "example": "无",
+          "member": "ProductEventList",
+          "name": "Data",
+          "output_required": true,
+          "type": "object",
+          "value_allowed_null": false
+        },
+        {
+          "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "EventDetail": {
+      "document": "事件详情信息，包含：产品名称、地域名称、事件开始时间、事件结束时间、事件当前状态；",
+      "members": [
+        {
+          "disabled": false,
+          "document": "产品ID",
+          "example": "cvm",
+          "member": "string",
+          "name": "ProductId",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "产品名称",
+          "example": "云服务器",
+          "member": "string",
+          "name": "ProductName",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "地域ID，非区域性地域返回non-regional",
+          "example": "ap-beijing",
+          "member": "string",
+          "name": "RegionId",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "地域名称",
+          "example": "北京",
+          "member": "string",
+          "name": "RegionName",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "事件开始时间",
+          "example": "2023-06-22 09:55:00",
+          "member": "string",
+          "name": "StartTime",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "事件结束时间，当事件正在发生还未结束时，结束时间返回空",
+          "example": "2023-06-22 10:00:00",
+          "member": "string",
+          "name": "EndTime",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "事件当前状态：提示、异常、正常",
+          "example": "异常",
+          "member": "string",
+          "name": "CurrentStatus",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": false
+        }
+      ],
+      "usage": "out"
+    },
+    "ProductEventList": {
+      "document": "产品可用性事件详情列表",
+      "members": [
+        {
+          "disabled": false,
+          "document": "事件详情列表\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "无",
+          "member": "EventDetail",
+          "name": "EventList",
+          "output_required": false,
+          "type": "list",
+          "value_allowed_null": true
+        }
+      ],
+      "usage": "out"
+    }
+  },
+  "version": "1.0"
+}