tccli 3.0.1234.1__py2.py3-none-any.whl → 3.0.1236.1__py2.py3-none-any.whl

Sign up to get free protection for your applications and to get access to all the features.
Files changed (38) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/services/cdb/v20170320/api.json +15 -15
  3. tccli/services/cls/v20201016/api.json +4 -4
  4. tccli/services/cwp/cwp_client.py +326 -8
  5. tccli/services/cwp/v20180228/api.json +488 -1
  6. tccli/services/cwp/v20180228/examples.json +48 -0
  7. tccli/services/essbasic/v20210526/api.json +10 -0
  8. tccli/services/faceid/v20180301/api.json +19 -0
  9. tccli/services/hunyuan/v20230901/api.json +12 -3
  10. tccli/services/iotexplorer/iotexplorer_client.py +159 -0
  11. tccli/services/iotexplorer/v20190423/api.json +298 -4
  12. tccli/services/iotexplorer/v20190423/examples.json +30 -0
  13. tccli/services/iotvideo/iotvideo_client.py +106 -0
  14. tccli/services/iotvideo/v20211125/api.json +169 -0
  15. tccli/services/iotvideo/v20211125/examples.json +16 -0
  16. tccli/services/ocr/v20181119/api.json +5 -5
  17. tccli/services/ocr/v20181119/examples.json +7 -7
  18. tccli/services/privatedns/v20201028/api.json +8 -8
  19. tccli/services/smh/v20210712/api.json +7 -7
  20. tccli/services/smh/v20210712/examples.json +1 -1
  21. tccli/services/sms/v20210111/api.json +1 -1
  22. tccli/services/ssl/v20191205/api.json +46 -33
  23. tccli/services/ssl/v20191205/examples.json +13 -13
  24. tccli/services/tcbr/v20220217/api.json +71 -71
  25. tccli/services/tcbr/v20220217/examples.json +13 -31
  26. tccli/services/teo/v20220901/api.json +1 -1
  27. tccli/services/trocket/v20230308/api.json +19 -0
  28. tccli/services/tsf/v20180326/api.json +1577 -1408
  29. tccli/services/tsf/v20180326/examples.json +55 -61
  30. tccli/services/vrs/v20200824/api.json +68 -6
  31. tccli/services/vrs/v20200824/examples.json +8 -0
  32. tccli/services/vrs/vrs_client.py +53 -0
  33. tccli/services/wedata/v20210820/api.json +76 -0
  34. {tccli-3.0.1234.1.dist-info → tccli-3.0.1236.1.dist-info}/METADATA +2 -2
  35. {tccli-3.0.1234.1.dist-info → tccli-3.0.1236.1.dist-info}/RECORD +38 -38
  36. {tccli-3.0.1234.1.dist-info → tccli-3.0.1236.1.dist-info}/WHEEL +0 -0
  37. {tccli-3.0.1234.1.dist-info → tccli-3.0.1236.1.dist-info}/entry_points.txt +0 -0
  38. {tccli-3.0.1234.1.dist-info → tccli-3.0.1236.1.dist-info}/license_files/LICENSE +0 -0
@@ -5065,6 +5065,58 @@ def doCreateCOSCredentials(args, parsed_globals):
5065
5065
  FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
5066
5066
 
5067
5067
 
5068
+ def doCreateFreeCloudStorage(args, parsed_globals):
5069
+ g_param = parse_global_arg(parsed_globals)
5070
+
5071
+ if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
5072
+ cred = credential.CVMRoleCredential()
5073
+ elif g_param[OptionsDefine.RoleArn.replace('-', '_')] and g_param[OptionsDefine.RoleSessionName.replace('-', '_')]:
5074
+ cred = credential.STSAssumeRoleCredential(
5075
+ g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.RoleArn.replace('-', '_')],
5076
+ g_param[OptionsDefine.RoleSessionName.replace('-', '_')], endpoint=g_param["sts_cred_endpoint"]
5077
+ )
5078
+ 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):
5079
+ cred = credential.DefaultTkeOIDCRoleArnProvider().get_credentials()
5080
+ else:
5081
+ cred = credential.Credential(
5082
+ g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.Token]
5083
+ )
5084
+ http_profile = HttpProfile(
5085
+ reqTimeout=60 if g_param[OptionsDefine.Timeout] is None else int(g_param[OptionsDefine.Timeout]),
5086
+ reqMethod="POST",
5087
+ endpoint=g_param[OptionsDefine.Endpoint],
5088
+ proxy=g_param[OptionsDefine.HttpsProxy.replace('-', '_')]
5089
+ )
5090
+ profile = ClientProfile(httpProfile=http_profile, signMethod="HmacSHA256")
5091
+ if g_param[OptionsDefine.Language]:
5092
+ profile.language = g_param[OptionsDefine.Language]
5093
+ mod = CLIENT_MAP[g_param[OptionsDefine.Version]]
5094
+ client = mod.IotvideoClient(cred, g_param[OptionsDefine.Region], profile)
5095
+ client._sdkVersion += ("_CLI_" + __version__)
5096
+ models = MODELS_MAP[g_param[OptionsDefine.Version]]
5097
+ model = models.CreateFreeCloudStorageRequest()
5098
+ model.from_json_string(json.dumps(args))
5099
+ start_time = time.time()
5100
+ while True:
5101
+ rsp = client.CreateFreeCloudStorage(model)
5102
+ result = rsp.to_json_string()
5103
+ try:
5104
+ json_obj = json.loads(result)
5105
+ except TypeError as e:
5106
+ json_obj = json.loads(result.decode('utf-8')) # python3.3
5107
+ if not g_param[OptionsDefine.Waiter] or search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj) == g_param['OptionsDefine.WaiterInfo']['to']:
5108
+ break
5109
+ cur_time = time.time()
5110
+ if cur_time - start_time >= g_param['OptionsDefine.WaiterInfo']['timeout']:
5111
+ raise ClientError('Request timeout, wait `%s` to `%s` timeout, last request is %s' %
5112
+ (g_param['OptionsDefine.WaiterInfo']['expr'], g_param['OptionsDefine.WaiterInfo']['to'],
5113
+ search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj)))
5114
+ else:
5115
+ print('Inquiry result is %s.' % search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj))
5116
+ time.sleep(g_param['OptionsDefine.WaiterInfo']['interval'])
5117
+ FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
5118
+
5119
+
5068
5120
  def doSendOnlineMsg(args, parsed_globals):
