tccli-intl-en 3.0.1188.1__py2.py3-none-any.whl → 3.1.28.1__py2.py3-none-any.whl

tccli/services/region/v20220627/api.json

@@ -0,0 +1,399 @@
+{
+  "actions": {
+    "DescribeProducts": {
+      "document": "This interface (DescribeProducts) is used for querying product information in each supported region list.",
+      "input": "DescribeProductsRequest",
+      "name": "Query products that support region list queries",
+      "output": "DescribeProductsResponse",
+      "status": "online"
+    },
+    "DescribeRegions": {
+      "document": "This interface (DescribeRegions) is used for querying the supported regions of each product.",
+      "input": "DescribeRegionsRequest",
+      "name": "Query the list of regions supported by the product",
+      "output": "DescribeRegionsResponse",
+      "status": "online"
+    },
+    "DescribeZones": {
+      "document": "This interface (DescribeZones) is used for querying product availability zone information.",
+      "input": "DescribeZonesRequest",
+      "name": "Query the product AZ list",
+      "output": "DescribeZonesResponse",
+      "status": "online"
+    }
+  },
+  "metadata": {
+    "apiVersion": "2022-06-27",
+    "serviceNameCN": "地域管理系统",
+    "serviceShortName": "region"
+  },
+  "objects": {
+    "DescribeProductsRequest": {
+      "document": "DescribeProducts request structure.",
+      "members": [
+        {
+          "disabled": false,
+          "document": "Number of returned results, defaults to 20, maximum value is 100.",
+          "example": "20",
+          "member": "int64",
+          "name": "Limit",
+          "required": false,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "Offset. default value: 0.",
+          "example": "0",
+          "member": "int64",
+          "name": "Offset",
+          "required": false,
+          "type": "int"
+        }
+      ],
+      "type": "object"
+    },
+    "DescribeProductsResponse": {
+      "document": "DescribeProducts response structure.",
+      "members": [
+        {
+          "disabled": false,
+          "document": "Product detailed information list.",
+          "example": "[{ \"Name\": \"cvm\"}]",
+          "member": "RegionProduct",
+          "name": "Products",
+          "output_required": true,
+          "type": "list",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Total number of products.",
+          "example": "1",
+          "member": "int64",
+          "name": "TotalCount",
+          "output_required": true,
+          "type": "int",
+          "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.",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "DescribeRegionsRequest": {
+      "document": "DescribeRegions request structure.",
+      "members": [
+        {
+          "disabled": false,
+          "document": "Name of the product to be queried, such as cvm. for specific value, query the DescribeProducts api.",
+          "example": "cvm",
+          "member": "string",
+          "name": "Product",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "Not passed or 0 means no query [optional business allowlist], 1 means query [optional business allowlist]. if this parameter is set to 1, the allowlist will only be queried when no business allowlist is found.",
+          "example": "1",
+          "member": "int64",
+          "name": "Scene",
+          "required": false,
+          "type": "int"
+        }
+      ],
+      "type": "object"
+    },
+    "DescribeRegionsResponse": {
+      "document": "DescribeRegions response structure.",
+      "members": [
+        {
+          "disabled": false,
+          "document": "Number of Regions",
+          "example": "1",
+          "member": "uint64",
+          "name": "TotalCount",
+          "output_required": true,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "List Information of Region",
+          "example": "参考输出示例",
+          "member": "RegionInfo",
+          "name": "RegionSet",
+          "output_required": true,
+          "type": "list",
+          "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.",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "DescribeZonesRequest": {
+      "document": "DescribeZones request structure.",
+      "members": [
+        {
+          "disabled": false,
+          "document": "Name of the product to be queried, such as cvm. for specific value, query the DescribeProducts api.",
+          "example": "cvm",
+          "member": "string",
+          "name": "Product",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "No input or 0 means no query [optional business allowlist], 1 means query [optional business allowlist]. if this parameter is set to 1, the allowlist will only be queried when no result is found in the business allowlist.",
+          "example": "1",
+          "member": "int64",
+          "name": "Scene",
+          "required": false,
+          "type": "int"
+        }
+      ],
+      "type": "object"
+    },
+    "DescribeZonesResponse": {
+      "document": "DescribeZones response structure.",
+      "members": [
+        {
+          "disabled": false,
+          "document": "Number of availability zones.",
+          "example": "1",
+          "member": "uint64",
+          "name": "TotalCount",
+          "output_required": true,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Availability zone list information.",
+          "example": "参开输出示例",
+          "member": "ZoneInfo",
+          "name": "ZoneSet",
+          "output_required": true,
+          "type": "list",
+          "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.",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "RegionInfo": {
+      "document": "Region information",
+      "members": [
+        {
+          "disabled": false,
+          "document": "Region name, such as ap-guangzhou.",
+          "example": "ap-guangzhou",
+          "member": "string",
+          "name": "Region",
+          "required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Region description, for example, South China (Guangzhou).",
+          "example": "华南地区(广州)",
+          "member": "string",
+          "name": "RegionName",
+          "required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Whether the region is in an available state.",
+          "example": "AVAILABLE",
+          "member": "string",
+          "name": "RegionState",
+          "required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Console type. defaults to null when called via api.\nNote: This field may return null, indicating that no valid values can be obtained.",
+          "example": "1",
+          "member": "int64",
+          "name": "RegionTypeMC",
+          "required": true,
+          "type": "int",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "Region for different languages.\nNote: This field may return null, indicating that no valid values can be obtained.",
+          "example": "South China",
+          "member": "string",
+          "name": "LocationMC",
+          "required": true,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "Region description on console display.\nNote: This field may return null, indicating that no valid values can be obtained.",
+          "example": "广州",
+          "member": "string",
+          "name": "RegionNameMC",
+          "required": true,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "1\nNote: This field may return null, indicating that no valid values can be obtained.",
+          "example": "1",
+          "member": "string",
+          "name": "RegionIdMC",
+          "required": true,
+          "type": "string",
+          "value_allowed_null": true
+        }
+      ],
+      "usage": "out"
+    },
+    "RegionProduct": {
+      "document": "Region management system product information.",
+      "members": [
+        {
+          "disabled": false,
+          "document": "Product name, for example cvm.",
+          "example": "cvm",
+          "member": "string",
+          "name": "Name",
+          "required": true,
+          "type": "string",
+          "value_allowed_null": false
+        }
+      ],
+      "usage": "out"
+    },
+    "ZoneInfo": {
+      "document": "Availability zone information",
+      "members": [
+        {
+          "disabled": false,
+          "document": "Availability zone name, for example, ap-guangzhou-3.\n\nThe names of availability zones across the network are as follows:.\n<li> ap-chongqing-1 </li>\n<li> ap-seoul-1 </li>\n<li> ap-seoul-2 </li>\n<li> ap-chengdu-1 </li>\n<li> ap-chengdu-2 </li>\n<li> ap-hongkong-1 </li>\n<li> ap-hongkong-2 </li>\n<li> ap-shenzhen-fsi-1 </li>\n<li> ap-shenzhen-fsi-2 </li>\n<li> ap-shenzhen-fsi-3 </li>\n<Li> ap-guangzhou-1 (sold-out)</li>.\n<Li> ap-guangzhou-2 (resource out of stock)</li>.\n<li> ap-guangzhou-3 </li>\n<li> ap-guangzhou-4 </li>\n<li> ap-guangzhou-6 </li>\n<li> ap-tokyo-1 </li>\n<li> ap-singapore-1 </li>\n<li> ap-singapore-2 </li>\n<li> ap-shanghai-fsi-1 </li>\n<li> ap-shanghai-fsi-2 </li>\n<li> ap-shanghai-fsi-3 </li>\n<li> ap-bangkok-1 </li>\n<Li> ap-shanghai-1 (resource out of stock) </li>.\n<li> ap-shanghai-2 </li>\n<li> ap-shanghai-3 </li>\n<li> ap-shanghai-4 </li>\n<li> ap-shanghai-5 </li>\n<li> ap-mumbai-1 </li>\n<li> ap-mumbai-2 </li>\n<li> ap-beijing-1 </li>\n<li> ap-beijing-2 </li>\n<li> ap-beijing-3 </li>\n<li> ap-beijing-4 </li>\n<li> ap-beijing-5 </li>\n<li> na-siliconvalley-1 </li>\n<li> na-siliconvalley-2 </li>\n<li> eu-frankfurt-1 </li>\n<li> na-ashburn-1 </li>\n<li> na-ashburn-2 </li>\n<li> ap-nanjing-1 </li>\n<li> ap-nanjing-2 </li>",
+          "example": "ap-guangzhou-3",
+          "member": "string",
+          "name": "Zone",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Availability zone description, such as Guangzhou Zone 3.",
+          "example": "广州三区",
+          "member": "string",
+          "name": "ZoneName",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "AZ ID",
+          "example": "1",
+          "member": "string",
+          "name": "ZoneId",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Availability zone status, including AVAILABLE and UNAVAILABLE. AVAILABLE indicates available, and UNAVAILABLE indicates unavailable.",
+          "example": "AVAILABLE",
+          "member": "string",
+          "name": "ZoneState",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Parent zone.\nNote: This field may return null, indicating that no valid values can be obtained.",
+          "example": "1",
+          "member": "string",
+          "name": "ParentZone",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "Parent availability zone ID.\nNote: This field may return null, indicating that no valid values can be obtained.",
+          "example": "1",
+          "member": "string",
+          "name": "ParentZoneId",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "Describes the parent availability zone.\nNote: This field may return null, indicating that no valid values can be obtained.",
+          "example": "1",
+          "member": "string",
+          "name": "ParentZoneName",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "zone type.\nNote: This field may return null, indicating that no valid values can be obtained.",
+          "example": "1",
+          "member": "string",
+          "name": "ZoneType",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "Console type.\nNote: This field may return null, indicating that no valid values can be obtained.",
+          "example": "公有云",
+          "member": "string",
+          "name": "MachineRoomTypeMC",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "Same as ZoneId. suitable for console invocation.\nNote: This field may return null, indicating that no valid values can be obtained.",
+          "example": "1",
+          "member": "string",
+          "name": "ZoneIdMC",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": true
+        }
+      ],
+      "usage": "out"
+    }
+  },
+  "version": "1.0"
+}

tccli/services/region/v20220627/examples.json

@@ -0,0 +1,29 @@
+{
+  "actions": {
+    "DescribeProducts": [
+      {
+        "document": " ",
+        "input": "POST / HTTP/1.1\nHost: region.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeProducts\n<Common request parameters>\n\n{\n    \"Limit\": 5,\n    \"Offset\": 0\n}",
+        "output": "{\n    \"Response\": {\n        \"TotalCount\": 39,\n        \"Products\": [\n            {\n                \"Name\": \"cvm\"\n            },\n            {\n                \"Name\": \"vpc\"\n            },\n            {\n                \"Name\": \"faceid\"\n            },\n            {\n                \"Name\": \"cp\"\n            },\n            {\n                \"Name\": \"cls\"\n            }\n        ],\n        \"RequestId\": \"bae5aa6f-f179-4fd6-95a1-e939c3c0b253\"\n    }\n}",
+        "title": "Querying Product Information"
+      }
+    ],
+    "DescribeRegions": [
+      {
+        "document": "Query the list of regions supported by the product",
+        "input": "POST / HTTP/1.1\nHost: region.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRegions\n<Common request parameters>\n\n{\n    \"Product\": \"cvm\",\n    \"Scene\": 1\n}",
+        "output": "{\n    \"Response\": {\n        \"TotalCount\": 21,\n        \"RequestId\": \"2b41c59d-93c8-43e2-a2f0-6c5df9735d21\",\n        \"RegionSet\": [\n            {\n                \"RegionIdMC\": null,\n                \"LocationMC\": null,\n                \"RegionState\": \"AVAILABLE\",\n                \"RegionNameMC\": null,\n                \"Region\": \"ap-guangzhou\",\n                \"RegionTypeMC\": null,\n                \"RegionName\": \"South China (Guangzhou)\"\n            },\n            {\n                \"RegionIdMC\": null,\n                \"LocationMC\": null,\n                \"RegionState\": \"AVAILABLE\",\n                \"RegionNameMC\": null,\n                \"Region\": \"ap-shanghai\",\n                \"RegionTypeMC\": null,\n                \"RegionName\": \"East China (Shanghai)\"\n            },\n            {\n                \"RegionIdMC\": null,\n                \"LocationMC\": null,\n                \"RegionState\": \"AVAILABLE\",\n                \"RegionNameMC\": null,\n                \"Region\": \"ap-nanjing\",\n                \"RegionTypeMC\": null,\n                \"RegionName\": \"East China (Nanjing)\"\n            },\n            {\n                \"RegionIdMC\": null,\n                \"LocationMC\": null,\n                \"RegionState\": \"AVAILABLE\",\n                \"RegionNameMC\": null,\n                \"Region\": \"ap-beijing\",\n                \"RegionTypeMC\": null,\n                \"RegionName\": \"North China (Beijing)\"\n            },\n            {\n                \"RegionIdMC\": null,\n                \"LocationMC\": null,\n                \"RegionState\": \"AVAILABLE\",\n                \"RegionNameMC\": null,\n                \"Region\": \"ap-chengdu\",\n                \"RegionTypeMC\": null,\n                \"RegionName\": \"Southwest China (Chengdu)\"\n            },\n            {\n                \"RegionIdMC\": null,\n                \"LocationMC\": null,\n                \"RegionState\": \"AVAILABLE\",\n                \"RegionNameMC\": null,\n                \"Region\": \"ap-chongqing\",\n                \"RegionTypeMC\": null,\n                \"RegionName\": \"Southwest China (Chongqing)\"\n            },\n            {\n                \"RegionIdMC\": null,\n                \"LocationMC\": null,\n                \"RegionState\": \"AVAILABLE\",\n                \"RegionNameMC\": null,\n                \"Region\": \"ap-xian-ec\",\n                \"RegionTypeMC\": null,\n                \"RegionName\": \"Northwest China (Xi'an)\"\n            },\n            {\n                \"RegionIdMC\": null,\n                \"LocationMC\": null,\n                \"RegionState\": \"AVAILABLE\",\n                \"RegionNameMC\": null,\n                \"Region\": \"ap-hongkong\",\n                \"RegionTypeMC\": null,\n                \"RegionName\": \"Hong Kong/Macao/Taiwan (Hong Kong, China)\"\n            },\n            {\n                \"RegionIdMC\": null,\n                \"LocationMC\": null,\n                \"RegionState\": \"AVAILABLE\",\n                \"RegionNameMC\": null,\n                \"Region\": \"ap-guiyang\",\n                \"RegionTypeMC\": null,\n                \"RegionName\": \"Southwest China (Guiyang)\"\n            },\n            {\n                \"RegionIdMC\": null,\n                \"LocationMC\": null,\n                \"RegionState\": \"AVAILABLE\",\n                \"RegionNameMC\": null,\n                \"Region\": \"ap-seoul\",\n                \"RegionTypeMC\": null,\n                \"RegionName\": \"Northeast Asia (Seoul)\"\n            },\n            {\n                \"RegionIdMC\": null,\n                \"LocationMC\": null,\n                \"RegionState\": \"AVAILABLE\",\n                \"RegionNameMC\": null,\n                \"Region\": \"ap-tokyo\",\n                \"RegionTypeMC\": null,\n                \"RegionName\": \"Northeast Asia (Tokyo)\"\n            },\n            {\n                \"RegionIdMC\": null,\n                \"LocationMC\": null,\n                \"RegionState\": \"AVAILABLE\",\n                \"RegionNameMC\": null,\n                \"Region\": \"ap-singapore\",\n                \"RegionTypeMC\": null,\n                \"RegionName\": \"Southeast Asia (Singapore)\"\n            },\n            {\n                \"RegionIdMC\": null,\n                \"LocationMC\": null,\n                \"RegionState\": \"AVAILABLE\",\n                \"RegionNameMC\": null,\n                \"Region\": \"ap-bangkok\",\n                \"RegionTypeMC\": null,\n                \"RegionName\": \"Southeast Asia Pacific (Bangkok)\"\n            },\n            {\n                \"RegionIdMC\": null,\n                \"LocationMC\": null,\n                \"RegionState\": \"AVAILABLE\",\n                \"RegionNameMC\": null,\n                \"Region\": \"ap-jakarta\",\n                \"RegionTypeMC\": null,\n                \"RegionName\": \"Southeast Asia (Jakarta)\"\n            },\n            {\n                \"RegionIdMC\": null,\n                \"LocationMC\": null,\n                \"RegionState\": \"AVAILABLE\",\n                \"RegionNameMC\": null,\n                \"Region\": \"na-siliconvalley\",\n                \"RegionTypeMC\": null,\n                \"RegionName\": \"West US (Silicon Valley)\"\n            },\n            {\n                \"RegionIdMC\": null,\n                \"LocationMC\": null,\n                \"RegionState\": \"AVAILABLE\",\n                \"RegionNameMC\": null,\n                \"Region\": \"eu-frankfurt\",\n                \"RegionTypeMC\": null,\n                \"RegionName\": \"Europe (Frankfurt)\"\n            },\n            {\n                \"RegionIdMC\": null,\n                \"LocationMC\": null,\n                \"RegionState\": \"AVAILABLE\",\n                \"RegionNameMC\": null,\n                \"Region\": \"na-ashburn\",\n                \"RegionTypeMC\": null,\n                \"RegionName\": \"Eastern United States (Virginia)\"\n            },\n            {\n                \"RegionIdMC\": null,\n                \"LocationMC\": null,\n                \"RegionState\": \"AVAILABLE\",\n                \"RegionNameMC\": null,\n                \"Region\": \"sa-saopaulo\",\n                \"RegionTypeMC\": null,\n                \"RegionName\": \"South America (Sao Paulo)\"\n            }\n        ]\n    }\n}",
+        "title": "Querying the List of Regions Supported by the Product"
+      }
+    ],
+    "DescribeZones": [
+      {
+        "document": "This example shows you how to query AZ information (Chinese Name of Availability Zone).",
+        "input": "POST / HTTP/1.1\nHost: region.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeZones\nX-TC-Language: zh-CN\n<Common request parameters>\n\n{\n    \"Product\": \"cvm\",\n    \"Scene\": 1\n}",
+        "output": "{\n    \"Response\": {\n        \"TotalCount\": 7,\n        \"RequestId\": \"6c3323bd-c855-49d7-85fb-7d6e0d8e1c55\",\n        \"ZoneSet\": [\n            {\n                \"Zone\": \"ap-beijing-tez-changchun-1\",\n                \"ZoneIdMC\": null,\n                \"ZoneId\": \"2100080001\",\n                \"ParentZoneName\": \"Beijing Zone 3\",\n                \"ParentZoneId\": \"800003\",\n                \"ParentZone\": \"ap-beijing-3\",\n                \"ZoneState\": \"AVAILABLE\",\n                \"MachineRoomTypeMC\": null,\n                \"ZoneType\": \"edge-zone\",\n                \"ZoneName\": \"Changchun Edge Zone 1\"\n            }\n        ]\n    }\n}",
+        "title": "Querying AZ Information (Chinese Name of Availability Zone)"
+      }
+    ]
+  },
+  "version": "1.0"
+}