tccli 3.0.1091.1__py2.py3-none-any.whl → 3.0.1093.1__py2.py3-none-any.whl

tccli/__init__.py

@@ -1 +1 @@
-__version__ = '3.0.1091.1'
+__version__ = '3.0.1093.1'

tccli/examples/cdb/v20170320/CheckMigrateCluster.md

@@ -0,0 +1,18 @@
+**Example 1: 高可用实例一键迁移到集群版校验**
+
+
+
+Input: 
+
+```
+tccli cdb CheckMigrateCluster --cli-unfold-argument ```
+
+Output: 
+```
+{
+    "Response": {
+        "RequestId": "abc"
+    }
+}
+```
+

tccli/examples/cdb/v20170320/DescribeClusterInfo.md

@@ -0,0 +1,59 @@
+**Example 1: 查询集群版实例信息**
+
+
+
+Input: 
+
+```
+tccli cdb DescribeClusterInfo --cli-unfold-argument  \
+    --InstanceId cdb-xxx
+```
+
+Output: 
+```
+{
+    "Response": {
+        "ClusterName": "dbname",
+        "ReadWriteAddress": {
+            "ResourceId": "cdb-xxx",
+            "UniqVpcId": "vpc-xxx",
+            "UniqSubnetId": "subnet-xxx",
+            "Vip": "192.168.3.4",
+            "VPort": 3306,
+            "WanDomain": "",
+            "WanPort": 0
+        },
+        "ReadOnlyAddress": [
+            {
+                "ResourceId": "cdb-xxx|readonly",
+                "UniqVpcId": "vpc-xxx",
+                "UniqSubnetId": "subnet-xxx",
+                "Vip": "192.168.3.5",
+                "VPort": 3306,
+                "WanDomain": "",
+                "WanPort": 0
+            }
+        ],
+        "NodeList": [
+            {
+                "NodeId": "dbn-xxx",
+                "Role": "master",
+                "Zone": "ap-guangzhou-1",
+                "Weight": 1,
+                "Status": "online"
+            },
+            {
+                "NodeId": "dbn-xxx",
+                "Role": "slave",
+                "Zone": "ap-guangzhou-2",
+                "Weight": 1,
+                "Status": "online"
+            }
+        ],
+        "ReadonlyLimit": 10,
+        "NodeCount": 2,
+        "RequestId": "abc"
+    }
+}
+```
+

tccli/examples/domain/v20180808/BidPreDomains.md

@@ -0,0 +1,21 @@
+**Example 1: 请求成功示例**
+
+成功示例
+
+Input: 
+
+```
+tccli domain BidPreDomains --cli-unfold-argument  \
+    --BusinessId P0011712825815133328 \
+    --Price 5000
+```
+
+Output: 
+```
+{
+    "Response": {
+        "RequestId": "ec312415-2f61-4a18-987d-d69e55a2847c"
+    }
+}
+```
+

tccli/examples/domain/v20180808/DescribeReservedBidInfo.md

@@ -0,0 +1,43 @@
+**Example 1: 请求成功示例**
+
+成功示例
+
+Input: 
+
+```
+tccli domain DescribeReservedBidInfo --cli-unfold-argument  \
+    --BusinessId P0011712825815133328
+```
+
+Output: 
+```
+{
+    "Response": {
+        "BidList": [
+            {
+                "BidStatus": "up",
+                "BidTime": "17:19:30",
+                "Price": 210,
+                "User": "roy***@tencent.com"
+            },
+            {
+                "BidStatus": "down",
+                "BidTime": "17:18:45",
+                "Price": 200,
+                "User": "155***@qq.com"
+            },
+            {
+                "BidStatus": "down",
+                "BidTime": "17:15:24",
+                "Price": 190,
+                "User": "roy***@tencent.com"
+            }
+        ],
+        "Price": 200,
+        "RequestId": "43271422-1fe8-4af5-99ff-afc140ea35b2",
+        "UpPrice": 210,
+        "UpUser": "roy***@tencent.com"
+    }
+}
+```
+

tccli/examples/domain/v20180808/DescribeReservedPreDomainInfo.md