5069
5121
  g_param = parse_global_arg(parsed_globals)
5070
5122
 
@@ -6521,6 +6573,58 @@ def doDisableDevice(args, parsed_globals):
6521
6573
  FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
6522
6574
 
6523
6575
 
6576
+ def doCreateDeviceChannel(args, parsed_globals):
6577
+ g_param = parse_global_arg(parsed_globals)
6578
+
6579
+ if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
6580
+ cred = credential.CVMRoleCredential()
6581
+ elif g_param[OptionsDefine.RoleArn.replace('-', '_')] and g_param[OptionsDefine.RoleSessionName.replace('-', '_')]:
6582
+ cred = credential.STSAssumeRoleCredential(
6583
+ g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.RoleArn.replace('-', '_')],
6584
+ g_param[OptionsDefine.RoleSessionName.replace('-', '_')], endpoint=g_param["sts_cred_endpoint"]
6585
+ )
6586
+ 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):
6587
+ cred = credential.DefaultTkeOIDCRoleArnProvider().get_credentials()
6588
+ else:
6589
+ cred = credential.Credential(
6590
+ g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.Token]
6591
+ )
6592
+ http_profile = HttpProfile(
6593
+ reqTimeout=60 if g_param[OptionsDefine.Timeout] is None else int(g_param[OptionsDefine.Timeout]),
6594
+ reqMethod="POST",
6595
+ endpoint=g_param[OptionsDefine.Endpoint],
6596
+ proxy=g_param[OptionsDefine.HttpsProxy.replace('-', '_')]
6597
+ )
6598
+ profile = ClientProfile(httpProfile=http_profile, signMethod="HmacSHA256")
6599
+ if g_param[OptionsDefine.Language]:
6600
+ profile.language = g_param[OptionsDefine.Language]
6601
+ mod = CLIENT_MAP[g_param[OptionsDefine.Version]]
6602
+ client = mod.IotvideoClient(cred, g_param[OptionsDefine.Region], profile)
6603
+ client._sdkVersion += ("_CLI_" + __version__)
6604
+ models = MODELS_MAP[g_param[OptionsDefine.Version]]
6605
+ model = models.CreateDeviceChannelRequest()
6606
+ model.from_json_string(json.dumps(args))
6607
+ start_time = time.time()
6608
+ while True:
6609
+ rsp = client.CreateDeviceChannel(model)
6610
+ result = rsp.to_json_string()
6611
+ try:
6612
+ json_obj = json.loads(result)
6613
+ except TypeError as e:
6614
+ json_obj = json.loads(result.decode('utf-8')) # python3.3
6615
+ if not g_param[OptionsDefine.Waiter] or search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj) == g_param['OptionsDefine.WaiterInfo']['to']:
6616
+ break
6617
+ cur_time = time.time()
6618
+ if cur_time - start_time >= g_param['OptionsDefine.WaiterInfo']['timeout']:
6619
+ raise ClientError('Request timeout, wait `%s` to `%s` timeout, last request is %s' %
6620
+ (g_param['OptionsDefine.WaiterInfo']['expr'], g_param['OptionsDefine.WaiterInfo']['to'],
6621
+ search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj)))
6622
+ else:
6623
+ print('Inquiry result is %s.' % search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj))
6624
+ time.sleep(g_param['OptionsDefine.WaiterInfo']['interval'])
6625
+ FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
6626
+
6627
+
6524
6628
  def doRunTestOtaVersion(args, parsed_globals):
6525
6629
  g_param = parse_global_arg(parsed_globals)
6526
6630
 
