tccli 3.0.1297.1__py2.py3-none-any.whl → 3.0.1299.1__py2.py3-none-any.whl

tccli/services/vpc/v20170312/api.json

@@ -1316,6 +1316,13 @@
       "output": "DescribeNatGatewayDirectConnectGatewayRouteResponse",
       "status": "online"
     },
+    "DescribeNatGatewayFlowMonitorDetail": {
+      "document": "本接口（DescribeNatGatewayFlowMonitorDetail）用于查询NAT网关流量监控明细。\n\n- 只支持单个网关实例查询。即入参 `NatGatewayId` 最多只支持传一个，且必须传一个。\n- 如果网关有流量，但调用本接口没有返回数据，请在控制台对应网关详情页确认是否开启网关流量监控。",
+      "input": "DescribeNatGatewayFlowMonitorDetailRequest",
+      "name": "查询nat网关流控明细",
+      "output": "DescribeNatGatewayFlowMonitorDetailResponse",
+      "status": "online"
+    },
     "DescribeNatGatewaySourceIpTranslationNatRules": {
       "document": "本接口（DescribeNatGatewaySourceIpTranslationNatRules）用于查询NAT网关SNAT转发规则对象数组。",
       "input": "DescribeNatGatewaySourceIpTranslationNatRulesRequest",
@@ -17066,6 +17073,98 @@
       ],
       "type": "object"
     },
+    "DescribeNatGatewayFlowMonitorDetailRequest": {
+      "document": "DescribeNatGatewayFlowMonitorDetail请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "时间点。表示要查询的时刻。聚合粒度为60、300时，会查询最近一个整分钟开始的聚合周期；聚合粒度为3600时，会查询最近一个整点开始的聚合周期；聚合粒度为86400时，会查询最近一个整天开始的聚合周期。形如：`2019-03-24T10:51:23+08:00`。",
+          "example": "2019-03-24T10:51:23+08:00",
+          "member": "datetime_iso",
+          "name": "TimePoint",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "NAT网关的ID，形如：`nat-ig8xpno8`。",
+          "example": "nat-ig8xpno8",
+          "member": "string",
+          "name": "NatGatewayId",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "展示排序靠前的数据。默认值：10，表示默认展示排序前 10 的数据。最大值：100。",
+          "example": "10",
+          "member": "int64",
+          "name": "TopN",
+          "required": false,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "排序字段。支持：入包量`InPkg`、出包量`OutPkg`、入流量`InTraffic`、出流量`OutTraffic`，标准型nat额外支持 并发连接数`ConcurrentConnectionCount` 、新建连接速率`NewConnectionRate`。默认值`OutTraffic`。",
+          "example": "InTraffic",
+          "member": "string",
+          "name": "OrderField",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "聚合时间粒度。支持：60、300、3600、86400，即按照1分钟、5分钟、1小时、1天进行聚合查询。",
+          "example": "60",
+          "member": "int64",
+          "name": "AggregationTimeRange",
+          "required": false,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "是否查询全部指标。默认值：True，表示查询全部指标。",
+          "example": "True",
+          "member": "bool",
+          "name": "AllMetricMode",
+          "required": false,
+          "type": "bool"
+        }
+      ],
+      "type": "object"
+    },
+    "DescribeNatGatewayFlowMonitorDetailResponse": {
+      "document": "DescribeNatGatewayFlowMonitorDetail返回参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "符合条件的对象数。",
+          "example": "1",
+          "member": "uint64",
+          "name": "TotalCount",
+          "output_required": true,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "网关流量监控明细。",
+          "example": "无",
+          "member": "NatGatewayFlowMonitorDetail",
+          "name": "NatGatewayFlowMonitorDetailSet",
+          "output_required": true,
+          "type": "list",
+          "value_allowed_null": false
+        },
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "DescribeNatGatewaySourceIpTranslationNatRulesRequest": {
       "document": "DescribeNatGatewaySourceIpTranslationNatRules请求参数结构体",
       "members": [
@@ -29769,6 +29868,82 @@
       ],
       "usage": "out"
     },
