tccli 3.0.1086.1__py2.py3-none-any.whl → 3.0.1088.1__py2.py3-none-any.whl

tccli/examples/antiddos/v20200309/DescribeBasicDeviceStatus.md

@@ -1,12 +1,14 @@
-**Example 1: 获取基础防护攻击状态**
+**Example 1: 获取基础防护状态**
 
-无
+获取基础防护状态
 
 Input: 
 
 ```
 tccli antiddos DescribeBasicDeviceStatus --cli-unfold-argument  \
-    --IpList 127.0.0.1
+    --IpList abc \
+    --IdList abc \
+    --FilterRegion 1
 ```
 
 Output: 
@@ -15,14 +17,14 @@ Output:
     "Response": {
         "Data": [
             {
-                "Key": "1.1.1.1",
-                "Value": "1"
+                "Key": "abc",
+                "Value": "abc"
             }
         ],
         "CLBData": [
             {
-                "Key": "1.1.1.1",
-                "Value": "1"
+                "Key": "abc",
+                "Value": "abc"
             }
         ],
         "CnameWafData": [
@@ -31,22 +33,20 @@ Output:
                 "Value": "1"
             }
         ],
-        "RequestId": "8f7a9451-2372-4a88-a69d-9868b8991076"
+        "RequestId": "abc"
     }
 }
 ```
 
-**Example 2: 获取基础防护状态**
+**Example 2: 获取基础防护攻击状态**
 
-获取基础防护状态
+无
 
 Input: 
 
 ```
 tccli antiddos DescribeBasicDeviceStatus --cli-unfold-argument  \
-    --IpList abc \
-    --IdList abc \
-    --FilterRegion 1
+    --IpList 127.0.0.1
 ```
 
 Output: 
@@ -55,14 +55,14 @@ Output:
     "Response": {
         "Data": [
             {
-                "Key": "abc",
-                "Value": "abc"
+                "Key": "1.1.1.1",
+                "Value": "1"
             }
         ],
         "CLBData": [
             {
-                "Key": "abc",
-                "Value": "abc"
+                "Key": "1.1.1.1",
+                "Value": "1"
             }
         ],
         "CnameWafData": [
@@ -71,7 +71,7 @@ Output:
                 "Value": "1"
             }
         ],
-        "RequestId": "abc"
+        "RequestId": "8f7a9451-2372-4a88-a69d-9868b8991076"
     }
 }
 ```

tccli/examples/apigateway/v20180808/DescribeLogSearch.md

@@ -1,4 +1,31 @@
-**Example 1: Filters参数示例**
+**Example 1: 请求失败**
+
+下面的示例提示参数错误
+
+Input: 
+
+```
+tccli apigateway DescribeLogSearch --cli-unfold-argument  \
+    --StartTime '2019-10-10 00:00:00' \
+    --EndTime '2019-10-10 23:59:59' \
+    --ServiceId service-8xipv0ua \
+    --Limit 101
+```
+
+Output: 
+```
+{
+    "Response": {
+        "Error": {
+            "Code": "InvalidParameterValue",
+            "Message": "Param is illegal: `101`"
+        },
+        "RequestId": "5a8b1de4-04f5-48eb-9be6-93491ebee6e1"
+    }
+}
+```
+
+**Example 2: Filters参数示例**
 
 LogQuerys 表示日志检索条件，
 其中: LogQuerys.0.Name=api_id&LogQuerys.0.Operator==&LogQuerys.0.Value=api-55rj9ide
