Domain name for API request: sqlserver.intl.tencentcloudapi.com.
This API is used to query the information of the interconnected instances.
A maximum of 30 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common Params. The value used for this API: DescribeDBInstanceInter. |
Version | Yes | String | Common Params. The value used for this API: 2018-03-28. |
Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
Limit | Yes | Integer | The maximum number of results returned per page. Value range: 1-100. |
InstanceId | No | String | Filter by instance ID |
Status | No | Integer | Filter by status. Valid values: 1 (Enabling interworking IP), 2 (Enabled interworking IP), 3 (Adding to interworking group), 4 (Added to interworking group), 5 (Reclaiming interworking IP), 6 (Reclaimed interworking IP), 7 (Removing from interworking group), 8 (Removed from interworking group). |
VersionSet.N | No | Array of String | The list of instance version numbers |
Zone | No | String | Instance AZ ID in the format of ap-guangzhou-2 |
Offset | No | Integer | Page number. Default value: 0 . |
Parameter Name | Type | Description |
---|---|---|
TotalCount | Integer | Number of records returned |
InterInstanceSet | Array of InterInstance | Details of instance in the interworking group |
RequestId | String | 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. |
This example shows you how to query the status of an instance in the interworking group. The interworking private IP is used in SSIS service.
POST / HTTP/1.1
Host: sqlserver.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDBInstanceInter
<Common request parameters>
{
"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
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
FailedOperation.DBError | Database error. |
InternalError.SystemError | System error. |
InvalidParameter.InputIllegal | Input error. |
UnauthorizedOperation.PermissionDenied | CAM authentication error. |
Was this page helpful?