接口汇总

• 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是请求结果。