@@ -49,30 +76,3 @@ Output:
 }
 ```
 
-**Example 2: 请求失败**
-
-下面的示例提示参数错误
-
-Input: 
-
-```
-tccli apigateway DescribeLogSearch --cli-unfold-argument  \
-    --StartTime '2019-10-10 00:00:00' \
-    --EndTime '2019-10-10 23:59:59' \
-    --ServiceId service-8xipv0ua \
-    --Limit 101
-```
-
-Output: 
-```
-{
-    "Response": {
-        "Error": {
-            "Code": "InvalidParameterValue",
-            "Message": "Param is illegal: `101`"
-        },
-        "RequestId": "5a8b1de4-04f5-48eb-9be6-93491ebee6e1"
-    }
-}
-```
-

tccli/examples/apm/v20210622/DescribeGeneralMetricData.md

@@ -1,6 +1,6 @@
-**Example 1: 查询起始到终止时间内统计service_metric指标数据示例**
+**Example 1: 查询1分钟聚合粒度的runtime_metric指标数据示例**
 
-该示例查询实例为apm-ylTJfTSbn，按照service.name（服务名）、span.kind（客户端/服务端视角）为维度过滤，以service.name（服务名）进行聚合，查找开始时间-终止时间内的service_request_count（总请求）、service_duration（平均响应时间）、service_error_req_rate（平均错误率）、service_slow_call_count（慢调用）、service_error_request_count（异常数量）的指标数据。
+该示例查询实例为apm-ylTJfTSbn，按照service.name（服务名）为维度过滤，以service.name（服务名）进行聚合，查找开始时间-终止时间内以一分钟为聚合粒度的service_gc_full_count（Full GC）的指标数据。
 
 Input: 
 
@@ -8,15 +8,13 @@ Input:
 tccli apm DescribeGeneralMetricData --cli-unfold-argument  \
     --Filters.0.Key service.name \
     --Filters.0.Value tapm-api-ap-beijing \
-    --Filters.1.Key span.kind \
-    --Filters.1.Value client \
-    --ViewName service_metric \
+    --ViewName runtime_metric \
     --InstanceId apm-ylTJfTSbn \
-    --Period 0 \
-    --Metrics service_request_count service_duration service_error_req_rate service_slow_call_count service_error_request_count \
+    --Period 60 \
+    --Metrics service_gc_full_count \
     --StartTime 1652666416 \
     --EndTime 1652667616 \
-    --GroupBy service.name span.kind
+    --GroupBy service.name
 ```
 
 Output: 
@@ -26,92 +24,42 @@ Output:
         "Records": [
             {
                 "Tags": [
-                    {
-                        "Key": "span.kind",
-                        "Value": "client"
-                    },
-                    {
-                        "Key": "service.name",
-                        "Value": "java-order-service"
-                    }
-                ],
-                "MetricName": "service_request_count",
-                "MetricNameCN": "总请求数",
-                "TimeSerial": null,
-                "DataSerial": [
-                    630381
-                ]
-            },
-            {
-                "Tags": [
-                    {
-                        "Key": "span.kind",
-                        "Value": "client"
-                    },
-                    {
-                        "Key": "service.name",
-                        "Value": "java-order-service"
-                    }
-                ],
-                "MetricName": "service_duration",
-                "MetricNameCN": "平均响应时间",
-                "TimeSerial": null,
-                "DataSerial": [
-                    72.44506470564654
-                ]
-            },
-            {
-                "Tags": [
-                    {
-                        "Key": "span.kind",
-                        "Value": "client"
-                    },
-                    {
-                        "Key": "service.name",
-                        "Value": "java-order-service"
-                    }
-                ],
-                "MetricName": "service_error_req_rate",
-                "MetricNameCN": "平均错误率",
-                "TimeSerial": null,
-                "DataSerial": [
-                    1.1464495281425042
-                ]
-            },
-            {
-                "Tags": [
-                    {
-                        "Key": "span.kind",
-                        "Value": "client"
-                    },
                     {
                         "Key": "service.name",
                         "Value": "java-order-service"
                     }
                 ],
-                "MetricName": "service_slow_call_count",
-                "MetricNameCN": "慢调用",
-                "TimeSerial": null,
-                "DataSerial": [
-                    0
-                ]
-            },
-            {
-                "Tags": [
-                    {
-                        "Key": "span.kind",
-                        "Value": "client"
-                    },
-                    {
-                        "Key": "service.name",
-                        "Value": "java-order-service"
-                    }
+                "MetricName": "service_gc_full_count",
+                "MetricNameCN": "full GC",
+                "TimeSerial": [
+                    1656428160,
+                    1656428220,
+                    1656428280,
+                    1656428340,
+                    1656428400,
+                    1656428460,
+                    1656428520,
+                    1656428580,
+                    1656428640,
+                    1656428700,
+                    1656428760,
+                    1656428820,
+                    1656428880
                 ],
-                "MetricName": "service_error_request_count",
-                "MetricNameCN": "错误数",
-                "TimeSerial": null,
                 "DataSerial": [
-                    7227
+                    0.016666666666666666,
+                    0,
+                    0.016666666666666666,
+                    0,
+                    0.016666666666666666,
+                    0.016666666666666666,
+                    0,
+                    0.016666666666666666,
+                    0,
+                    0.016666666666666666,
+                    0.016666666666666666,
+                    0,
+                    0.016666666666666666
                 ]
             }
         ],
@@ -372,9 +320,9 @@ Output:
 }
 ```
 
-**Example 3: 查询1分钟聚合粒度的runtime_metric指标数据示例**
+**Example 3: 查询起始到终止时间内统计service_metric指标数据示例**
 
-该示例查询实例为apm-ylTJfTSbn，按照service.name（服务名）为维度过滤，以service.name（服务名）进行聚合，查找开始时间-终止时间内以一分钟为聚合粒度的service_gc_full_count（Full GC）的指标数据。
+该示例查询实例为apm-ylTJfTSbn，按照service.name（服务名）、span.kind（客户端/服务端视角）为维度过滤，以service.name（服务名）进行聚合，查找开始时间-终止时间内的service_request_count（总请求）、service_duration（平均响应时间）、service_error_req_rate（平均错误率）、service_slow_call_count（慢调用）、service_error_request_count（异常数量）的指标数据。
 
 Input: 
 
@@ -382,13 +330,15 @@ Input:
 tccli apm DescribeGeneralMetricData --cli-unfold-argument  \
     --Filters.0.Key service.name \
     --Filters.0.Value tapm-api-ap-beijing \
-    --ViewName runtime_metric \
+    --Filters.1.Key span.kind \
+    --Filters.1.Value client \
+    --ViewName service_metric \
     --InstanceId apm-ylTJfTSbn \
-    --Period 60 \
-    --Metrics service_gc_full_count \
+    --Period 0 \
+    --Metrics service_request_count service_duration service_error_req_rate service_slow_call_count service_error_request_count \
     --StartTime 1652666416 \
     --EndTime 1652667616 \
-    --GroupBy service.name
+    --GroupBy service.name span.kind
 ```
 
 Output: 
