1. 接口描述
接口请求域名： gaap.tencentcloudapi.com 。
本接口（DescribeProxyDetail）用于查询通道详情。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeProxyDetail。 |
| Version | 是 | String | 公共参数，本接口取值：2018-05-29。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| ProxyId | 是 | String | 需查询的通道ID。 示例值：link-12345678 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ProxyDetail | ProxyInfo | 通道详情信息。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询通道详情
输入示例
POST / HTTP/1.1
Host: gaap.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeProxyDetail
<公共请求参数>
{
"ProxyId": "link-4qlu8i3j"
}输出示例
{
"Response": {
"ProxyDetail": {
"InstanceId": "link-4qlu8i3j",
"CreateTime": 1728542120,
"ProjectId": 1323575,
"ProxyName": "test-proxy",
"AccessRegion": "Beijing",
"RealServerRegion": "Shanghai",
"Bandwidth": 10,
"Concurrent": 2,
"Status": "RUNNING",
"Domain": "link-4qlu8i3j.gaapqcloud.com.cn",
"IP": "43.137.75.190",
"Version": "3.0",
"ProxyId": "link-4qlu8i3j",
"Scalarable": 1,
"SupportProtocols": [
"TCP",
"UDP"
],
"GroupId": null,
"PolicyId": "sp-e6on5s9d",
"AccessRegionInfo": {
"RegionId": "Beijing",
"RegionName": "北京（原中国大陆-华北大区）",
"RegionArea": "NorthChina",
"RegionAreaName": "NorthChina",
"IDCType": "dc",
"FeatureBitmap": 79,
"SupportFeature": null
},
"RealServerRegionInfo": {
"RegionId": "Shanghai",
"RegionName": "上海（原中国大陆-华东大区）",
"RegionArea": "EastChina",
"RegionAreaName": "EastChina",
"IDCType": "dc",
"FeatureBitmap": 79,
"SupportFeature": null
},
"ForwardIP": "124.222.42.242;118.25.142.34;",
"TagSet": [
{
"TagKey": "test",
"TagValue": "10"
}
],
"SupportSecurity": 1,
"BillingType": 1,
"RelatedGlobalDomains": [],
"ModifyConfigTime": 1728542120,
"ProxyType": 100,
"ClientIPMethod": [
0,
1
],
"IPAddressVersion": "IPv4",
"NetworkType": "normal",
"PackageType": "Thunder",
"BanStatus": "RECOVER",
"IPList": [
{
"IP": "43.137.75.190",
"Provider": "BGP",
"Bandwidth": 10
}
],
"Http3Supported": 1,
"InBanBlacklist": 0,
"FeatureBitmap": 71,
"IsAutoScaleProxy": 0,
"IsSupportTLSChoice": 1
},
"RequestId": "8d5cae87-74ac-4122-98e8-3aab1f7040b9"
}
}示例2 查询通道详情2
输入示例
POST / HTTP/1.1
Host: gaap.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeProxyDetail
<公共请求参数>
{
"ProxyId": "link-4m6fx36h"
}输出示例
{
"Response": {
"ProxyDetail": {
"InstanceId": "abc",
"CreateTime": 1,
"ProjectId": 0,
"ProxyName": "abc",
"AccessRegion": "abc",
"RealServerRegion": "abc",
"Bandwidth": 0,
"Concurrent": 0,
"Status": "abc",
"Domain": "abc",
"IP": "abc",
"Version": "abc",
"ProxyId": "abc",
"Scalarable": 0,
"SupportProtocols": [
"abc"
],
"GroupId": "abc",
"PolicyId": "abc",
"AccessRegionInfo": {
"RegionId": "abc",
"RegionName": "abc",
"RegionArea": "abc",
"RegionAreaName": "abc",
"IDCType": "abc",
"FeatureBitmap": 1,
"SupportFeature": {
"NetworkType": [
"abc"
]
}
},
"RealServerRegionInfo": {
"RegionId": "abc",
"RegionName": "abc",
"RegionArea": "abc",
"RegionAreaName": "abc",
"IDCType": "abc",
"FeatureBitmap": 1,
"SupportFeature": {
"NetworkType": [
"abc"
]
}
},
"ForwardIP": "abc",
"TagSet": [
{
"TagKey": "abc",
"TagValue": "abc"
}
],
"SupportSecurity": 0,
"BillingType": 0,
"RelatedGlobalDomains": [
"abc"
],
"ModifyConfigTime": 1,
"ProxyType": 1,
"ClientIPMethod": [
0
],
"IPAddressVersion": "abc",
"NetworkType": "abc",
"PackageType": "abc",
"BanStatus": "abc",
"IPList": [
{
"IP": "abc",
"Provider": "abc",
"Bandwidth": 0
}
],
"Http3Supported": 0,
"InBanBlacklist": 0,
"FeatureBitmap": 0,
"IsAutoScaleProxy": 0,
"IsSupportTLSChoice": 0
},
"RequestId": "abc"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| AuthFailure.NotEnterpriseAuthorization | 非企业认证客户。 |
| AuthFailure.UnauthorizedOperation | 子账户未授权操作。 |
| FailedOperation | 操作失败。 |
| FailedOperation.ActionIsDoing | 操作正在执行中，请勿重复操作。 |
| FailedOperation.ActionOperateTooQuickly | 接口操作太频繁，请稍后重试。 |
| FailedOperation.ResourceCanNotAccess | 该资源不可访问。 |
| FailedOperation.UserNotConfirmProtocol | 未开通协议。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.ProjectIdNotBelong | 项目不属于该用户。 |
| MissingParameter | 缺少参数错误。 |
| ResourceNotFound | 资源不存在。 |
| ResourceUnavailable.AccountViolation | 账号下存在违规资源，详情请查看站内信或邮件。 |
| UnauthorizedOperation | 未授权操作。 |
| UnknownParameter | 未知参数错误。 |