@@ -34,3 +34,34 @@ Output:
 }
 ```
 
+**Example 2: 请求成功示例**
+
+请求成功获取参数示例
+
+Input: 
+
+```
+tccli domain DescribeReservedPreDomainInfo --cli-unfold-argument ```
+
+Output: 
+```
+{
+    "Response": {
+        "RequestId": "a6bd9e77-517f-4fd8-9ee9-f7042b7ae847",
+        "ReservedPreDomainInfoList": [
+            {
+                "BusinessId": "P0011712734968570466",
+                "ChangeOwnerTime": "2024-03-15 08:40:34",
+                "Domain": "fdasfasfdsaf.com",
+                "ExpireTime": "2024-01-14 08:40:34",
+                "FailReason": "",
+                "RegTime": "2020-01-14 08:40:34",
+                "ReservedStatus": 6,
+                "ResourceId": "R0011712734968672830"
+            }
+        ],
+        "Total": 1
+    }
+}
+```
+

tccli/examples/es/v20180416/UpdateInstance.md

@@ -1,13 +1,13 @@
-**Example 1: 修改ES集群实例名称**
+**Example 1: 重置Kibana密码**
 
-用以修改指定ES集群实例的名称
+重置指定ES集群实例Kibana密码
 
 Input: 
 
 ```
 tccli es UpdateInstance --cli-unfold-argument  \
-    --InstanceId es-xxxxxx \
-    --InstanceName newName
+    --InstanceId es-xxxxxxxx \
+    --Password newPwd_123
 ```
 
 Output: 
@@ -20,23 +20,17 @@ Output:
 }
 ```
 
-**Example 2: ES集群节点规格变更**
+**Example 2: ES集群纵向扩缩容**
 
-用以对指定ES集群实例进行横向扩缩容，纵向扩缩容，增加专用主节点，专用主节点横向扩缩容，纵向扩缩容等操作，NodeInfoList要传递目标的全量节点信息
+用以对集群的节点规格（核数、内存大小）和磁盘大小进行扩缩容操作（当前仅支持纵向扩容）
 
 Input: 
 
 ```
 tccli es UpdateInstance --cli-unfold-argument  \
-    --InstanceId es-xxxxxx \
-    --NodeInfoList.0.NodeType ES.S1.SMALL2 \
-    --NodeInfoList.0.NodeNum 3 \
-    --NodeInfoList.0.Type dedicatedMaster \
-    --NodeInfoList.1.DiskSize 100 \
-    --NodeInfoList.1.NodeType ES.S1.SMALL2 \
-    --NodeInfoList.1.NodeNum 2 \
-    --NodeInfoList.1.Type hotData \
-    --NodeInfoList.1.DiskType CLOUD_SSD
+    --InstanceId es-xxxxxxxx \
+    --DiskSize 150 \
+    --NodeType ES.S1.MEDIUM4
 ```
 
 Output: 
@@ -49,16 +43,23 @@ Output:
 }
 ```
 
-**Example 3: 修改ES集群实例配置**
+**Example 3: ES集群节点规格变更**
 
-用以对指定的ES集群实例的配置进行修改操作
+用以对指定ES集群实例进行横向扩缩容，纵向扩缩容，增加专用主节点，专用主节点横向扩缩容，纵向扩缩容等操作，NodeInfoList要传递目标的全量节点信息
 
 Input: 
 
 ```
 tccli es UpdateInstance --cli-unfold-argument  \
-    --InstanceId es-xxxxxxxx \
-    --EsConfig {"action.destructive_requires_name":"true"}
+    --InstanceId es-xxxxxx \
+    --NodeInfoList.0.NodeType ES.S1.SMALL2 \
+    --NodeInfoList.0.NodeNum 3 \
+    --NodeInfoList.0.Type dedicatedMaster \
+    --NodeInfoList.1.DiskSize 100 \
+    --NodeInfoList.1.NodeType ES.S1.SMALL2 \
+    --NodeInfoList.1.NodeNum 2 \
+    --NodeInfoList.1.Type hotData \
+    --NodeInfoList.1.DiskType CLOUD_SSD
 ```
 
 Output: 
@@ -71,16 +72,16 @@ Output:
 }
 ```
 
-**Example 4: 重置Kibana密码**
+**Example 4: 修改ES集群实例名称**
 
