Tencent 适用于 .NET 的 Cloud API 3.0 SDK
欢迎使用腾讯云开发者工具套件(SDK),此 SDK 是云 API 3.0 平台的配套开发工具。
为方便 .NET 开发者调试和接入腾讯云产品 API ,这里向您介绍适用于 .NET 的腾讯云开发工具包,并提供首次使用开发工具包的简单示例。让您快速获取腾讯云 .NET SDK 并开始调用。
安装 .NET SDK 前,先获取安全凭证。在第一次使用云API之前,用户首先需要在腾讯云控制台上申请安全凭证,安全凭证包括 SecretID 和 SecretKey , SecretID 是用于标识 API 调用者的身份, SecretKey 是用于加密签名字符串和服务器端验证签名字符串的密钥。 SecretKey 必须严格保管,避免泄露。
SDK 相关信息请到 nuget 获取。使用 SDK 时,需要通过 Visual Studio 的添加包。
例如:安装指定产品包
dotnet add package TencentCloudSDK.指定产品包名缩写 # 如 CVM 产品包:TencentCloudSDK.Cvm具体产品的包名缩写请参考 products.md 中的包名字段。
dotnet add package TencentCloudSDK全产品 SDK 包含了所有云产品的调用代码,体积偏大,对体积敏感的场景,推荐安装指定产品 SDK。
前往 CNB、Github 或者 Gitee 下载最新代码,解压后使用 Visual Studio 2017 打开编译。
每个接口都有一个对应的 Request 结构和一个 Response 结构。例如云服务器的查询实例列表接口 DescribeInstances 有对应的请求结构体 DescribeInstancesRequest 和返回结构体 DescribeInstancesResponse 。
下面以云服务器查询实例列表接口为例,介绍 SDK 的基础用法。
……从 v3.0.713 开始,腾讯云 DOTNET SDK 支持使用 泛用型的API调用方式(Common Client) 进行请求。您只需安装 common 包, 即可向任何产品发起调用。
注意,您必须明确知道您调用接口的参数内容,否则会调用失败。
详细使用请参阅示例:使用 Common Client 进行调用
更多示例参见 TencentCloudExamples 目录。
新版本SDK中同时提供了异步接口和同步接口,同步接口统一在异步接口之后添加了Sync后缀,在上述代码中已有样例。
注意:
在 TencentCloudExamples 示例项目中由于是控制台应用程序,所以可以使用同步方式调用异步接口,即ConfigureAwait(false).GetAwaiter().GetResult()。
在开发 ASP 应用程序,或者 Windows Forms 应用程序时,UI 控件的响应方法中,不能使用同步方式调用异步接口,否则会造成界面停止响应。
解决的办法是将 UI 控件的响应方法改为异步,同时要注意同步上下文。
另外,由于异步调用立即返回控制权给用户,很容易造成用户多次点击,或者用户进行了一些不期望的操作,程序中应注意此类问题。
源码可以参考项目中的WindowsFormsDemo项目。
SDK 依赖的 FluentClient 使用的是3.2版本,但这个包目前发布了4.0版本且不兼容低版本,在 nuget 中升级此包到4.0版本会导致无法调用或调用失败等问题。
暂无开放 Issues,或尚未同步最近议题。