@@ -8505,6 +8609,7 @@ ACTION_MAP = {
8505
8609
  "DescribeDeviceActionHistory": doDescribeDeviceActionHistory,
8506
8610
  "DescribeIotModel": doDescribeIotModel,
8507
8611
  "CreateCOSCredentials": doCreateCOSCredentials,
8612
+ "CreateFreeCloudStorage": doCreateFreeCloudStorage,
8508
8613
  "SendOnlineMsg": doSendOnlineMsg,
8509
8614
  "CreateTraceIds": doCreateTraceIds,
8510
8615
  "CreateBatch": doCreateBatch,
@@ -8533,6 +8638,7 @@ ACTION_MAP = {
8533
8638
  "DescribeMessageDataStats": doDescribeMessageDataStats,
8534
8639
  "DeleteCloudStorageEvent": doDeleteCloudStorageEvent,
8535
8640
  "DisableDevice": doDisableDevice,
8641
+ "CreateDeviceChannel": doCreateDeviceChannel,
8536
8642
  "RunTestOtaVersion": doRunTestOtaVersion,
8537
8643
  "DescribeP2PInfo": doDescribeP2PInfo,
8538
8644
  "CreateIotDataType": doCreateIotDataType,
@@ -105,6 +105,13 @@
105
105
  "output": "CreateDataForwardResponse",
106
106
  "status": "online"
107
107
  },
108
+ "CreateDeviceChannel": {
109
+ "document": "创建设备通道",
110
+ "input": "CreateDeviceChannelRequest",
111
+ "name": "创建设备通道",
112
+ "output": "CreateDeviceChannelResponse",
113
+ "status": "online"
114
+ },
108
115
  "CreateForwardRule": {
109
116
  "document": "创建转发规则",
110
117
  "input": "CreateForwardRuleRequest",
@@ -112,6 +119,13 @@
112
119
  "output": "CreateForwardRuleResponse",
113
120
  "status": "online"
114
121
  },
122
+ "CreateFreeCloudStorage": {
123
+ "document": "开通免费云存服务",
124
+ "input": "CreateFreeCloudStorageRequest",
125
+ "name": "开通云存卡服务",
126
+ "output": "CreateFreeCloudStorageResponse",
127
+ "status": "online"
128
+ },
115
129
  "CreateProduct": {
116
130
  "document": "创建产品",
117
131
  "input": "CreateProductRequest",
@@ -2274,6 +2288,51 @@
2274
2288
  ],
2275
2289
  "type": "object"
2276
2290
  },
2291
+ "CreateDeviceChannelRequest": {
2292
+ "document": "CreateDeviceChannel请求参数结构体",
2293
+ "members": [
2294
+ {
2295
+ "disabled": false,
2296
+ "document": "产品ID",
2297
+ "example": "H541SOP191",
2298
+ "member": "string",
2299
+ "name": "ProductId",
2300
+ "required": true,
2301
+ "type": "string"
2302
+ },
2303
+ {
2304
+ "disabled": false,
2305
+ "document": "设备名称",
2306
+ "example": "event_36502632_1",
2307
+ "member": "string",
2308
+ "name": "DeviceName",
2309
+ "required": true,
2310
+ "type": "string"
2311
+ },
2312
+ {
2313
+ "disabled": false,
2314
+ "document": "通道ID",
2315
+ "example": "1",
2316
+ "member": "uint64",
2317
+ "name": "ChannelId",
2318
+ "required": true,
2319
+ "type": "int"
2320
+ }
2321
+ ],
2322
+ "type": "object"
2323
+ },
2324
+ "CreateDeviceChannelResponse": {
2325
+ "document": "CreateDeviceChannel返回参数结构体",
2326
+ "members": [
2327
+ {
2328
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
2329
+ "member": "string",
2330
+ "name": "RequestId",
2331
+ "type": "string"
2332
+ }
2333
+ ],
2334
+ "type": "object"
2335
+ },
2277
2336
  "CreateForwardRuleRequest": {
2278
2337
  "document": "CreateForwardRule请求参数结构体",
2279
2338
  "members": [
@@ -2502,6 +2561,116 @@
2502
2561
  ],
2503
2562
  "type": "object"
2504
2563
  },
2564
+ "CreateFreeCloudStorageRequest": {
2565
+ "document": "CreateFreeCloudStorage请求参数结构体",
2566
+ "members": [
2567
+ {
2568
+ "disabled": false,
2569
+ "document": "产品ID",
2570
+ "example": "H541SOP191",
2571
+ "member": "string",
2572
+ "name": "ProductId",
2573
+ "required": true,
2574
+ "type": "string"
2575
+ },
2576
+ {
2577
+ "disabled": false,
2578
+ "document": "设备名称",
2579
+ "example": "event_36502632_1",
2580
+ "member": "string",
2581
+ "name": "DeviceName",
2582
+ "required": true,
2583
+ "type": "string"
2584
+ },
2585
+ {
2586
+ "disabled": false,
2587
+ "document": "云存套餐ID:\nlye1w3d:低功耗事件3天周套餐。\nye1w3d:事件3天周套餐",
2588
+ "example": "lye1w3d",
2589
+ "member": "string",
2590
+ "name": "PackageId",
2591
+ "required": true,
2592
+ "type": "string"
2593
+ },
2594
+ {
2595
+ "disabled": false,
2596
+ "document": "如果当前设备已开启云存套餐,Override=1会使用新套餐覆盖原有套餐。不传此参数则默认为0。",
2597
+ "example": "0",
2598
+ "member": "uint64",
2599
+ "name": "Override",
2600
+ "required": false,
2601
+ "type": "int"
2602
+ },
2603
+ {
2604
+ "disabled": false,
2605
+ "document": "套餐列表顺序:PackageQueue=front会立即使用新购买的套餐,新购套餐结束后,列表中下一个未过期的套餐继续生效;PackageQueue=end会等设备当前所有已购买套餐过期后才会生效新购套餐。与Override参数不能同时使用。",
2606
+ "example": "front",
2607
+ "member": "string",
2608
+ "name": "PackageQueue",
2609
+ "required": false,
2610
+ "type": "string"
2611
+ },
2612
+ {
2613
+ "disabled": false,
2614
+ "document": "订单id",
2615
+ "example": "slfie21321",
2616
+ "member": "string",
2617
+ "name": "OrderId",
2618
+ "required": false,
2619
+ "type": "string"
2620
+ },
2621
+ {
2622
+ "disabled": false,
2623
+ "document": "通道ID",
2624
+ "example": "1",
2625
+ "member": "uint64",
2626
+ "name": "ChannelId",
2627
+ "required": false,
2628
+ "type": "int"
2629
+ },
2630
+ {
2631
+ "disabled": false,
2632
+ "document": "云存视频存储区域,国内默认为ap-guangzhou。海外默认为东南亚ap-singapore,可选美东na-ashburn、欧洲eu-frankfurt。",
2633
+ "example": "ap-guangzhou",
2634
+ "member": "string",
2635
+ "name": "StorageRegion",
2636
+ "required": false,
2637
+ "type": "string"
2638
+ }
2639
+ ],
2640
+ "type": "object"
2641
+ },
2642
+ "CreateFreeCloudStorageResponse": {
2643
+ "document": "CreateFreeCloudStorage返回参数结构体",
2644
+ "members": [
2645
+ {
2646
+ "disabled": false,
2647
+ "document": "订单金额,单位为分\n注意:此字段可能返回 null,表示取不到有效值。",
2648
+ "example": "100",
2649
+ "member": "uint64",
2650
+ "name": "Price",
2651
+ "output_required": false,
2652
+ "type": "int",
2653
+ "value_allowed_null": true
2654
+ },
2655
+ {
2656
+ "disabled": false,
2657
+ "document": "支付金额,单位为分\n注意:此字段可能返回 null,表示取不到有效值。",
2658
+ "example": "100",
2659
+ "member": "uint64",
2660
+ "name": "Amount",
2661
+ "output_required": false,
2662
+ "type": "int",
2663
+ "value_allowed_null": true
2664
+ },
2665
+ {
2666
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
2667
+ "member": "string",
2668
+ "name": "RequestId",
2669
+ "type": "string"
2670
+ }
2671
+ ],
2672
+ "type": "object"
2673
+ },
2505
2674
  "CreateProductRequest": {
2506
2675
  "document": "CreateProduct请求参数结构体",
2507
2676
  "members": [
@@ -120,6 +120,14 @@
120
120
  "title": "创建数据转发"
121
121
  }
122
122
  ],