-重置指定ES集群实例Kibana密码
+用以修改指定ES集群实例的名称
 
 Input: 
 
 ```
 tccli es UpdateInstance --cli-unfold-argument  \
-    --InstanceId es-xxxxxxxx \
-    --Password newPwd_123
+    --InstanceId es-xxxxxx \
+    --InstanceName newName
 ```
 
 Output: 
@@ -93,17 +94,16 @@ Output:
 }
 ```
 
-**Example 5: ES集群纵向扩缩容**
+**Example 5: 修改ES集群实例配置**
 
-用以对集群的节点规格（核数、内存大小）和磁盘大小进行扩缩容操作（当前仅支持纵向扩容）
+用以对指定的ES集群实例的配置进行修改操作
 
 Input: 
 
 ```
 tccli es UpdateInstance --cli-unfold-argument  \
     --InstanceId es-xxxxxxxx \
-    --DiskSize 150 \
-    --NodeType ES.S1.MEDIUM4
+    --EsConfig {"action.destructive_requires_name":"true"}
 ```
 
 Output: 

tccli/examples/es/v20180416/UpdatePlugins.md

@@ -1,13 +1,13 @@
-**Example 1: 批量安装插件**
+**Example 1: 批量卸载插件**
 
-批量安装插件
+批量卸载插件
 
 Input: 
 
 ```
 tccli es UpdatePlugins --cli-unfold-argument  \
     --InstanceId es-xxxxxxxx \
-    --InstallPluginList analysis-qq sql
+    --RemovePluginList analysis-qq sql
 ```
 
 Output: 
@@ -19,16 +19,16 @@ Output:
 }
 ```
 
-**Example 2: 批量卸载插件**
+**Example 2: 批量安装插件**
 
-批量卸载插件
+批量安装插件
 
 Input: 
 
 ```
 tccli es UpdatePlugins --cli-unfold-argument  \
     --InstanceId es-xxxxxxxx \
-    --RemovePluginList analysis-qq sql
+    --InstallPluginList analysis-qq sql
 ```
 
 Output: 

tccli/examples/ess/v20201111/CreateBatchOrganizationRegistrationTasks.md

