1. 接口描述
接口请求域名： cdc.tencentcloudapi.com 。
查询站点详情
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeSitesDetail。 |
| Version | 是 | String | 公共参数，本接口取值：2020-12-14。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| SiteIds.N | 否 | Array of String | 按照站点id过滤 示例值：["site-98dj3kd"] |
| Offset | 否 | Integer | 偏移量，默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。示例值：0 |
| Limit | 否 | Integer | 返回数量，默认为20，最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。示例值：20 |
| Name | 否 | String | 按照站定名称模糊匹配 示例值：my-site |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| SiteDetailSet | Array of SiteDetail | 站点详情 示例值：[{ "SiteId": "site-98dj3kd", "Name": "sitename", "Description": "this is a description", "CreateTime": "2020-12-25T08:39:57Z", "FiberType": "MM", "UplinkSpeedGbps": 0, "UplinkCount": 0, "OpticalStandard": "MM", "RedundantNetworking": false, "PowerConnectors": "1000Base-SX", "PowerFeedDrop": "above", "PowerDrawKva": 0.0, "ConditionRequirement": false, "DimensionRequirement": false, "NeedHelp": false, "BreakerRequirement": false, "RedundantPower": false, "MaxWeight": 0, "AddressLine": "Nanshan Road", "OptionalAddressLine": "详细地址", "Country": "China", "Province": "guangdong", "City": "shenzhen", "PostalCode": 518000 }] |
| TotalCount | Integer | 符合条件的站点总数 示例值：20 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询站点详情
查询站点详情
输入示例
POST / HTTP/1.1
Host: cdc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSitesDetail
<公共请求参数>
{
"SiteIds": [
"site-98dj3kd"
]
}输出示例
{
"Response": {
"SiteDetailSet": [
{
"SiteId": "site-98dj3kd",
"Name": "sitename",
"Description": "this is a description",
"CreateTime": "2020-12-25T08:39:57Z",
"FiberType": "MM",
"UplinkSpeedGbps": 0,
"UplinkCount": 0,
"OpticalStandard": "MM",
"RedundantNetworking": false,
"PowerConnectors": "1000Base-SX",
"PowerFeedDrop": "above",
"PowerDrawKva": 0.0,
"ConditionRequirement": false,
"DimensionRequirement": false,
"NeedHelp": false,
"BreakerRequirement": false,
"RedundantPower": false,
"MaxWeight": 0,
"AddressLine": "Nanshan Road",
"OptionalAddressLine": "详细地址",
"Country": "China",
"Province": "guangdong",
"City": "shenzhen",
"PostalCode": 518000
}
],
"TotalCount": 1,
"RequestId": "a07a5f9c-277c-4f03-a338-c2863982b1a6"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue.InvalidAppIdFormat | 无效的AppId |
