tencent cloud

TencentDB for SQL Server

Catatan Rilis dan Pengumuman
Catatan Rilis
Pengenalan Produk
Ikhtisar Produk
Keunggulan
Kasus Penggunaan
Wilayah dan AZ
Lingkungan Jaringan
Pernyataan Lisensi
Panduan Pembelian
Ikhtisar Penagihan
Metode Pembelian
Pembayaran Jatuh Tempo
Pengembalian Dana
Deskripsi Biaya Penyesuaian Instans
Penagihan Ruang Cadangan
Memulai
Membuat Instans TencentDB for SQL Server
Menghubungkan ke Instans TencentDB for SQL Server
Mengelola Instans TencentDB for SQL Server
Panduan Operasi
Batas Penggunaan
Memelihara Instans
Menyesuaikan Konfigurasi Instans
Instans Baca Saja
Jaringan dan Keamanan
Manajemen Akun
Manajemen Database
Konfigurasi Parameter
Migrasi Data
Migrasi Data
Service Agreement
Service Level Agreement
Terms of Service
Glosarium
Hubungi Kami
DokumentasiTencentDB for SQL Server

DescribeDBInstanceInter

Mode fokus
Ukuran font
Terakhir diperbarui: 2025-10-28 22:48:48

1. API Description

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.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
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-3.
Offset No Integer Page number. Default value: 0.

3. Output Parameters

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.

4. Example

Example1 Querying the status of an instance in the interworking group

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.

Input Example

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"
}

Output Example

{
    "Response": {
        "InterInstanceSet": [
            {
                "InstanceId": "mssql-30vft2ix",
                "InterPort": 1028,
                "InterVip": "192.168.0.1",
                "Name": "andy",
                "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": "tom",
                "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": "andy2",
                "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. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

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.

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan