1. 接口描述
接口请求域名： sqlserver.tencentcloudapi.com 。
本接口（DescribeDBInstanceInter）用于查询互通实例的信息。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeDBInstanceInter。 |
| Version | 是 | String | 公共参数，本接口取值：2018-03-28。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Limit | 是 | Integer | 分页，页大小，范围是1-100 示例值：10 |
| InstanceId | 否 | String | 按照实例ID筛选 示例值：mssql-dj5i29c5n |
| Status | 否 | Integer | 按照状态筛选 1-互通IP打开中；2-互通IP已经打开；3-加入到互通组中；4-已加入到互通组；5-互通IP回收中；6-互通IP已回收；7-从互通组移除中；8-已从互通组中移除 示例值：1 |
| VersionSet.N | 否 | Array of String | 实例版本代号列表 |
| Zone | 否 | String | 实例所在可用区，格式如：ap-guangzhou-2 示例值：ap-guangzhou-2 |
| Offset | 否 | Integer | 分页，页数，默认是0 示例值：0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 互通组内总条数 示例值：10 |
| InterInstanceSet | Array of InterInstance | 互通组内实例信息详情 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询实例在互通组中的状态
查询实例在互通组中的状态，内网互通ip用于在SSIS服务中使用。
输入示例
POST / HTTP/1.1
Host: sqlserver.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDBInstanceInter
<公共请求参数>
{
"Offset": 0,
"Limit": 20,
"InstanceId": "mssqlbi-q1atet3b"
}输出示例
{
"Response": {
"InterInstanceSet": [
{
"InstanceId": "mssql-30vft2ix",
"InterPort": 1028,
"InterVip": "192.168.0.1",
"Name": "xxx",
"Region": "ap-guangzhou",
"Status": 1,
"Version": "2012SP3",
"VersionName": "SQL Server 2012 Enterprise",
"Vip": "192.168.0.2",
"Vport": 1433,
"Zone": "ap-guangzhou-3"
},
{
"InstanceId": "mssql-iqnuxv3j",
"InterPort": 1026,
"InterVip": "192.168.0.1",
"Name": "xxxx",
"Region": "ap-guangzhou",
"Status": 1,
"Version": "2017",
"VersionName": "SQL Server 2017 Enterprise",
"Vip": "192.168.0.2",
"Vport": 1433,
"Zone": "ap-guangzhou-3"
},
{
"InstanceId": "mssql-ngc6786l",
"InterPort": 1029,
"InterVip": "192.168.0.1",
"Name": "xxxx",
"Region": "ap-guangzhou",
"Status": 1,
"Version": "2008R2",
"VersionName": "SQL Server 2008 Enterprise",
"Vip": "192.168.0.2",
"Vport": 1433,
"Zone": "ap-guangzhou-3"
}
],
"RequestId": "ff9c5a56-1d33-4707-b656-a715240635ad",
"TotalCount": 3
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.DBError | 数据库错误。 |
| InternalError.SystemError | 系统错误。 |
| InvalidParameter.InputIllegal | 输入错误。 |
| UnauthorizedOperation.PermissionDenied | cam鉴权错误。 |