@@ -398,42 +348,92 @@ Output:
         "Records": [
             {
                 "Tags": [
+                    {
+                        "Key": "span.kind",
+                        "Value": "client"
+                    },
                     {
                         "Key": "service.name",
                         "Value": "java-order-service"
                     }
                 ],
-                "MetricName": "service_gc_full_count",
-                "MetricNameCN": "full GC",
-                "TimeSerial": [
-                    1656428160,
-                    1656428220,
-                    1656428280,
-                    1656428340,
-                    1656428400,
-                    1656428460,
-                    1656428520,
-                    1656428580,
-                    1656428640,
-                    1656428700,
-                    1656428760,
-                    1656428820,
-                    1656428880
+                "MetricName": "service_request_count",
+                "MetricNameCN": "总请求数",
+                "TimeSerial": null,
+                "DataSerial": [
+                    630381
+                ]
+            },
+            {
+                "Tags": [
+                    {
+                        "Key": "span.kind",
+                        "Value": "client"
+                    },
+                    {
+                        "Key": "service.name",
+                        "Value": "java-order-service"
+                    }
                 ],
+                "MetricName": "service_duration",
+                "MetricNameCN": "平均响应时间",
+                "TimeSerial": null,
                 "DataSerial": [
-                    0.016666666666666666,
-                    0,
-                    0.016666666666666666,
-                    0,
-                    0.016666666666666666,
-                    0.016666666666666666,
-                    0,
-                    0.016666666666666666,
-                    0,
-                    0.016666666666666666,
-                    0.016666666666666666,
-                    0,
-                    0.016666666666666666
+                    72.44506470564654
+                ]
+            },
+            {
+                "Tags": [
+                    {
+                        "Key": "span.kind",
+                        "Value": "client"
+                    },
+                    {
+                        "Key": "service.name",
+                        "Value": "java-order-service"
+                    }
+                ],
+                "MetricName": "service_error_req_rate",
+                "MetricNameCN": "平均错误率",
+                "TimeSerial": null,
+                "DataSerial": [
+                    1.1464495281425042
+                ]
+            },
+            {
+                "Tags": [
+                    {
+                        "Key": "span.kind",
+                        "Value": "client"
+                    },
+                    {
+                        "Key": "service.name",
+                        "Value": "java-order-service"
+                    }
+                ],
+                "MetricName": "service_slow_call_count",
+                "MetricNameCN": "慢调用",
+                "TimeSerial": null,
+                "DataSerial": [
+                    0
+                ]
+            },
+            {
+                "Tags": [
+                    {
+                        "Key": "span.kind",
+                        "Value": "client"
+                    },
+                    {
+                        "Key": "service.name",
+                        "Value": "java-order-service"
+                    }
+                ],
+                "MetricName": "service_error_request_count",
+                "MetricNameCN": "错误数",
+                "TimeSerial": null,
+                "DataSerial": [
+                    7227
                 ]
             }
         ],

tccli/examples/apm/v20210622/DescribeMetricRecords.md

@@ -1,23 +1,28 @@
-**Example 1: 通用指标列表接口**
+**Example 1: 请求参数实例**
 
-场景2
+场景一
 
 Input: 
 
 ```
 tccli apm DescribeMetricRecords --cli-unfold-argument  \
+    --OrderBy.Key service_duration_avg \
+    --OrderBy.Value DESC \
+    --Filters.0.Type = \
     --Filters.0.Key span.kind \
-    --Filters.0.Type in \
-    --Filters.0.Value server,consumer \
-    --Metrics.0.MetricName duration_avg \
+    --Filters.0.Value server \
+    --InstanceId apm-6xYKFXYxo \
+    --BusinessName taw \
+    --Metrics.0.Compare 1 \
     --Metrics.0.Compares CompareByYesterday CompareByLastWeek \
-    --GroupBy service.instance \
+    --Metrics.0.MetricName qps \
     --Limit 10 \
-    --Offset 1 \
     --StartTime 1618361193 \
+    --Offset 22 \
     --EndTime 1618677137 \
-    --OrderBy.Key duration_avg \
-    --OrderBy.Value DESC
+    --PageIndex 1 \
+    --PageSize 10 \
+    --GroupBy service.instance
 ```
 
 Output: 
@@ -28,67 +33,58 @@ Output:
             {
                 "Fields": [
                     {
-                        "LastPeriodValue": [
+                        "CompareVal": "abc",
+                        "CompareVals": [
                             {
                                 "Key": "abc",
-                                "Value": 0
+                                "Value": "abc"
                             }
                         ],
-                        "CompareVal": "abc",
-                        "Unit": "s",
-                        "Value": 691.42,
-                        "Key": "ab",
-                        "CompareVals": [
-                            {
-                                "Value": "v1",
-                                "Key": "k1"
-                            },
+                        "Value": 0,
+                        "Unit": "abc",
+                        "Key": "abc",
+                        "LastPeriodValue": [
                             {
-                                "Key": "k2",
-                                "Value": "v2"
+                                "Key": "abc",
+                                "Value": 0
                             }
                         ]
                     }
                 ],
                 "Tags": [
                     {
-                        "Value": "v1",
-                        "Key": "k1"
+                        "Key": "abc",
+                        "Value": "abc"
                     }
                 ]
             }
         ],
-        "RequestId": "re",
-        "TotalCount": 0
+        "TotalCount": 0,
+        "RequestId": "abc"
     }
 }
 ```
 
-**Example 2: 请求参数实例**
+**Example 2: 通用指标列表接口**
 
-场景一
+场景2
 
 Input: 
 
 ```
 tccli apm DescribeMetricRecords --cli-unfold-argument  \