@@ -0,0 +1,146 @@
+**Example 1: 批量注册三家企业,成功创建任务**
+
+
+
+Input: 
+
+```
+tccli ess CreateBatchOrganizationRegistrationTasks --cli-unfold-argument  \
+    --Operator.OpenId us-768d38720c10405f994539097f030a27 \
+    --Operator.UserId 19561039c99fe825a934a132520fde6a \
+    --Operator.Channel YUFU \
+    --Operator.ClientIp 8.8.8.8 \
+    --RegistrationOrganizations.0.OrganizationName 测试认证企业一 \
+    --RegistrationOrganizations.0.UniformSocialCreditCode 9XXXXXXXXXXXXXXXX1 \
+    --RegistrationOrganizations.0.LegalName 鹅鹅子 \
+    --RegistrationOrganizations.0.Address 深圳市南山区1000号腾讯大厦 \
+    --RegistrationOrganizations.0.AdminName 鹅鹅子 \
+    --RegistrationOrganizations.0.AdminMobile 187XXXXXXX0 \
+    --RegistrationOrganizations.0.AuthorizationTypes 2 \
+    --RegistrationOrganizations.1.OrganizationName 测试认证企业二 \
+    --RegistrationOrganizations.1.UniformSocialCreditCode 9XXXXXXXXXXXXXXXX2 \
+    --RegistrationOrganizations.1.LegalName 鹅鹅子 \
+    --RegistrationOrganizations.1.Address 深圳市南山区1000号腾讯大厦 \
+    --RegistrationOrganizations.1.AdminName 鹅鹅子 \
+    --RegistrationOrganizations.1.AdminMobile 187XXXXXXX0 \
+    --RegistrationOrganizations.1.AuthorizationTypes 1 \
+    --RegistrationOrganizations.2.OrganizationName 测试认证企业三 \
+    --RegistrationOrganizations.2.UniformSocialCreditCode 9XXXXXXXXXXXXXXXX3 \
+    --RegistrationOrganizations.2.LegalName 鹅鹅子 \
+    --RegistrationOrganizations.2.Address 深圳市南山区1000号腾讯大厦 \
+    --RegistrationOrganizations.2.AdminName 鹅鹅子 \
+    --RegistrationOrganizations.2.AdminMobile 187XXXXXXX0 \
+    --RegistrationOrganizations.2.AuthorizationTypes 2
+```
+
+Output: 
+```
+{
+    "Response": {
+        "TaskId": "abc",
+        "ErrorMessages": [
+            ""
+        ],
+        "RequestId": "f38013e59d00"
+    }
+}
+```
+
+**Example 2: 批量注册三家企业,地址不符合格式,返回错误**
+
+测试认证企业三的地址没有按照省市区的格式传递
+
+Input: 
+
+```
+tccli ess CreateBatchOrganizationRegistrationTasks --cli-unfold-argument  \
+    --Operator.OpenId us-768d38720c10405f994539097f030a27 \
+    --Operator.UserId 19561039c99fe825a934a132520fde6a \
+    --Operator.Channel YUFU \
+    --Operator.ClientIp 8.8.8.8 \
+    --RegistrationOrganizations.0.OrganizationName 测试认证企业一 \
+    --RegistrationOrganizations.0.UniformSocialCreditCode 9XXXXXXXXXXXXXXXX1 \
+    --RegistrationOrganizations.0.LegalName 鹅鹅子 \
+    --RegistrationOrganizations.0.Address 深圳市南山区1000号腾讯大厦 \
+    --RegistrationOrganizations.0.AdminName 鹅鹅子 \
+    --RegistrationOrganizations.0.AdminMobile 187XXXXXXX0 \
+    --RegistrationOrganizations.0.AuthorizationTypes 2 \
+    --RegistrationOrganizations.1.OrganizationName 测试认证企业二 \
+    --RegistrationOrganizations.1.UniformSocialCreditCode 9XXXXXXXXXXXXXXXX2 \
+    --RegistrationOrganizations.1.LegalName 鹅鹅子 \
+    --RegistrationOrganizations.1.Address 深圳市南山区1000号腾讯大厦 \
+    --RegistrationOrganizations.1.AdminName 鹅鹅子 \
+    --RegistrationOrganizations.1.AdminMobile 187XXXXXXX0 \
+    --RegistrationOrganizations.1.AuthorizationTypes 1 \
+    --RegistrationOrganizations.2.OrganizationName 测试认证企业三 \
+    --RegistrationOrganizations.2.UniformSocialCreditCode 9XXXXXXXXXXXXXXXX3 \
+    --RegistrationOrganizations.2.LegalName 鹅鹅子 \
+    --RegistrationOrganizations.2.Address 测试地址 \
+    --RegistrationOrganizations.2.AdminName 鹅鹅子 \
+    --RegistrationOrganizations.2.AdminMobile 187XXXXXXX0 \
+    --RegistrationOrganizations.2.AuthorizationTypes 2
+```
+
+Output: 
+```
+{
+    "Response": {
+        "ErrorMessages": [
+            "",
+            "第【2】条注册信息参数错误，地址参数不正确,请确认后再试",
+            ""
+        ],
+        "RequestId": "5cea4b4778bf",
+        "TaskId": ""
+    }
+}
+```
+
+**Example 3: 批量注册三家企业,企业名称重复,无法创建,返回错误提示**
+
+第一家企业和第三家企业名字重复, 无法注册
+
+Input: 
+
+```
+tccli ess CreateBatchOrganizationRegistrationTasks --cli-unfold-argument  \
+    --Operator.OpenId us-768d38720c10405f994539097f030a27 \
+    --Operator.UserId 19561039c99fe825a934a132520fde6a \
+    --Operator.Channel YUFU \
+    --Operator.ClientIp 8.8.8.8 \
+    --RegistrationOrganizations.0.OrganizationName 测试认证企业一 \
+    --RegistrationOrganizations.0.UniformSocialCreditCode 9XXXXXXXXXXXXXXXX1 \
+    --RegistrationOrganizations.0.LegalName 鹅鹅子 \
+    --RegistrationOrganizations.0.Address 深圳市南山区1000号腾讯大厦 \
+    --RegistrationOrganizations.0.AdminName 鹅鹅子 \
+    --RegistrationOrganizations.0.AdminMobile 187XXXXXXX0 \
+    --RegistrationOrganizations.0.AuthorizationTypes 2 \
+    --RegistrationOrganizations.1.OrganizationName 测试认证企业二 \
+    --RegistrationOrganizations.1.UniformSocialCreditCode 9XXXXXXXXXXXXXXXX2 \
+    --RegistrationOrganizations.1.LegalName 鹅鹅子 \
+    --RegistrationOrganizations.1.Address 深圳市南山区1000号腾讯大厦 \
+    --RegistrationOrganizations.1.AdminName 鹅鹅子 \
+    --RegistrationOrganizations.1.AdminMobile 187XXXXXXX0 \
+    --RegistrationOrganizations.1.AuthorizationTypes 1 \
+    --RegistrationOrganizations.2.OrganizationName 测试认证企业一 \
+    --RegistrationOrganizations.2.UniformSocialCreditCode 9XXXXXXXXXXXXXXXX3 \
+    --RegistrationOrganizations.2.LegalName 鹅鹅子 \
+    --RegistrationOrganizations.2.Address 深圳市南山区1000号腾讯大厦 \
+    --RegistrationOrganizations.2.AdminName 鹅鹅子 \
+    --RegistrationOrganizations.2.AdminMobile 187XXXXXXX0 \
+    --RegistrationOrganizations.2.AuthorizationTypes 2
+```
+
+Output: 
+```
+{
+    "Response": {
+        "Error": {
+            "Code": "InvalidParameterValue",
+            "Message": "企业名称[测试认证企业一]重复"
+        },
+        "RequestId": "4f7b42be805f"
+    }
+}
+```
+

