接口匯總

<i id='81wfe'></i>

• SDK調用的Openapi接口文檔
• 接口文檔，包含所有Openapi接口的定義和說明，SDK的調用方法與openapi的英文名稱保持一致。

使用前提

SQL Server SDK適用于：

• .NET and .NET Core 2.0 及以上版本
• .NET Framework 4.6.1 及以上版本
• 需要提前獲取天翼云用戶的Access Key（AK）, Secret Access Key（SK）以及實例資源池的regionId。

SDK調用

SDK的獲取和安裝

通過如下方式來安裝SQL Server的SDK：

• 使用Visual Studio的NuGet管理工具
  • 選中預添加SDK的項目，右擊<管理NuGet程序包>
  • 搜索 Ctyun.Teledb.Sqlserver，點擊安裝即可。
• 使用 Package Manager

Install-Package Ctyun.Teledb.Sqlserver -Version 1.0.4

• 使用 .NET CLI 工具

dotnet add package Ctyun.Teledb.Sqlserver --version 1.0.4

認證信息配置

具體方法調用

以<查詢實例列表>方法為例，提供SDK方法的調用示例，其他方法調用方式均相同。

using System;
using System.IO;
using Ctyun.Teledb.SqlServer.SDK;
namespace SQLServerClientApp
{
    class Program
    {
        static void Main(string[] args)
        {
            // Environment variable configuration query, Include AK, SK, RegionId and ProjectId
            var ak = Environment.GetEnvironmentVariable(Constants.CTYUNCLOUD_SDK_AK);
            var sk = Environment.GetEnvironmentVariable(Constants.CTYUNCLOUD_SDK_SK);
            var regionId = Environment.GetEnvironmentVariable(Constants.CTYUNCLOUD_SDK_REGION_ID);
            var projectId = Environment.GetEnvironmentVariable(Constants.CTYUNCLOUD_SDK_PROJECT_ID);
            var auth = new BasicCredentials(ak, sk, projectId, regionId);
            var sqlClient = MSSQLClient.NewBuilder()
                            .WithCredential(auth)
                            .Build();
            //query Instance List
            InstanceManageTest(sqlClient);
        }

        private static void InstanceManageTest(MSSQLClient sqlClient) {
            var request1 = new GetInstancePageListRequest(){
                pageNum = 1,
                pageSize = 10,
            };

            try {
                var response1 = sqlClient.getInstancePageList(request1);
                // If the request is successful, the response is printed
                if(response1.isSuccess()) {
                    Console.WriteLine(response1);
                }
                // If the request fails, the error message is printed
                else {
                    Console.WriteLine(response1.Message);
                }
            } catch (Exception e) {
                Console.WriteLine(e.Message);
            }
        }
    }
}

說明:

• **SDK 方法名與Openapi接口名稱一致，方法的請求參數名稱是方法（首字母大寫）拼接Request，方法返回結果是方法（首字母大寫）拼接Response。例如，getInstancePageList是方法名，GetInstancePageListRequest是請求參數，GetInstancePageListResponse是請求結果。