tccli-intl-en 3.0.1283.1__tar.gz → 3.0.1284.1__tar.gz

{tccli_intl_en-3.0.1283.1/tccli_intl_en.egg-info → tccli_intl_en-3.0.1284.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tccli-intl-en
-Version: 3.0.1283.1
+Version: 3.0.1284.1
 Summary: Universal Command Line Environment for Tencent Cloud
 Home-page: https://github.com/TencentCloud/tencentcloud-cli-intl-en.git
 Author: Tencent Cloud
@@ -21,7 +21,7 @@ Classifier: Programming Language :: Python :: 3.4
 Classifier: Programming Language :: Python :: 3.5
 Classifier: Programming Language :: Python :: 3.6
 License-File: LICENSE
-Requires-Dist: tencentcloud-sdk-python-intl-en>=3.0.1283
+Requires-Dist: tencentcloud-sdk-python-intl-en>=3.0.1284
 Requires-Dist: jmespath==0.10.0
 Requires-Dist: six==1.16.0
 

tccli_intl_en-3.0.1284.1/tccli/__init__.py

@@ -0,0 +1 @@
+__version__ = '3.0.1284.1'

{tccli_intl_en-3.0.1283.1 → tccli_intl_en-3.0.1284.1}/tccli/services/cvm/v20170312/api.json

@@ -2809,7 +2809,7 @@
         {
           "disabled": false,
           "document": "ID list of spread placement groups. You can operate up to 10 spread placement groups in each request.",
-          "example": "ps-21q9ibvr",
+          "example": "[\"ps-21q9ibvr\"]",
           "member": "string",
           "name": "DisasterRecoverGroupIds",
           "required": false,
@@ -2845,7 +2845,7 @@
         {
           "disabled": false,
           "document": "<li> `tag-key` - String - Optional - Filter by the tag key.</li>\n<li>`tag-value` - String - Optional - Filter by the tag value.</li>\n<li> `tag:tag-key` - String - Optional - Filter by the tag key-value pair. Replace `tag-key` with the actual tag keys.</li>\nEach request can have up to 10 `Filters` and 5 `Filters.Values`.",
-          "example": "[     {         \"Name\": \"tag-key \",         \"Values\": [             \"myTag\"         ]     } ]",
+          "example": "无",
           "member": "Filter",
           "name": "Filters",
           "required": false,
@@ -2860,7 +2860,7 @@
         {
           "disabled": false,
           "document": "Information on spread placement groups.",
-          "example": "[     {         \"DisasterRecoverGroupId\": \"ps-21q9ibvr\",         \"Name\": \"数据库业务\",         \"Type\": \"RACK\",         \"CvmQuotaTotal\": 30,         \"CurrentNum\": 0,         \"InstanceIds\": [],         \"CreateTime\": \"2018-04-19T02:47:12Z\"     } ]",
+          "example": "无",
           "member": "DisasterRecoverGroup",
           "name": "DisasterRecoverGroupSet",
           "output_required": true,
@@ -3066,7 +3066,7 @@
         },
         {
           "disabled": false,
-          "document": "Filters. Each request can have up to 10 `Filters`, and 5 `Filters.Values` for each filter. `ImageIds` and `Filters` cannot be specified at the same time. See details:\n\n<li><strong>image-id</strong></li>\n<p style=\"padding-left: 30px;\">Filter by the <strong>image ID</strong>.</p><p style=\"padding-left: 30px;\">Type: String</p><p style=\"padding-left: 30px;\">Optional</p>\n<li><strong>image-type</strong></li>\n<p style=\"padding-left: 30px;\">Filter by the <strong>image type</strong>.</p><p style=\"padding-left: 30px;\">Type: String</p><p style=\"padding-left: 30px;\">Optional</p><p style=\"padding-left: 30px;\">Options:</p><p style=\"padding-left: 30px;\">`PRIVATE_IMAGE`: Private images (images created by this account)</p><p style=\"padding-left: 30px;\">`PUBLIC_IMAGE`: Public images (Tencent Cloud official images)</p><p style=\"padding-left: 30px;\">`SHARED_IMAGE`: Shared images (images shared by other accounts to this account)</p>\n<li><strong>image-name</strong></li>\n<p style=\"padding-left: 30px;\">Filter by the <strong>image name</strong>.</p><p style=\"padding-left: 30px;\">Type: String</p><p style=\"padding-left: 30px;\">Optional</p>\n<li><strong>platform</strong></li>\n<p style=\"padding-left: 30px;\">Filter by the <strong>image operating system</strong>, such as `CentOS`.</p><p style=\"padding-left: 30px;\">Type: String</p><p style=\"padding-left: 30px;\">Optional</p>\n<li><strong>tag-key</strong></li>\n<p style=\"padding-left: 30px;\">Filter by the <strong>tag key</strong>.</p><p style=\"padding-left: 30px;\">Type: String</p><p style=\"padding-left: 30px;\">Optional</p>\n<li><strong>tag-value</strong></li>\n<p style=\"padding-left: 30px;\">Filter by the <strong>tag value</strong>.</p><p style=\"padding-left: 30px;\">Type: String</p><p style=\"padding-left: 30px;\">Optional</p>\n<li><strong>tag:tag-key</strong></li>\n<p style=\"padding-left: 30px;\">Filter by the <strong>tag key-value pair</strong>. Replace “tag-key” with the actual value. </p><p style=\"padding-left: 30px;\">Type: String</p><p style=\"padding-left: 30px;\">Optional</p>",
+          "document": "Filters. Each request can have up to 10 `Filters`, and 5 `Filters.Values` for each filter. `ImageIds` and `Filters` cannot be specified at the same time. See details:\n\n<li><strong>image-id</strong></li>\n<p style=\"padding-left: 30px;\">Filter by the <strong>image ID</strong>.</p><p style=\"padding-left: 30px;\">Type: String</p><p style=\"padding-left: 30px;\">Optional</p>\n<li><strong>image-type</strong></li>\n<p style=\"padding-left: 30px;\">Filter by the <strong>image type</strong>.</p><p style=\"padding-left: 30px;\">Type: String</p><p style=\"padding-left: 30px;\">Optional</p><p style=\"padding-left: 30px;\">Options:</p><p style=\"padding-left: 30px;\">`PRIVATE_IMAGE`: Private images (images created by this account)</p><p style=\"padding-left: 30px;\">`PUBLIC_IMAGE`: Public images (Tencent Cloud official images)</p><p style=\"padding-left: 30px;\">`SHARED_IMAGE`: Shared images (images shared by other accounts to this account)</p>\n<li><strong>image-name</strong></li>\n<p style=\"padding-left: 30px;\">Filter by the <strong>image name</strong>.</p><p style=\"padding-left: 30px;\">Type: String</p><p style=\"padding-left: 30px;\">Optional</p>\n<li><strong>platform</strong></li>\n<p style=\"padding-left: 30px;\">Filter by the <strong>image operating system</strong>, such as `CentOS`.</p><p style=\"padding-left: 30px;\">Type: String</p><p style=\"padding-left: 30px;\">Optional</p>\n<li><strong>tag-key</strong></li>\n<p style=\"padding-left: 30px;\">Filter by the <strong>tag key</strong>.</p><p style=\"padding-left: 30px;\">Type: String</p><p style=\"padding-left: 30px;\">Optional</p>\n<li><strong>tag-value</strong></li>\n<p style=\"padding-left: 30px;\">Filter by the <strong>tag value</strong>.</p><p style=\"padding-left: 30px;\">Type: String</p><p style=\"padding-left: 30px;\">Optional</p>\n<li><strong>tag:tag-key</strong></li>\n<p style=\"padding-left: 30px;\">Filter by the <strong>tag key-value pair</strong>. Replace \"tag-key\" with the actual value. </p><p style=\"padding-left: 30px;\">Type: String</p><p style=\"padding-left: 30px;\">Optional</p>",
           "example": "无",
           "member": "Filter",
           "name": "Filters",
@@ -3093,8 +3093,8 @@
         },
         {
           "disabled": false,
-          "document": "Instance type, e.g. `S1.SMALL1`",
-          "example": "\"S1.SMALL1\"",
+          "document": "Instance type, e.g. `SA5.MEDIUM2`",
+          "example": "SA5.MEDIUM2",
           "member": "string",
           "name": "InstanceType",
           "required": false,
@@ -3112,7 +3112,7 @@
           "example": "无",
           "member": "Image",
           "name": "ImageSet",
-          "required": true,
+          "output_required": true,
           "type": "list",
           "value_allowed_null": false
         },
@@ -3122,7 +3122,7 @@
           "example": "1",
           "member": "int64",
           "name": "TotalCount",
-          "required": true,
+          "output_required": true,
           "type": "int",
           "value_allowed_null": false
         },
@@ -3463,7 +3463,7 @@
         {
           "disabled": false,
           "document": "Key pair ID(s) in the format of `skey-11112222`. This API supports using multiple IDs as filters at the same time. For more information on the format of this parameter, see the `id.N` section in [API Introduction](https://intl.cloud.tencent.com/document/api/213/15688?from_cn_redirect=1). You cannot specify `KeyIds` and `Filters` at the same time. You can log in to the [console](https://console.cloud.tencent.com/cvm/index) to query the key pair IDs.",
-          "example": "skey-11112222",
+          "example": "[\"skey-11112222\"]",
           "member": "string",
           "name": "KeyIds",
           "required": false,
@@ -3685,7 +3685,7 @@
           "name": "TotalCount",
           "output_required": true,
           "type": "int",
-          "value_allowed_null": true
+          "value_allowed_null": false
         },
         {
           "disabled": false,
@@ -3695,7 +3695,7 @@
           "name": "LaunchTemplateSet",
           "output_required": true,
           "type": "list",
-          "value_allowed_null": true
+          "value_allowed_null": false
         },
         {
           "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
@@ -4804,7 +4804,7 @@
         {
           "disabled": false,
           "document": "Image name",
-          "example": "test",
+          "example": "myImg",
           "member": "string",
           "name": "ImageName",
           "output_required": true,
@@ -4814,7 +4814,7 @@
         {
           "disabled": false,
           "document": "Image description",
-          "example": "test",
+          "example": "tencentcloud",
           "member": "string",
           "name": "ImageDescription",
           "output_required": true,
@@ -4864,7 +4864,7 @@
         {
           "disabled": false,
           "document": "Image creator",
-          "example": "xxx",
+          "example": "tencentcloud",
           "member": "string",
           "name": "ImageCreator",
           "output_required": true,
@@ -4884,7 +4884,7 @@
         {
           "disabled": false,
           "document": "Synchronization percentage\nNote: This field may return null, indicating that no valid value is found.",
-          "example": "null",
+          "example": "60",
           "member": "int64",
           "name": "SyncPercent",
           "output_required": true,
@@ -4899,27 +4899,27 @@
           "name": "IsSupportCloudinit",
           "output_required": true,
           "type": "bool",
-          "value_allowed_null": true
+          "value_allowed_null": false
         },
         {
           "disabled": false,
           "document": "Information on the snapshots associated with the image\nNote: This field may return null, indicating that no valid value is found.",
-          "example": "[]",
+          "example": "无",
           "member": "Snapshot",
           "name": "SnapshotSet",
           "output_required": true,
           "type": "list",
-          "value_allowed_null": true
+          "value_allowed_null": false
         },
         {
           "disabled": false,
           "document": "The list of tags bound to the image.\nNote: This field may return `null`, indicating that no valid value was found.",
-          "example": "[]",
+          "example": "无",
           "member": "Tag",
           "name": "Tags",
           "output_required": true,
           "type": "list",
-          "value_allowed_null": true
+          "value_allowed_null": false
         },
         {
           "disabled": false,
@@ -4939,7 +4939,7 @@
           "name": "ImageFamily",
           "output_required": false,
           "type": "string",
-          "value_allowed_null": true
+          "value_allowed_null": false
         },
         {
           "disabled": false,
@@ -5211,7 +5211,7 @@
         },
         {
           "disabled": false,
-          "document": "Reserved instance name.<br><li>The RI name defaults to “unnamed” if this parameter is left empty.</li><li>You can enter any name within 60 characters (including the pattern string).</li>",
+          "document": "Reserved instance name.<br><li>The RI name defaults to \"unnamed\" if this parameter is left empty.</li><li>You can enter any name within 60 characters (including the pattern string).</li>",
           "example": "myReservedInstance",
           "member": "string",
           "name": "ReservedInstanceName",
@@ -7101,7 +7101,7 @@
           "name": "LatestVersionNumber",
           "output_required": true,
           "type": "int",
-          "value_allowed_null": true
+          "value_allowed_null": false
         },
         {
           "disabled": false,
@@ -7111,7 +7111,7 @@
           "name": "LaunchTemplateId",
           "output_required": true,
           "type": "string",
-          "value_allowed_null": true
+          "value_allowed_null": false
         },
         {
           "disabled": false,
@@ -7121,7 +7121,7 @@
           "name": "LaunchTemplateName",
           "output_required": true,
           "type": "string",
-          "value_allowed_null": true
+          "value_allowed_null": false
         },
         {
           "disabled": false,
@@ -7131,7 +7131,7 @@
           "name": "DefaultVersionNumber",
           "output_required": true,
           "type": "int",
-          "value_allowed_null": true
+          "value_allowed_null": false
         },
         {
           "disabled": false,
@@ -7141,17 +7141,17 @@
           "name": "LaunchTemplateVersionCount",
           "output_required": true,
           "type": "int",
-          "value_allowed_null": true
+          "value_allowed_null": false
         },
         {
           "disabled": false,
           "document": "UIN of the user who created the template.\nNote: This field may return `null`, indicating that no valid values can be obtained.",
-          "example": "123456",
+          "example": "1230000",
           "member": "string",
           "name": "CreatedBy",
           "output_required": true,
           "type": "string",
-          "value_allowed_null": true
+          "value_allowed_null": false
         },
         {
           "disabled": false,
@@ -7161,7 +7161,7 @@
           "name": "CreationTime",
           "output_required": true,
           "type": "string",
-          "value_allowed_null": true
+          "value_allowed_null": false
         }
       ],
       "usage": "out"
@@ -8192,7 +8192,7 @@
         {
           "disabled": false,
           "document": "Whether to force shut down a running instances. Default value: TRUE.",
-          "example": "无",
+          "example": "false",
           "member": "bool",
           "name": "ForceStop",
           "required": false,
@@ -8201,7 +8201,7 @@
         {
           "disabled": false,
           "document": "Whether to keep the host name. Default value: FALSE.",
-          "example": "无",
+          "example": "false",
           "member": "bool",
           "name": "ReserveHostName",
           "required": false,
@@ -8502,7 +8502,7 @@
         },
         {
           "disabled": false,
-          "document": "Reserved instance name.<br><li>The RI name defaults to “unnamed” if this parameter is left empty.</li><li>You can enter any name within 60 characters (including the pattern string).</li>",
+          "document": "Reserved instance name.<br><li>The RI name defaults to \"unnamed\" if this parameter is left empty.</li><li>You can enter any name within 60 characters (including the pattern string).</li>",
           "example": "myReservedInstance",
           "member": "string",
           "name": "ReservedInstanceName",
@@ -8844,7 +8844,7 @@
           "name": "FixedPriceDiscount",
           "output_required": false,
           "type": "float",
-          "value_allowed_null": true
+          "value_allowed_null": false
         },
         {
           "disabled": false,
@@ -8854,7 +8854,7 @@
           "name": "UsagePriceDiscount",
           "output_required": false,
           "type": "float",
-          "value_allowed_null": true
+          "value_allowed_null": false
         }
       ],
       "usage": "out"
@@ -10039,30 +10039,30 @@
         {
           "disabled": false,
           "document": "Snapshot ID.",
-          "example": "",
+          "example": "snap-2y1v",
           "member": "string",
           "name": "SnapshotId",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
         {
           "disabled": false,
           "document": "Type of the cloud disk used to create the snapshot. Valid values:\nSYSTEM_DISK: system disk\nDATA_DISK: data disk",
-          "example": "",
+          "example": "SYSTEM_DISK",
           "member": "string",
           "name": "DiskUsage",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
         {
           "disabled": false,
           "document": "Size of the cloud disk used to create the snapshot; unit: GB.",
-          "example": "",
+          "example": "50",
           "member": "int64",
           "name": "DiskSize",
-          "required": true,
+          "output_required": true,
           "type": "int",
           "value_allowed_null": false
         }

{tccli_intl_en-3.0.1283.1 → tccli_intl_en-3.0.1284.1}/tccli/services/cvm/v20170312/examples.json

@@ -161,8 +161,8 @@
     "DescribeDisasterRecoverGroups": [
       {
         "document": "This example shows you how to query the information of a spread placement group.",
-        "input": "POST / HTTP/1.1\nHost: cvm.intl.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDisasterRecoverGroups\n<Common request parameters>\n\n{\n    \"Offset\": 0,\n    \"Limit\": 100,\n    \"Filters\": [\n        {\n            \"Name\": \"tag:FOO_886\",\n            \"Values\": [\n                \"BAR_886\"\n            ]\n        }\n    ]\n}",
-        "output": "{\n    \"Response\": {\n        \"DisasterRecoverGroupSet\": [\n            {\n                \"Affinity\": 1,\n                \"CreateTime\": \"2024-08-28T10:04:56Z\",\n                \"CurrentNum\": 0,\n                \"CvmQuotaTotal\": 60,\n                \"DisasterRecoverGroupId\": \"ps-0f03mwkn\",\n                \"InstanceIds\": [],\n                \"Name\": \"HostDisasterRecoverGroup\",\n                \"Tags\": [\n                    {\n                        \"Key\": \"FOO_886\",\n                        \"Value\": \"BAR_886\"\n                    }\n                ],\n                \"Type\": \"HOST\"\n            },\n            {\n                \"Affinity\": 1,\n                \"CreateTime\": \"2024-08-13T04:16:19Z\",\n                \"CurrentNum\": 0,\n                \"CvmQuotaTotal\": 20,\n                \"DisasterRecoverGroupId\": \"ps-ali72vwj\",\n                \"InstanceIds\": [],\n                \"Name\": \"SWDisasterRecoverGroup\",\n                \"Tags\": [\n                    {\n                        \"Key\": \"FOO_886\",\n                        \"Value\": \"BAR_886\"\n                    }\n                ],\n                \"Type\": \"SW\"\n            }\n        ],\n        \"RequestId\": \"52eca90d-08c8-4887-abf0-78d8155cfcfd\",\n        \"TotalCount\": 2\n    }\n}",
+        "input": "POST / HTTP/1.1\nHost: cvm.intl.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDisasterRecoverGroups\n<Common request parameters>\n\n{\n    \"Offset\": 0,\n    \"Limit\": 100,\n    \"Filters\": [\n        {\n            \"Name\": \"tag:myTagKey\",\n            \"Values\": [\n                \"myTagVlue\"\n            ]\n        }\n    ]\n}",
+        "output": "{\n    \"Response\": {\n        \"DisasterRecoverGroupSet\": [\n            {\n                \"Affinity\": 1,\n                \"CreateTime\": \"2024-08-28T10:04:56Z\",\n                \"CurrentNum\": 0,\n                \"CvmQuotaTotal\": 60,\n                \"DisasterRecoverGroupId\": \"ps-0f03mwkn\",\n                \"InstanceIds\": [],\n                \"Name\": \"HostDisasterRecoverGroup\",\n                \"Tags\": [\n                    {\n                        \"Key\": \"myTagKey\",\n                        \"Value\": \"myTagVlue\"\n                    }\n                ],\n                \"Type\": \"HOST\"\n            },\n            {\n                \"Affinity\": 1,\n                \"CreateTime\": \"2024-08-13T04:16:19Z\",\n                \"CurrentNum\": 0,\n                \"CvmQuotaTotal\": 20,\n                \"DisasterRecoverGroupId\": \"ps-ali72vwj\",\n                \"InstanceIds\": [],\n                \"Name\": \"SWDisasterRecoverGroup\",\n                \"Tags\": [\n                    {\n                        \"Key\": \"myTagKey\",\n                        \"Value\": \"myTagVlue\"\n                    }\n                ],\n                \"Type\": \"SW\"\n            }\n        ],\n        \"RequestId\": \"52eca90d-08c8-4887-abf0-78d8155cfcfd\",\n        \"TotalCount\": 2\n    }\n}",
         "title": "Querying the information of a spread placement group"
       }
     ],
@@ -207,7 +207,7 @@
       },
       {
         "document": "This example shows you how to query all private images under an account.",
-        "input": "POST / HTTP/1.1\nHost: cvm.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeImages\n<Common request parameters>\n\n{\n    \"Filters\": [\n        {\n            \"Values\": [\n                \"PRIVATE_IMAGE\"\n            ],\n            \"Name\": \"image-type\"\n        }\n    ]\n}",
+        "input": "POST / HTTP/1.1\nHost: cvm.intl.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeImages\n<Common request parameters>\n\n{\n    \"Filters\": [\n        {\n            \"Values\": [\n                \"PRIVATE_IMAGE\"\n            ],\n            \"Name\": \"image-type\"\n        }\n    ],\n    \"Offset\": 0,\n    \"Limit\": 1\n}",
         "output": "{\n    \"Response\": {\n        \"TotalCount\": 408,\n        \"ImageSet\": [\n            {\n                \"OsName\": \"CentOS 7.4 64-bit\",\n                \"ImageSize\": 20,\n                \"ImageType\": \"PRIVATE_IMAGE\",\n                \"CreatedTime\": \"2020-09-22T00:00:00+00:00\",\n                \"ImageDescription\": \"test-image\",\n                \"ImageSource\": \"CREATE_IMAGE\",\n                \"ImageId\": \"img-qlzp4oea\",\n                \"ImageName\": \"test-image\",\n                \"ImageCreator\": \"3205597606\",\n                \"ImageState\": \"NORMAL\",\n                \"SyncPercent\": null,\n                \"SnapshotSet\": [\n                    {\n                        \"SnapshotId\": \"snap-gqa37j2p\",\n                        \"DiskUsage\": \"SYSTEM_DISK\",\n                        \"DiskSize\": 20\n                    }\n                ],\n                \"Tags\": [\n                    {\n                        \"Value\": \"xx\",\n                        \"Key\": \"xx\"\n                    }\n                ],\n                \"Architecture\": \"x86_64\",\n                \"Platform\": \"CentOS\",\n                \"IsSupportCloudinit\": true\n            }\n        ],\n        \"RequestId\": \"5908394c-5b3f-42e0-a537-8410553890a5\"\n    }\n}",
         "title": "Querying an image by the image type"
       }
@@ -223,7 +223,7 @@
     "DescribeInstanceFamilyConfigs": [
       {
         "document": "This example shows you how to query the supported instance families in the Guangzhou region.",
-        "input": "POST / HTTP/1.1\nHost: cvm.intl.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeInstanceFamilyConfigs\n&<Common request parameters>\n\n{}",
+        "input": "POST / HTTP/1.1\nHost: cvm.intl.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeInstanceFamilyConfigs\nX-TC-Language: en-US\n&<Common request parameters>\n\n{}",
         "output": "{\n    \"Response\": {\n        \"InstanceFamilyConfigSet\": [\n            {\n                \"InstanceFamilyName\": \"Standard S1\",\n                \"InstanceFamily\": \"S1\"\n            },\n            {\n                \"InstanceFamilyName\": \"Network-optimized N1\",\n                \"InstanceFamily\": \"N1\"\n            },\n            {\n                \"InstanceFamilyName\": \"High IO I1\",\n                \"InstanceFamily\": \"I1\"\n            },\n            {\n                \"InstanceFamilyName\": \"MEM optimized M1\",\n                \"InstanceFamily\": \"M1\"\n            },\n            {\n                \"InstanceFamilyName\": \"Standard S2\",\n                \"InstanceFamily\": \"S2\"\n            },\n            {\n                \"InstanceFamilyName\": \"Standard network enhanced SN2\",\n                \"InstanceFamily\": \"SN2\"\n            },\n            {\n                \"InstanceFamilyName\": \"High IO I2\",\n                \"InstanceFamily\": \"I2\"\n            },\n            {\n                \"InstanceFamilyName\": \"MEM optimized M2\",\n                \"InstanceFamily\": \"M2\"\n            },\n            {\n                \"InstanceFamilyName\": \"Compute C2\",\n                \"InstanceFamily\": \"C2\"\n            },\n            {\n                \"InstanceFamilyName\": \"Compute Network-optimized CN2\",\n                \"InstanceFamily\": \"CN2\"\n            },\n            {\n                \"InstanceFamilyName\": \"Standard S3\",\n                \"InstanceFamily\": \"S3\"\n            },\n            {\n                \"InstanceFamilyName\": \"Compute C3\",\n                \"InstanceFamily\": \"C3\"\n            },\n            {\n                \"InstanceFamilyName\": \"FPGA FX2\",\n                \"InstanceFamily\": \"FX2\"\n            },\n            {\n                \"InstanceFamilyName\": \"GPU compute GN2\",\n                \"InstanceFamily\": \"GN2\"\n            },\n            {\n                \"InstanceFamilyName\": \"GPU rendering GA2\",\n                \"InstanceFamily\": \"GA2\"\n            },\n            {\n                \"InstanceFamilyName\": \"GPU compute GN8\",\n                \"InstanceFamily\": \"GN8\"\n            },\n            {\n                \"InstanceFamilyName\": \"Dedicated\",\n                \"InstanceFamily\": \"CDH\"\n            },\n            {\n                \"InstanceFamilyName\": \"Shared core\",\n                \"InstanceFamily\": \"SHARED\"\n            }\n        ],\n        \"RequestId\": \"b061782b-934a-4e53-b1eb-d5f2fed8130e\"\n    }\n}",
         "title": "Querying supported instance families"
       }
@@ -283,7 +283,7 @@
     "DescribeKeyPairs": [
       {
         "document": "This example shows you how to query the list of key pairs.",
-        "input": "POST / HTTP/1.1\nHost: cvm.intl.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: RunInstances\n<Common request parameters>\n\n{\n    \"Filters\": [\n        {\n            \"Name\": \"key-name\",\n            \"Values\": [\n                \"MyKeyPair\"\n            ]\n        }\n    ],\n    \"Offset\": 0,\n    \"Limit\": 1\n}",
+        "input": "POST / HTTP/1.1\nHost: cvm.intl.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeKeyPairs\n<Common request parameters>\n\n{\n    \"Filters\": [\n        {\n            \"Name\": \"key-name\",\n            \"Values\": [\n                \"MyKeyPair\"\n            ]\n        }\n    ],\n    \"Offset\": 0,\n    \"Limit\": 1\n}",
         "output": "{\n    \"Response\": {\n        \"KeyPairSet\": [\n            {\n                \"AssociatedInstanceIds\": [],\n                \"CreatedTime\": \"2025-10-16T08:12:48Z\",\n                \"Description\": \"\",\n                \"KeyId\": \"skey-1q8j7b93\",\n                \"KeyName\": \"MyKeyPair\",\n                \"ProjectId\": 0,\n                \"PublicKey\": \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC8gSdflU6iZDlLp3uRgfIQ7d9gl4SzF2yO9BJ1VyzhgWkbYsUS8u7qbwxC6UeAc8364FhT4MjVjXi/+6hYpDnnMiK6lqKBxotLupUtkVmYt+osdPP+y3OcCzTqHWCsY3s7AvyvD41+nuH6LrpXZ4LlHJynPc66eqd5gpnCyg2O1sxW+pd2Zigk0QGWiCuVtm4ICEp3DNHG/9wlVzd++xODf398JU3ebxBsXfe46mFSkyBVbsJLuNueZd4eGDS3q0WhimnvpgZoYOGsNPl4GBLCGOHWZrl/9hE+az6P8W7QwpVe5gvy5MG3usk6zpc0f/diZrdXX7 skey-1q8j7b93\",\n                \"Tags\": [\n                    {\n                        \"Key\": \"MyKeyPairTagKey\",\n                        \"Value\": \"MyKeyPairTagValue\"\n                    }\n                ]\n            }\n        ],\n        \"RequestId\": \"eebd54d0-a305-4716-9a84-6017ac14e8c8\",\n        \"TotalCount\": 120\n    }\n}",
         "title": "Querying the List of Key Pairs"
       }
@@ -299,8 +299,8 @@
     "DescribeLaunchTemplates": [
       {
         "document": " ",
-        "input": "POST / HTTP/1.1\nHost: cvm.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeLaunchTemplates\n<Common request parameters>\n\n{\n    \"LaunchTemplateIds\": [\n        \"lt-q9t8j8eg\"\n    ]\n}",
-        "output": "{\n    \"Response\": {\n        \"TotalCount\": 1,\n        \"LaunchTemplateSet\": [\n            {\n                \"LatestVersionNumber\": 12,\n                \"LaunchTemplateId\": \"lt-q9t8j8eg\",\n                \"LaunchTemplateName\": \"Not named foo\\\"'\\\"'''\\\"\\\"\",\n                \"DefaultVersionNumber\": 5,\n                \"LaunchTemplateVersionCount\": 8,\n                \"CreatedBy\": \"251009920\",\n                \"CreationTime\": \"2020-12-16T08:05:02Z\"\n            }\n        ],\n        \"RequestId\": \"b2d70642-c69a-4115-ae4e-f6ddade68fea\"\n    }\n}",
+        "input": "POST / HTTP/1.1\nHost: cvm.intl.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeLaunchTemplates\n<Common request parameters>\n\n{\n    \"LaunchTemplateIds\": [\n        \"lt-q9t8j8eg\"\n    ]\n}",
+        "output": "{\n    \"Response\": {\n        \"TotalCount\": 1,\n        \"LaunchTemplateSet\": [\n            {\n                \"LatestVersionNumber\": 12,\n                \"LaunchTemplateId\": \"lt-q9t8j8eg\",\n                \"LaunchTemplateName\": \"MyLaunchTemplateName\",\n                \"DefaultVersionNumber\": 5,\n                \"LaunchTemplateVersionCount\": 8,\n                \"CreatedBy\": \"251009920\",\n                \"CreationTime\": \"2020-12-16T08:05:02Z\"\n            }\n        ],\n        \"RequestId\": \"b2d70642-c69a-4115-ae4e-f6ddade68fea\"\n    }\n}",
         "title": "Querying an instance launch template"
       }
     ],
@@ -323,16 +323,16 @@
     "DescribeReservedInstancesConfigInfos": [
       {
         "document": " ",
-        "input": "https://cvm.tencentcloudapi.com/?Action=DescribeReservedInstancesConfigInfos\n&Filters.0.Name=zone\n&Filters.0.Values.0=ap-guangzhou-1\n&Offset=0\n&Limit=1\n&<Common request parameters>",
-        "output": "{\n    \"Response\": {\n        \"ReservedInstanceConfigInfos\": [\n            {\n                \"Type\": \"C\",\n                \"TypeName\": \"Compute\",\n                \"Order\": 400,\n                \"InstanceFamilies\": [\n                    {\n                        \"InstanceFamily\": \"C3\",\n                        \"Order\": 402,\n                        \"InstanceTypes\": [\n                            {\n                                \"InstanceType\": \"C3.LARGE8\",\n                                \"Cpu\": 4,\n                                \"Memory\": 8,\n                                \"Gpu\": 0,\n                                \"Fpga\": 0,\n                                \"StorageBlock\": 0,\n                                \"NetworkCard\": 0,\n                                \"MaxBandwidth\": 2.5,\n                                \"Frequency\": \"3.2 GHz\",\n                                \"CpuModelName\": \"Intel Xeon Skylake 6146\",\n                                \"Pps\": 60,\n                                \"Externals\": {},\n                                \"Remark\": \"\",\n                                \"Prices\": [\n                                    {\n                                        \"ReservedInstancesOfferingId\": \"de06832b-1961-4efd-a470-efee242812a8\",\n                                        \"OfferingType\": \"All Upfront\",\n                                        \"FixedPrice\": 200.99,\n                                        \"UsagePrice\": 0\n                                    },\n                                    {\n                                        \"ReservedInstancesOfferingId\": \"daa72710-c529-4ab3-afca-917e192ea49d\",\n                                        \"OfferingType\": \"Partial Upfront\",\n                                        \"FixedPrice\": 100.99,\n                                        \"UsagePrice\": 1.99\n                                    },\n                                    {\n                                        \"ReservedInstancesOfferingId\": \"d81353d7-fe7d-43d0-a361-fb5633a9a7e5\",\n                                        \"OfferingType\": \"No Upfront\",\n                                        \"FixedPrice\": 0,\n                                        \"UsagePrice\": 2.99\n                                    }\n                                ]\n                            }\n                        ]\n                    }\n                ]\n            }\n        ],\n        \"RequestId\": \"87eccd3e-9e7a-4b42-be3a-87eccd3e\"\n    }\n}",
+        "input": "POST / HTTP/1.1\nHost: cvm.intl.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeReservedInstancesConfigInfos\n<Common request parameters>\n\n{\n    \"Filters\": [\n        {\n            \"Name\": \"zone\",\n            \"Values\": [\n                \"ap-singapore-1\"\n            ]\n        }\n    ]\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"e54a769e-c5aa-408b-b4df-10425ac14ebf\",\n        \"ReservedInstanceConfigInfos\": [\n            {\n                \"InstanceFamilies\": [\n                    {\n                        \"InstanceFamily\": \"S5\",\n                        \"InstanceTypes\": [\n                            {\n                                \"Cpu\": 2,\n                                \"CpuModelName\": \"Intel Xeon Cascade Lake 8255C/Intel Xeon Cooper Lake\",\n                                \"Fpga\": 0,\n                                \"Frequency\": \"2.5GHz/3.1GHz\",\n                                \"Gpu\": 0,\n                                \"InstanceType\": \"S5.MEDIUM4\",\n                                \"MaxBandwidth\": 1.5,\n                                \"Memory\": 4,\n                                \"NetworkCard\": 25,\n                                \"Pps\": 30,\n                                \"Prices\": [\n                                    {\n                                        \"Duration\": 31536000,\n                                        \"FixedPrice\": 409,\n                                        \"OfferingType\": \"All Upfront\",\n                                        \"ProductDescription\": \"linux\",\n                                        \"ReservedInstancesOfferingId\": \"34919144-2792-4b00-ba8b-0ba804f28a4e\",\n                                        \"UsagePrice\": 0,\n                                        \"Zone\": \"ap-singapore-1\"\n                                    }\n                                ],\n                                \"Remark\": \"\",\n                                \"StorageBlock\": 0\n                            }\n                        ],\n                        \"Order\": 88\n                    }\n                ],\n                \"Order\": 100,\n                \"Type\": \"S\",\n                \"TypeName\": \"Standard\"\n            }\n        ]\n    }\n}",
         "title": "Querying reserved instance configurations"
       }
     ],
     "DescribeReservedInstancesOfferings": [
       {
         "document": " ",
-        "input": "https://cvm.tencentcloudapi.com/?Action=DescribeReservedInstancesOfferings\r\n&Filters.0.Name=zone\r\n&Filters.0.Values.0=ap-guangzhou-1\r\n&Offset=0\r\n&Limit=1\r\n&<Common request parameters>",
-        "output": "{\n    \"Response\": {\n        \"TotalCount\": 1,\n        \"ReservedInstancesOfferingsSet\": [\n            {\n                \"Zone\": \"ap-guangzhou-1\",\n                \"CurrencyCode\": \"USD\",\n                \"Duration\": 31536000,\n                \"FixedPrice\": 4000.0,\n                \"InstanceType\": \"S3.MEDIUM4\",\n                \"OfferingType\": \"All Upfront\",\n                \"ReservedInstancesOfferingId\": \"noew0342-324f-f3ab-9uut-wrlnth53dcee\",\n                \"ProductDescription\": \"linux\",\n                \"UsagePrice\": 0.0\n            }\n        ],\n        \"RequestId\": \"b813c959-cc89-41d5-9cc4-ceb7d853dcaa\"\n    }\n}",
+        "input": "POST / HTTP/1.1\nHost: cvm.intl.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeReservedInstancesOfferings\n<Common request parameters>\n\n{\n    \"Offset\": 0,\n    \"Limit\": 3,\n    \"Filters\": [\n        {\n            \"Name\": \"zone\",\n            \"Values\": [\n                \"ap-singapore-1\"\n            ]\n        }\n    ]\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"0aca8cc9-8812-477f-b442-10cc1a701d48\",\n        \"ReservedInstancesOfferingsSet\": [\n            {\n                \"CurrencyCode\": \"USD\",\n                \"Duration\": 31536000,\n                \"FixedPrice\": 412,\n                \"InstanceType\": \"S5.LARGE8\",\n                \"OfferingType\": \"Partial Upfront\",\n                \"ProductDescription\": \"linux\",\n                \"ReservedInstancesOfferingId\": \"f5ededc6-5057-4863-a61b-fe96b4b96eb5\",\n                \"UsagePrice\": 0.05,\n                \"Zone\": \"ap-singapore-1\"\n            },\n            {\n                \"CurrencyCode\": \"USD\",\n                \"Duration\": 31536000,\n                \"FixedPrice\": 0,\n                \"InstanceType\": \"S5.LARGE8\",\n                \"OfferingType\": \"No Upfront\",\n                \"ProductDescription\": \"linux\",\n                \"ReservedInstancesOfferingId\": \"7330ec0e-0ee2-4358-a429-4002c936c24d\",\n                \"UsagePrice\": 0.1,\n                \"Zone\": \"ap-singapore-1\"\n            },\n            {\n                \"CurrencyCode\": \"USD\",\n                \"Duration\": 31536000,\n                \"FixedPrice\": 1200,\n                \"InstanceType\": \"S5.LARGE16\",\n                \"OfferingType\": \"All Upfront\",\n                \"ProductDescription\": \"linux\",\n                \"ReservedInstancesOfferingId\": \"e26bfbf3-85fa-4c88-82a8-0dd2706e60db\",\n                \"UsagePrice\": 0,\n                \"Zone\": \"ap-singapore-1\"\n            }\n        ],\n        \"TotalCount\": 20\n    }\n}",
         "title": "Describing reserved instance offerings"
       }
     ],
@@ -417,8 +417,8 @@
     "InquirePricePurchaseReservedInstancesOffering": [
       {
         "document": " ",
-        "input": "https://cvm.tencentcloudapi.com/?Action=InquirePricePurchaseReservedInstancesOffering\n&InstanceCount=2\n&ReservedInstancesOfferingId=noew0342-324f-f3ab-9uut-wrlnth53dcee\n&<Common request parameters>",
-        "output": "{\n    \"Response\": {\n        \"RequestId\": \"b333ddb8-4aed-4def-a0d9-617043c2614e\"\n    }\n}",
+        "input": "POST / HTTP/1.1\nHost: cvm.intl.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: InquirePricePurchaseReservedInstancesOffering\n<Common request parameters>\n\n{\n    \"InstanceCount\": 1,\n    \"ReservedInstancesOfferingId\": \"694e115d-e1b2-47f5-8217-bfbdea222da1\"\n}",
+        "output": "{\n    \"Response\": {\n        \"Price\": {\n            \"DiscountFixedPrice\": 101,\n            \"DiscountUsagePrice\": 0,\n            \"FixedPriceDiscount\": 100,\n            \"OriginalFixedPrice\": 101,\n            \"OriginalUsagePrice\": 0,\n            \"UsagePriceDiscount\": 100\n        },\n        \"RequestId\": \"5e82e4b0-56e5-4461-aff6-2c1d49cc7447\"\n    }\n}",
         "title": "Querying the Price of a Reserved Instance"
       }
     ],
@@ -578,8 +578,8 @@
     ],
     "ModifyInstancesVpcAttribute": [
       {
-        "document": "This example shows you how to migrate the `r8hr2upy` and `5d8a23rs` instances to the `dcs9x3gz` subnet of the `1urkhbj4` VPC and specify 10.0.0.18 as the private IP of the `r8hr2upy` instance and 10.0.0.19 as that of the `5d8a23rs` instance.",
-        "input": "POST / HTTP/1.1\nHost: cvm.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyInstancesVpcAttribute\n<Common request parameters>\n\n{\n    \"VirtualPrivateCloud\": {\n        \"SubnetId\": \"subnet-dcs9x3gz\",\n        \"VpcId\": \"vpc-1urkhbj4\",\n        \"PrivateIpAddresses\": [\n            \"10.0.0.19\",\n            \"10.0.0.18\"\n        ]\n    },\n    \"InstanceIds\": [\n        \"ins-5d8a23rs\",\n        \"ins-r8hr2upy\"\n    ]\n}",
+        "document": "This example shows you how to migrate the `ins-r8hr2upy` and `ins-5d8a23rs` instances to the `subnet-dcs9x3gz` subnet of the `vpc-1urkhbj4` VPC and specify 10.0.0.18 as the private IP of the `ins-r8hr2upy` instance and 10.0.0.19 as that of the `ins-5d8a23rs` instance.",
+        "input": "POST / HTTP/1.1\nHost: cvm.intl.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyInstancesVpcAttribute\n<Common request parameters>\n\n{\n    \"VirtualPrivateCloud\": {\n        \"SubnetId\": \"subnet-dcs9x3gz\",\n        \"VpcId\": \"vpc-1urkhbj4\",\n        \"PrivateIpAddresses\": [\n            \"10.0.0.19\",\n            \"10.0.0.18\"\n        ]\n    },\n    \"InstanceIds\": [\n        \"ins-5d8a23rs\",\n        \"ins-r8hr2upy\"\n    ]\n}",
         "output": "{\n    \"Response\": {\n        \"RequestId\": \"3c14def19-cfes-470e-b241-90787u6jf5uj\"\n    }\n}",
         "title": "Migrating instances to a VPC and specifying the subnet and IP"
       }
@@ -609,8 +609,8 @@
     "PurchaseReservedInstancesOffering": [
       {
         "document": " ",
-        "input": "https://cvm.tencentcloudapi.com/?Action=PurchaseReservedInstancesOffering\r\n&InstanceCount=2\r\n&ReservedInstancesOfferingId=noew0342-324f-f3ab-9uut-wrlnth53dcee\r\n&<Common request parameters>",
-        "output": "{\n    \"Response\": {\n        \"ReservedInstanceId\": \"13d8e599-b8dc-4e8a-80b4-7dce9eb27043\",\n        \"RequestId\": \"b333ddb8-4aed-4def-a0d9-617043c2614e\"\n    }\n}",
+        "input": "POST / HTTP/1.1\nHost: cvm.intl.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: PurchaseReservedInstancesOffering\n<Common request parameters>\n\n{\n    \"InstanceCount\": 2,\n    \"ReservedInstancesOfferingId\": \"694e115d-e1b2-47f5-8217-bfbdea222da1\",\n    \"ReservedInstanceName\": \"MyReservedInstanceName\"\n}",
+        "output": "{\n    \"Response\": {\n        \"ReservedInstanceId\": \"ri-8frq127i\",\n        \"RequestId\": \"b333ddb8-4aed-4def-a0d9-617043c2614e\"\n    }\n}",
         "title": "Purchasing a reserved instance"
       }
     ],
@@ -737,13 +737,13 @@
     "SyncImages": [
       {
         "document": "This example shows you how to synchronize the image `img-o3ycss2p` to Guangzhou.",
-        "input": "POST / HTTP/1.1\nHost: cvm.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: SyncImages\n<Common request parameters>\n\n\n\n{\n    \"ImageIds\": [\n        \"img-o3ycss2p\"\n    ],\n    \"DestinationRegions\": [\n        \"ap-guangzhou\"\n    ]\n}",
+        "input": "POST / HTTP/1.1\nHost: cvm.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: SyncImages\n<Common request parameters>\n\n{\n    \"ImageIds\": [\n        \"img-o3ycss2p\"\n    ],\n    \"DestinationRegions\": [\n        \"ap-guangzhou\"\n    ]\n}",
         "output": "{\n    \"Response\": {\n        \"RequestId\": \"71e69b56-32be-4412-ab45-49eded6a87be\"\n    }\n}",
         "title": "Synchronizing an Image"
       },
       {
         "document": "This example shows you how to synchronize the image `img-o3ycss2p` to Guangzhou.",
-        "input": "POST / HTTP/1.1\nHost: cvm.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: SyncImages\n<Common request parameters>\n\n\n\n{\n    \"ImageIds\": [\n        \"img-o3ycss2p\"\n    ],\n    \"DestinationRegions\": [\n        \"ap-guangzhou\"\n    ],\n    \"ImageSetRequired\": true\n}",
+        "input": "POST / HTTP/1.1\nHost: cvm.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: SyncImages\n<Common request parameters>\n\n{\n    \"ImageIds\": [\n        \"img-o3ycss2p\"\n    ],\n    \"DestinationRegions\": [\n        \"ap-guangzhou\"\n    ],\n    \"ImageSetRequired\": true\n}",
         "output": "{\n    \"Response\": {\n        \"ImageSet\": [\n            {\n                \"Region\": \"ap-guangzhou\",\n                \"ImageId\": \"img-evhmf3fy\"\n            }\n        ],\n        \"RequestId\": \"71e69b56-32be-4412-ab45-49eded6a87be\"\n    }\n}",
         "title": "Synchronizing an Image to the Specified Region and Returning the New Image ID"
       }

{tccli_intl_en-3.0.1283.1 → tccli_intl_en-3.0.1284.1}/tccli/services/ocr/v20181119/api.json

@@ -2294,7 +2294,7 @@
           "example": "false",
           "member": "bool",
           "name": "ReturnHeadImage",
-          "required": true,
+          "required": false,
           "type": "bool"
         },
         {
@@ -2309,7 +2309,7 @@
         {
           "disabled": false,
           "document": "Base64 string of the image\nSupported image formats: PNG, JPG, JPEG. GIF is not supported yet.\nSupported image size: The downloaded image cannot exceed 7 MB after being Base64-encoded, and it cannot take longer than 3 seconds to download the image.",
-          "example": "无",
+          "example": "/9j/4AAQSkZJRg.....s97n//2Q==",
           "member": "string",
           "name": "ImageBase64",
           "required": false,
@@ -2318,7 +2318,7 @@
         {
           "disabled": false,
           "document": "URL address of image. (This field is not supported outside Chinese mainland)\nSupported image formats: PNG, JPG, JPEG. GIF is currently not supported.\nSupported image size: the downloaded image cannot exceed 3 MB after being Base64-encoded. The download time of the image cannot exceed 3 seconds.\nWe recommend you store the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability.\nThe download speed and stability of non-Tencent Cloud URLs may be low.",
-          "example": "https://xx/a.jpg",
+          "example": "https://ocr-demo-1254418846.cos.ap-guangzhou.myqcloud.com/***/fakeurl.jpg",
           "member": "string",
           "name": "ImageUrl",
           "required": false,
@@ -2442,17 +2442,27 @@
         },
         {
           "disabled": false,
-          "document": "Base64-encoded identity photo\nNote: this field may return null, indicating that no valid values can be obtained.",
-          "example": "xx",
+          "document": "Base64-encoded large primary portrait photo from the left side of the new-generation Hong Kong Identity Card.\nNote: this field may return null, indicating that no valid values can be obtained.",
+          "example": "/9j/4AAQSkZJRg.....s97n//2Q==",
           "member": "string",
           "name": "HeadImage",
           "output_required": true,
           "type": "string",
           "value_allowed_null": true
         },
+        {
+          "disabled": false,
+          "document": "Base64-encoded small secondary portrait photo from the right side of the new-generation Hong Kong Identity Card.\nNote: this field may return null, indicating that no valid values can be obtained.",
+          "example": "/9j/4AAQSkZJRg.....s97n//2Q==",
+          "member": "string",
+          "name": "SmallHeadImage",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
         {
           "disabled": true,
-          "document": "Multiple alarm codes. If the ID card is spoofed, photocopied, or photoshopped, the corresponding alarm code will be returned.\n-9102: Alarm for photocopied document\n-9103: Alarm for spoofed document",
+          "document": "This field is deprecated and will always return an empty array. Usage is not recommended.",
           "example": "[-9102,-9103]",
           "member": "int64",
           "name": "WarningCode",
@@ -2470,6 +2480,26 @@
           "type": "list",
           "value_allowed_null": false
         },
+        {
+          "disabled": false,
+          "document": "Text information incorporated within the laser-perforated see-through window on the new-generation Hong Kong Identity Card.",
+          "example": "C000000",
+          "member": "string",
+          "name": "WindowEmbeddedText",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Versions of the Hong Kong Identity Card: HKID-2018, HKID-2003.",
+          "example": "HKID-2018",
+          "member": "string",
+          "name": "HKIDVersion",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
         {
           "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
           "member": "string",