tccli/examples/ess/v20201111/CreateOrganizationAuthUrl.md

@@ -0,0 +1,28 @@
+**Example 1: 创建企业认证链接**
+
+创建企业认证链接
+
+Input: 
+
+```
+tccli ess CreateOrganizationAuthUrl --cli-unfold-argument  \
+    --Operator.UserId yDwfsUUckpsqt647UE6uSrk1ZWhYH56z \
+    --Endpoint PC \
+    --AuthorizationTypes 1 2 3 \
+    --LegalName 11 \
+    --UniformSocialCreditCode 11 \
+    --OrganizationName 测试企业123123 \
+    --AutoJumpUrl https://xxxx.com.cn/xxx
+```
+
+Output: 
+```
+{
+    "Response": {
+        "AuthUrl": "https://test.qian.tencent.cn/console/register-callback?token=yDwFJUUckpsxxxxxWaLrSa3zzlXQh",
+        "ExpiredTime": 1668010213,
+        "RequestId": "s168499xxxxx2608083"
+    }
+}
+```
+

tccli/examples/ess/v20201111/CreateOrganizationBatchSignUrl.md

@@ -104,3 +104,31 @@ Output:
 }
 ```
 
+**Example 5: 基于RecipientIds 生成他方签署链接**
+
+
+
+Input: 
+
+```
+tccli ess CreateOrganizationBatchSignUrl --cli-unfold-argument  \
+    --Operator.UserId yDRCLUUgygq2xun5UXXXzjEwg0vjoimj \
+    --Agent.ProxyOrganizationId  \
+    --UserId  \
+    --Name  \
+    --Mobile  \
+    --FlowIds yDC5yUUntf6vnnUxxBTyJ8Ps0WGqAuHL yDC5yUUntf6fccUEgcyeHwPz4wjnDSI4 \
+    --RecipientIds yDC5yUUntf6vn0UxxBTyJvfv3Xlckcye yDC5yUUntf6mdgUEgcyeHCpCDmDjbsQJ
+```
+
+Output: 
+```
+{
+    "Response": {
+        "ExpiredTime": 1706100107,
+        "RequestId": "s1705495307288609862",
+        "SignUrl": "https://embed.test.qian.tencent.cn/contract-sign?embed=1&expiredOn=1706100107&code=yDCNBUUckpvlibz6UEMbkWeSzl6YurH0&shortKey=yDCNBUzgvS93aBhXs3ae&channel=TENCENTCLOUD"
+    }
+}
+```
+