1. 接口描述
接口请求域名: cwp.tencentcloudapi.com 。
大屏可视化主机区域选项列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeScreenMachineRegions。 |
Version | 是 | String | 公共参数,本接口取值:2018-02-28。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
List | Array of ScreenRegionInfo | 列表详情 示例值:[ { "Region": "ap-guangzhou", "RegionCode": "gz", "RegionId": 1, "RegionName": "华南地区(广州)", "RegionNameEn": "South China (Guangzhou)" } ] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例
示例
输入示例
POST / HTTP/1.1
Host: cwp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeScreenMachineRegions
<公共请求参数>
{}
输出示例
{
"Response": {
"List": [
{
"Region": "ap-guangzhou",
"RegionCode": "gz",
"RegionId": 1,
"RegionName": "华南地区(广州)",
"RegionNameEn": "South China (Guangzhou)"
},
{
"Region": "ap-nanjing",
"RegionCode": "nj",
"RegionId": 33,
"RegionName": "华东地区(南京)",
"RegionNameEn": "East Chinaxa0(Nanjing)"
},
{
"Region": "ap-others",
"RegionCode": "others",
"RegionId": 47,
"RegionName": "其他地域(其他)",
"RegionNameEn": "Others (Other)"
},
{
"Region": "ap-beijing",
"RegionCode": "bj",
"RegionId": 8,
"RegionName": "华北地区(北京)",
"RegionNameEn": "North China (Beijing)"
},
{
"Region": "ap-chengdu",
"RegionCode": "cd",
"RegionId": 16,
"RegionName": "西南地区(成都)",
"RegionNameEn": "Southwestxa0China (Chengdu)"
},
{
"Region": "ap-shanghai",
"RegionCode": "sh",
"RegionId": 4,
"RegionName": "华东地区(上海)",
"RegionNameEn": "East Chinaxa0(Shanghai)"
}
],
"RequestId": "01b46ad0-11ab-46fe-9f54-d998385913ee"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InternalError.MainDBFail | 操作数据失败。 |
InvalidParameter | 参数错误。 |
ResourceNotFound | 资源不存在。 |
UnauthorizedOperation | 未授权操作。 |