123
+ "CreateDeviceChannel": [
124
+ {
125
+ "document": "",
126
+ "input": "POST / HTTP/1.1\nHost: iotvideo.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateCloudStorage\n<公共请求参数>\n\n{\n \"ProductId\": \"H541SOP191\",\n \"DeviceName\": \"event_36502632_1\",\n \"ChannelId\": 1\n}",
127
+ "output": "{\n \"Response\": {\n \"RequestId\": \"a9a9d232-01c0-494a-baa3-57c384463c3f\"\n }\n}",
128
+ "title": "创建设备通道示例"
129
+ }
130
+ ],
123
131
  "CreateForwardRule": [
124
132
  {
125
133
  "document": "创建转发规则",
@@ -128,6 +136,14 @@
128
136
  "title": "创建转发规则"
129
137
  }
130
138
  ],
139
+ "CreateFreeCloudStorage": [
140
+ {
141
+ "document": "",
142
+ "input": "POST / HTTP/1.1\nHost: iotvideo.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateCloudStorage\n<公共请求参数>\n\n{\n \"ProductId\": \"H541SOP191\",\n \"DeviceName\": \"event_36502632_1\",\n \"PackageId\": \"yc1m3d\"\n}",
143
+ "output": "{\n \"Response\": {\n \"Amount\": 0,\n \"Price\": 0,\n \"RequestId\": \"a9a9d232-01c0-494a-baa3-57c384463c3f\"\n }\n}",
144
+ "title": "开通免费实例"
145
+ }
146
+ ],
131
147
  "CreateProduct": [
132
148
  {
133
149
  "document": "",
@@ -498,7 +498,7 @@
498
498
  "status": "online"
499
499
  },
500
500
  "TextDetect": {
501
- "document": "本接口通过检测图片中的文字信息特征,快速判断图片中有无文字并返回判断结果,帮助用户过滤无文字的图片。",
501
+ "document": "本接口通过检测图片中的文字信息特征,快速判断图片中有无文字并返回判断结果,帮助用户过滤无文字的图片。\n\n默认接口请求频率限制:5次/秒。",
502
502
  "input": "TextDetectRequest",
503
503
  "name": "快速文本检测",
504
504
  "output": "TextDetectResponse",
@@ -16641,7 +16641,7 @@
16641
16641
  {
16642
16642
  "disabled": false,
16643
16643
  "document": "图片的 Base64 值。\n支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。\n支持的图片大小:所下载图片经Base64编码后不超过 7M。图片下载时间不超过 3 秒。\n图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageUrl。",
16644
- "example": "",
16644
+ "example": "/9j/4AAQSkZJRg.....s97n//2Q==",
16645
16645
  "member": "string",
16646
16646
  "name": "ImageBase64",
16647
16647
  "required": false,
@@ -16650,7 +16650,7 @@
16650
16650
  {
16651
16651
  "disabled": false,
16652
16652
  "document": "图片的 Url 地址。\n支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。\n支持的图片大小:所下载图片经 Base64 编码后不超过 7M。图片下载时间不超过 3 秒。\n图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。\n非腾讯云存储的 Url 速度和稳定性可能受一定影响。",
16653
- "example": "https://xx/a.jpg",
16653
+ "example": "https://ocr-demo-1254418846.cos.ap-guangzhou.myqcloud.com/general/TextDetect/TextDetect2.jpg",
16654
16654
  "member": "string",
16655
16655
  "name": "ImageUrl",
16656
16656
  "required": false,
@@ -16665,10 +16665,10 @@
16665
16665
  {
16666
16666
  "disabled": false,
16667
16667
  "document": "图片中是否包含文字。",
16668
- "example": "1",
16668
+ "example": "false",
16669
16669
  "member": "bool",
16670
16670
  "name": "HasText",
16671
- "required": true,
16671
+ "output_required": true,
16672
16672
  "type": "bool",
16673
16673
  "value_allowed_null": false
16674
16674
  },
@@ -541,7 +541,7 @@
541
541
  "RideHailingDriverLicenseOCR": [
542
542
  {
543
543
  "document": "网约车驾驶证识别示例代码",
544
- "input": "https://ocr.tencentcloudapi.com/?Action=RideHailingDriverLicenseOCR\n&ImageUrl=https://ocr-demo-1254418846.cos.ap-guangzhou.myqcloud.com/***/fakeurl.jpg\n&<公共请求参数>",
544
+ "input": "POST / HTTP/1.1\nHost: ocr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: RideHailingDriverLicenseOCR\n<公共请求参数>\n\n{\n \"ImageUrl\": \"https://ocr-demo-1254418846.cos.ap-guangzhou.myqcloud.com/***/fakeurl.jpg\"\n}",
545
545
  "output": "{\n \"Response\": {\n \"Name\": \"张**\",\n \"LicenseNumber\": \"130****13\",\n \"StartDate\": \"20190925\",\n \"EndDate\": \"20190925\",\n \"ReleaseDate\": \"20190925\",\n \"RequestId\": \"aa534793deqd1dqq948487\"\n }\n}",
546
546
  "title": "网约车驾驶证识别示例代码"
547
547
  }
@@ -613,9 +613,9 @@
613
613
  "TextDetect": [
614
614
  {
615
615
  "document": "快速文本检测调用示例",
616
- "input": "https://ocr.tencentcloudapi.com/?Action=TextDetect\n&ImageUrl=https://xx/a.jpg\n&<公共请求参数>",
617
- "output": "{\n \"Response\": {\n \"HasText\": true,\n \"RequestId\": \"8cb7f106-3c74-4714-a54d-3cb2d69bb5a3\"\n }\n}",
618
- "title": "调用示例"
616
+ "input": "POST / HTTP/1.1\nHost: ocr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: TextDetect\n<公共请求参数>\n\n{\n \"ImageUrl\": \"https://ocr-demo-1254418846.cos.ap-guangzhou.myqcloud.com/general/TextDetect/TextDetect2.jpg\"\n}",
617
+ "output": "{\n \"Response\": {\n \"HasText\": false,\n \"RequestId\": \"8cb7f106-3c74-4714-a54d-3cb2d69bb5a3\"\n }\n}",
618
+ "title": "快速文本检测调用"
619
619
  }
620
620
  ],
621
621
  "TollInvoiceOCR": [
@@ -653,8 +653,8 @@
653
653
  "VatInvoiceVerifyNew": [
654
654
  {
655
655
  "document": "增值税发票核验示例代码",
656
- "input": "POST / HTTP/1.1\nHost: ocr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: VatInvoiceVerifyNew\n<公共请求参数>\n\n{\n \"InvoiceCode\": \"144002288010\",\n \"InvoiceNo\": \"04138864\",\n \"InvoiceDate\": \"2022-11-16\",\n \"Amount\": \"498.90\",\n \"CheckCode\": \"311400\",\n \"RegionCode\": \"4400\",\n \"SellerTaxCode\": \"44078819091887401X\",\n \"EnableCommonElectronic\": true\n}",
657
- "output": "{\n \"Response\": {\n \"Invoice\": {\n \"AmountWithTax\": \"498.90\",\n \"AmountWithoutTax\": \"0.00\",\n \"BuyerAddressPhone\": \"\",\n \"BuyerBankAccount\": \"\",\n \"BuyerName\": \"\",\n \"BuyerTaxCode\": \"\",\n \"CheckCode\": \"\",\n \"Code\": \"144002288010\",\n \"Date\": \"\",\n \"ElectronicType\": \"\",\n \"HasSellerList\": \"\",\n \"IsAbandoned\": \"N\",\n \"Items\": [],\n \"MachineNo\": \"\",\n \"Number\": \"04138864\",\n \"Remark\": \"\",\n \"RedLetterInvoiceMark\": false,\n \"IssuingTypeMark\": 1,\n \"SellerAddressPhone\": \"\",\n \"SellerBankAccount\": \"\",\n \"SellerAgentName\": \"\",\n \"SellerAgentTaxID\": \"\",\n \"SellerListTax\": \"\",\n \"SellerListTitle\": \"\",\n \"SellerName\": \"广州市天河区员美丽美食店\",\n \"SellerTaxCode\": \"\",\n \"TaxAmount\": \"0.00\",\n \"TaxBureau\": \"\",\n \"TrafficFreeFlag\": \"N\",\n \"Type\": \"102\"\n },\n \"PassInvoiceInfoList\": [],\n \"RequestId\": \"f3cd280c-6d3a-41c5-8493-4ed98f8b2755\",\n \"UsedVehicleInvoiceInfo\": {\n \"Auctioneer\": \"\",\n \"AuctioneerAddress\": \"\",\n \"AuctioneerBankAccount\": \"\",\n \"AuctioneerTaxpayerNum\": \"\",\n \"AuctioneerTel\": \"\",\n \"Buyer\": \"\",\n \"BuyerAddress\": \"\",\n \"BuyerNo\": \"\",\n \"BuyerTel\": \"\",\n \"ManagementOffice\": \"\",\n \"Market\": \"\",\n \"MarketAddress\": \"\",\n \"MarketBankAccount\": \"\",\n \"MarketTaxpayerNum\": \"\",\n \"MarketTel\": \"\",\n \"RegisterNo\": \"\",\n \"Seller\": \"\",\n \"SellerAddress\": \"\",\n \"SellerNo\": \"\",\n \"SellerTel\": \"\",\n \"TaxBureau\": \"\",\n \"VehicleIdentifyNo\": \"\",\n \"VehicleLicenseNo\": \"\",\n \"VehicleTotalPrice\": \"\"\n },\n \"VehicleInvoiceInfo\": {\n \"BizCheckFormNo\": \"\",\n \"BuyerNo\": \"\",\n \"CarType\": \"\",\n \"CertificateNo\": \"\",\n \"EngineNo\": \"\",\n \"ImportNo\": \"\",\n \"LimitCount\": \"\",\n \"MotorBankAccount\": \"\",\n \"MotorBankName\": \"\",\n \"MotorTaxRate\": \"\",\n \"PayTaxesNo\": \"\",\n \"PlateModel\": \"\",\n \"ProduceAddress\": \"\",\n \"SellerAddress\": \"\",\n \"SellerTel\": \"\",\n \"TaxtationOrgCode\": \"\",\n \"TaxtationOrgName\": \"\",\n \"Tonnage\": \"\",\n \"VinNo\": \"\"\n },\n \"ElectronicTrainTicket\": {\n \"BuyerName\": \"abc\",\n \"BuyerTaxCode\": \"abc\",\n \"Number\": \"abc\",\n \"Date\": \"abc\",\n \"TotalCN\": \"abc\",\n \"Tax\": \"abc\",\n \"ServiceType\": \"abc\",\n \"TimeGetOn\": \"abc\",\n \"TrainNumber\": \"abc\",\n \"Code\": \"abc\",\n \"SeatType\": \"abc\",\n \"DateGetOn\": \"abc\",\n \"TrainCabin\": \"abc\",\n \"StationGetOn\": \"abc\",\n \"ElectronicNumber\": \"abc\",\n \"PassengerName\": \"abc\",\n \"PassengerNo\": \"abc\",\n \"Amount\": \"abc\",\n \"StationGetOff\": \"abc\",\n \"TaxRate\": \"abc\",\n \"Seat\": \"abc\",\n \"Total\": \"abc\",\n \"CheckCode\": \"abc\",\n \"StateCode\": \"0\"\n },\n \"ElectronicAirTransport\": {\n \"Code\": \"abc\",\n \"Number\": \"abc\",\n \"Date\": \"abc\",\n \"Amount\": \"abc\",\n \"CheckCode\": \"abc\",\n \"Total\": \"abc\",\n \"DeductionMark\": \"abc\",\n \"StateCode\": \"abc\",\n \"BuyerTaxCode\": \"abc\",\n \"BuyerName\": \"abc\",\n \"DomesticInternationalMark\": \"abc\",\n \"PassengerName\": \"abc\",\n \"PassengerNo\": \"abc\",\n \"ElectronicNumber\": \"abc\",\n \"ElectronicAirTransportDetails\": [\n {\n \"FlightSegment\": \"abc\",\n \"StationGetOn\": \"abc\",\n \"StationGetOff\": \"abc\",\n \"Carrier\": \"abc\",\n \"FlightNumber\": \"abc\",\n \"SeatLevel\": \"abc\",\n \"FlightDate\": \"abc\",\n \"DepartureTime\": \"abc\",\n \"FareBasis\": \"abc\"\n }\n ]\n }\n }\n}",
656
+ "input": "POST / HTTP/1.1\nHost: ocr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: VatInvoiceVerifyNew\n<公共请求参数>\n\n{\n \"InvoiceCode\": \"1440****010\",\n \"InvoiceNo\": \"041***64\",\n \"InvoiceDate\": \"2022-11-16\",\n \"Amount\": \"498.90\",\n \"CheckCode\": \"31****0\",\n \"RegionCode\": \"4400\",\n \"SellerTaxCode\": \"44078*****401X\",\n \"EnableCommonElectronic\": true\n}",
657
+ "output": "{\n \"Response\": {\n \"Invoice\": {\n \"AmountWithTax\": \"498.90\",\n \"AmountWithoutTax\": \"0.00\",\n \"BuyerAddressPhone\": \"\",\n \"BuyerBankAccount\": \"\",\n \"BuyerName\": \"\",\n \"BuyerTaxCode\": \"\",\n \"CheckCode\": \"\",\n \"Code\": \"144002288010\",\n \"Date\": \"\",\n \"ElectronicType\": \"\",\n \"HasSellerList\": \"\",\n \"IsAbandoned\": \"N\",\n \"Items\": [],\n \"MachineNo\": \"\",\n \"Number\": \"04138864\",\n \"Remark\": \"\",\n \"RedLetterInvoiceMark\": false,\n \"IssuingTypeMark\": 1,\n \"SellerAddressPhone\": \"\",\n \"SellerBankAccount\": \"\",\n \"SellerAgentName\": \"\",\n \"SellerAgentTaxID\": \"\",\n \"SellerListTax\": \"\",\n \"SellerListTitle\": \"\",\n \"SellerName\": \"广州市天河区员美丽美食店\",\n \"SellerTaxCode\": \"\",\n \"TaxAmount\": \"0.00\",\n \"TaxBureau\": \"\",\n \"TrafficFreeFlag\": \"N\",\n \"Type\": \"102\"\n },\n \"PassInvoiceInfoList\": [],\n \"RequestId\": \"f3cd280c-6d3a-41c5-8493-4ed98f8b2755\",\n \"UsedVehicleInvoiceInfo\": {\n \"Auctioneer\": \"\",\n \"AuctioneerAddress\": \"\",\n \"AuctioneerBankAccount\": \"\",\n \"AuctioneerTaxpayerNum\": \"\",\n \"AuctioneerTel\": \"\",\n \"Buyer\": \"\",\n \"BuyerAddress\": \"\",\n \"BuyerNo\": \"\",\n \"BuyerTel\": \"\",\n \"ManagementOffice\": \"\",\n \"Market\": \"\",\n \"MarketAddress\": \"\",\n \"MarketBankAccount\": \"\",\n \"MarketTaxpayerNum\": \"\",\n \"MarketTel\": \"\",\n \"RegisterNo\": \"\",\n \"Seller\": \"\",\n \"SellerAddress\": \"\",\n \"SellerNo\": \"\",\n \"SellerTel\": \"\",\n \"TaxBureau\": \"\",\n \"VehicleIdentifyNo\": \"\",\n \"VehicleLicenseNo\": \"\",\n \"VehicleTotalPrice\": \"\"\n },\n \"VehicleInvoiceInfo\": {\n \"BizCheckFormNo\": \"\",\n \"BuyerNo\": \"\",\n \"CarType\": \"\",\n \"CertificateNo\": \"\",\n \"EngineNo\": \"\",\n \"ImportNo\": \"\",\n \"LimitCount\": \"\",\n \"MotorBankAccount\": \"\",\n \"MotorBankName\": \"\",\n \"MotorTaxRate\": \"\",\n \"PayTaxesNo\": \"\",\n \"PlateModel\": \"\",\n \"ProduceAddress\": \"\",\n \"SellerAddress\": \"\",\n \"SellerTel\": \"\",\n \"TaxtationOrgCode\": \"\",\n \"TaxtationOrgName\": \"\",\n \"Tonnage\": \"\",\n \"VinNo\": \"\"\n },\n \"ElectronicTrainTicket\": {\n \"BuyerName\": \"\",\n \"BuyerTaxCode\": \"\",\n \"Number\": \"\",\n \"Date\": \"\",\n \"TotalCN\": \"\",\n \"Tax\": \"\",\n \"ServiceType\": \"\",\n \"TimeGetOn\": \"\",\n \"TrainNumber\": \"\",\n \"Code\": \"\",\n \"SeatType\": \"\",\n \"DateGetOn\": \"\",\n \"TrainCabin\": \"\",\n \"StationGetOn\": \"\",\n \"ElectronicNumber\": \"\",\n \"PassengerName\": \"\",\n \"PassengerNo\": \"\",\n \"Amount\": \"\",\n \"StationGetOff\": \"\",\n \"TaxRate\": \"\",\n \"Seat\": \"\",\n \"Total\": \"\",\n \"CheckCode\": \"\",\n \"StateCode\": \"\"\n },\n \"ElectronicAirTransport\": {\n \"Code\": \"\",\n \"Number\": \"\",\n \"Date\": \"\",\n \"Amount\": \"\",\n \"CheckCode\": \"\",\n \"Total\": \"\",\n \"DeductionMark\": \"\",\n \"StateCode\": \"\",\n \"BuyerTaxCode\": \"\",\n \"BuyerName\": \"\",\n \"DomesticInternationalMark\": \"\",\n \"PassengerName\": \"\",\n \"PassengerNo\": \"\",\n \"ElectronicNumber\": \"\",\n \"ElectronicAirTransportDetails\": [\n {\n \"FlightSegment\": \"\",\n \"StationGetOn\": \"\",\n \"StationGetOff\": \"\",\n \"Carrier\": \"\",\n \"FlightNumber\": \"\",\n \"SeatLevel\": \"\",\n \"FlightDate\": \"\",\n \"DepartureTime\": \"\",\n \"FareBasis\": \"\"\n }\n ]\n }\n }\n}",
658
658
  "title": "增值税发票核验示例代码"
659
659
  }
660
660
  ],
@@ -699,7 +699,7 @@
699
699
  "VinOCR": [
700
700
  {
701
701
  "document": "",
702
- "input": "https://ocr.tencentcloudapi.com/?Action=VinOCR\n&ImageUrl=https://ocr-demo-1254418846.cos.ap-guangzhou.myqcloud.com/vehicle/VinOCR/VinOCR1.jpg\n&<公共请求参数>",
702
+ "input": "POST / HTTP/1.1\nHost: ocr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: VinOCR\n<公共请求参数>\n\n{\n \"ImageUrl\": \"https://ocr-demo-1254418846.cos.ap-guangzhou.myqcloud.com/vehicle/VinOCR/VinOCR1.jpg\"\n}",
703
703
  "output": "{\n \"Response\": {\n \"Vin\": \"LSGPC52H9GF125161\",\n \"RequestId\": \"c59d9002-6c8c-426d-b57f-a8837dee2c7c\"\n }\n}",
704
704
  "title": "车辆VIN码识别示例代码"
705
705
  }
@@ -1515,22 +1515,20 @@
1515
1515
  {
1516
1516
  "disabled": false,
1517
1517
  "document": "参数名",
1518
- "example": "",
1518
+ "example": "Domain",
1519
1519
  "member": "string",
1520
1520
  "name": "Name",
1521
1521
  "required": true,
1522
- "type": "string",
1523
- "value_allowed_null": false
1522
+ "type": "string"
1524
1523
  },
1525
1524
  {
1526
1525
  "disabled": false,
1527
1526
  "document": "参数值数组",
1528
- "example": "",
1527
+ "example": "qq.com",
1529
1528
  "member": "string",
1530
1529
  "name": "Values",
1531
1530
  "required": true,
1532
- "type": "list",
1533
- "value_allowed_null": false
1531
+ "type": "list"
1534
1532
  }
1535
1533
  ],
1536
1534
  "usage": "in"
@@ -2378,9 +2376,10 @@
2378
2376
  {
2379
2377
  "disabled": false,
2380
2378
  "document": "标签键",
2381
- "example": "",
2379
+ "example": "key1",
2382
2380
  "member": "string",
2383
2381
  "name": "TagKey",
2382
+ "output_required": true,
2384
2383
  "required": true,
2385
2384
  "type": "string",
2386
2385
  "value_allowed_null": false
@@ -2388,9 +2387,10 @@
2388
2387
  {
2389
2388
  "disabled": false,
2390
2389
  "document": "标签值",
2391
- "example": "",
2390
+ "example": "value1",
2392
2391
  "member": "string",
2393
2392
  "name": "TagValue",
2393
+ "output_required": true,
2394
2394
  "required": true,
2395
2395
  "type": "string",
2396
2396
  "value_allowed_null": false
@@ -137,7 +137,7 @@
137
137
  {
138
138
  "disabled": false,
139
139
  "document": "存储桶全名,新建后不可更改。当前版本不再支持指定存储桶。",
140
- "example": "",
140
+ "example": "demo-bucket-13000000000",
141
141
  "member": "string",
142
142
  "name": "BucketName",
143
143
  "required": false,
@@ -146,7 +146,7 @@
146
146
  {
147
147
  "disabled": false,
148
148
  "document": "存储桶所在地域,新建后不可更改。当前版本不再支持指定存储桶所在地域。",
149
- "example": "",
149
+ "example": "ap-guangzhou",
150
150
  "member": "string",
151
151
  "name": "BucketRegion",
152
152
  "required": false,
@@ -384,7 +384,7 @@
384
384
  {
385
385
  "disabled": false,
386
386
  "document": "自定义信息。不超过 255 个字符。",
387
- "example": "",
387
+ "example": "普通用户",
388
388
  "member": "string",
389
389
  "name": "Customize",
390
390
  "required": false,
@@ -529,7 +529,7 @@
529
529
  {
530
530
  "disabled": false,
531
531
  "document": "自定义信息。\n注意:此字段可能返回 null,表示取不到有效值。",
532
- "example": "",
532
+ "example": "普通用户",
533
533
  "member": "string",
534
534
  "name": "Customize",
535
535
  "output_required": false,
@@ -1628,7 +1628,7 @@
1628
1628
  {
1629
1629
  "disabled": false,
1630
1630
  "document": "自定义信息。不超过 255 个字符。",
1631
- "example": "",
1631
+ "example": "普通用户",
1632
1632
  "member": "string",
1633
1633
  "name": "Customize",
1634
1634
  "required": false,
@@ -1773,7 +1773,7 @@
1773
1773
  {
1774
1774
  "disabled": false,
1775
1775
  "document": "自定义信息。",
1776
- "example": "",
1776
+ "example": "普通用户",
1777
1777
  "member": "string",
1778
1778
  "name": "Customize",
1779
1779
  "output_required": false,
@@ -1997,7 +1997,7 @@
1997
1997
  {
1998
1998
  "disabled": false,
1999
1999
  "document": "短信验证码",
2000
- "example": "1234",
2000
+ "example": "2261",
2001
2001
  "member": "string",
2002
2002
  "name": "Code",
2003
2003
  "required": true,
@@ -115,7 +115,7 @@
115
115
  "VerifySmsCode": [
116
116
  {
117
117
  "document": "",
118
- "input": "POST / HTTP/1.1\nHost: smh.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: VerifySmsCode\n<公共请求参数>\n\n{\n \"Purpose\": \"BindSuperAdmin\",\n \"InstanceId\": \"n0v9tdme\",\n \"PhoneNumber\": \"18999999999\",\n \"Code\": \"1234\"\n}",
118
+ "input": "POST / HTTP/1.1\nHost: smh.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: VerifySmsCode\n<公共请求参数>\n\n{\n \"Purpose\": \"BindSuperAdmin\",\n \"InstanceId\": \"n0v9tdme\",\n \"PhoneNumber\": \"18999999999\",\n \"Code\": \"2261\"\n}",
119
119
  "output": "{\n \"Response\": {\n \"RequestId\": \"98a878b5-8c16-4788-a7e7-4b1a19a461db\"\n }\n}",
120
120
  "title": "验证短信验证码"
121
121
  }
@@ -1213,7 +1213,7 @@
1213
1213
  },
1214
1214
  {
1215
1215
  "disabled": false,
1216
- "document": "国家码或地区名,例如 China,可参考 [国际/港澳台短信价格总览](https://cloud.tencent.com/document/product/382/18051#.E6.97.A5.E7.BB.93.E5.90.8E.E4.BB.98.E8.B4.B9.3Ca-id.3D.22post-payment.22.3E.3C.2Fa.3E)",
1216
+ "document": "国家码或地区名,例如 China,可参考 [国际/港澳台短信价格总览](https://cloud.tencent.com/document/product/382/18051)",
1217
1217
  "example": "China",
1218
1218
  "member": "string",
1219
1219
  "name": "IsoName",