+    "NatGatewayFlowMonitorDetail": {
+      "document": "nat网关流量监控明细。",
+      "members": [
+        {
+          "disabled": false,
+          "document": "来源`IP`。",
+          "example": "192.168.1.21",
+          "member": "string",
+          "name": "PrivateIpAddress",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "入包量。",
+          "example": "1400",
+          "member": "uint64",
+          "name": "InPkg",
+          "output_required": true,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "出包量。",
+          "example": "1527",
+          "member": "uint64",
+          "name": "OutPkg",
+          "output_required": true,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "入流量，单位：`Byte`。",
+          "example": "32876",
+          "member": "uint64",
+          "name": "InTraffic",
+          "output_required": true,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "出流量，单位：`Byte`。",
+          "example": "65428",
+          "member": "uint64",
+          "name": "OutTraffic",
+          "output_required": true,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "并发连接数。仅标准型nat支持此参数。",
+          "example": "1000",
+          "member": "uint64",
+          "name": "ConcurrentConnectionCount",
+          "output_required": true,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "新建连接速率。仅标准型nat支持此参数。",
+          "example": "100",
+          "member": "uint64",
+          "name": "NewConnectionRate",
+          "output_required": true,
+          "type": "int",
+          "value_allowed_null": false
+        }
+      ],
+      "usage": "out"
+    },
     "NatRegionInfoWithArea": {
       "document": "NAT地域地区对象",
       "members": [],

tccli/services/vpc/v20170312/examples.json

@@ -1732,6 +1732,14 @@
         "title": "查NAT网关路由信息"
       }
     ],
+    "DescribeNatGatewayFlowMonitorDetail": [
+      {
+        "document": "查询一个标准型NAT网关流量监控明细",
+        "input": "https://vpc.tencentcloudapi.com/?Action=DescribeNatGatewayFlowMonitorDetail\n&TimePoint=2021-12-10T09:02:01+08:00\n&NatGatewayId=nat-lz6rjk7n\n&OrderField=OutTraffic\n&<公共请求参数>",
+        "output": "{\n    \"Response\": {\n        \"NatGatewayFlowMonitorDetailSet\": [\n            {\n                \"OutTraffic\": 15925824,\n                \"PrivateIpAddress\": \"2.2.2.188\",\n                \"InPkg\": 71466,\n                \"OutPkg\": 57276,\n                \"InTraffic\": 13526553,\n                \"ConcurrentConnectionCount\": 999,\n                \"NewConnectionRate\": 888\n            }\n        ],\n        \"TotalCount\": 1,\n        \"RequestId\": \"d9b0cd80-3b86-4e03-8fc9-bc7de311bc73\"\n    }\n}",
+        "title": "查询一个标准型NAT网关流量监控明细"
+      }
+    ],
     "DescribeNatGatewaySourceIpTranslationNatRules": [
       {
         "document": "用Filter数组拉取NAT网关的SNAT转发规则",

tccli/services/vpc/vpc_client.py

@@ -16813,6 +16813,58 @@ def doDescribeIp6Translators(args, parsed_globals):
     FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
 
 
+def doDescribeNatGatewayFlowMonitorDetail(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.VpcClient(cred, g_param[OptionsDefine.Region], profile)
+    client._sdkVersion += ("_CLI_" + __version__)
+    models = MODELS_MAP[g_param[OptionsDefine.Version]]
+    model = models.DescribeNatGatewayFlowMonitorDetailRequest()
+    model.from_json_string(json.dumps(args))
+    start_time = time.time()
+    while True:
+        rsp = client.DescribeNatGatewayFlowMonitorDetail(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 doDisableGatewayFlowMonitor(args, parsed_globals):
     g_param = parse_global_arg(parsed_globals)
 
@@ -21307,6 +21359,7 @@ ACTION_MAP = {
     "AcceptAttachCcnInstances": doAcceptAttachCcnInstances,
     "DescribeGatewayFlowQos": doDescribeGatewayFlowQos,
     "DescribeIp6Translators": doDescribeIp6Translators,
+    "DescribeNatGatewayFlowMonitorDetail": doDescribeNatGatewayFlowMonitorDetail,
     "DisableGatewayFlowMonitor": doDisableGatewayFlowMonitor,
     "CreateVpc": doCreateVpc,
     "CheckAssistantCidr": doCheckAssistantCidr,