-    --OrderBy.Key service_duration_avg \
-    --OrderBy.Value DESC \
-    --Filters.0.Type = \
     --Filters.0.Key span.kind \
-    --Filters.0.Value server \
-    --InstanceId apm-6xYKFXYxo \
-    --BusinessName taw \
-    --Metrics.0.Compare 1 \
+    --Filters.0.Type in \
+    --Filters.0.Value server,consumer \
+    --Metrics.0.MetricName duration_avg \
     --Metrics.0.Compares CompareByYesterday CompareByLastWeek \
-    --Metrics.0.MetricName qps \
+    --GroupBy service.instance \
     --Limit 10 \
+    --Offset 1 \
     --StartTime 1618361193 \
-    --Offset 22 \
     --EndTime 1618677137 \
-    --PageIndex 1 \
-    --PageSize 10 \
-    --GroupBy service.instance
+    --OrderBy.Key duration_avg \
+    --OrderBy.Value DESC
 ```
 
 Output: 
@@ -99,34 +95,38 @@ Output:
             {
                 "Fields": [
                     {
-                        "CompareVal": "abc",
-                        "CompareVals": [
+                        "LastPeriodValue": [
                             {
                                 "Key": "abc",
-                                "Value": "abc"
+                                "Value": 0
                             }
                         ],
-                        "Value": 0,
-                        "Unit": "abc",
-                        "Key": "abc",
-                        "LastPeriodValue": [
+                        "CompareVal": "abc",
+                        "Unit": "s",
+                        "Value": 691.42,
+                        "Key": "ab",
+                        "CompareVals": [
                             {
-                                "Key": "abc",
-                                "Value": 0
+                                "Value": "v1",
+                                "Key": "k1"
+                            },
+                            {
+                                "Key": "k2",
+                                "Value": "v2"
                             }
                         ]
                     }
                 ],
                 "Tags": [
                     {
-                        "Key": "abc",
-                        "Value": "abc"
+                        "Value": "v1",
+                        "Key": "k1"
                     }
                 ]
             }
         ],
-        "TotalCount": 0,
-        "RequestId": "abc"
+        "RequestId": "re",
+        "TotalCount": 0
     }
 }
 ```