本文介绍安装日志服务.NET Core SDK及使用.NET Core SDK完成常见操作的相关步骤。
前提条件
- 已开通日志服务。更多信息,请参见开通日志服务。
- 已创建并获取AccessKey。更多信息,请参见访问密钥。
- 已创建Project。更多信息,请参见创建Project。
- 已安装NET Core开发环境。
日志服务.NET Core SDK支持以下平台及版本:
- .NET Core 2.0
- .NET Framework (with .NET Core 1.x SDK) 4.6.2
- .NET Framework (with .NET Core 2.0 SDK) 4.6.1
- Mono 5.4
- Xamarin.iOS 10.14
- Xamarin.Mac 3.8
- Xamarin.Android 8.0
- Universal Windows Platform 10.0.16299
步骤1:安装.NET Core SDK
您可以通过项目引入方式安装.NET Core SDK,此处以通过Visual Studio 2019安装.NET Core SDK为例。
- 下载.NET Core SDK。
- 解压安装包aliyun-log-dotnetcore-sdk-master.zip到指定目录。
- 使用Visual Studio 2019打开aliyun-log-dotnetcore-sdk-master\Aliyun.Api.LogService.Examples\Aliyun.Api.LogService.Examples.csproj文件,执行调试安装。
步骤2:创建日志服务Client
ILogServiceClient是日志服务的.NET Core客户端,用于管理Project、Logstore等日志服务资源。使用.NET Core SDK发起日志服务请求,您需要初始化一个Client实例。
public static ILogServiceClient BuildSimpleClient()
{
return LogServiceClientBuilders.HttpBuilder
.Endpoint("endpoint", "projectName") // 日志服务的域名和已创建的Project名称。更多域名信息,请参见服务入口。
.Credential("accessKeyId", "accessKey") // 阿里云访问密钥AccessKey ID和钥AccessKey Secret。更多信息,请参见访问密钥。阿里云主账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM账号进行API访问或日常运维。
.Build();
}
.NET Core SDK示例
日志服务.NET SDK提供丰富的示例程序,方便参考或直接使用,更多信息,请参见aliyun-log-dotnetcore-sdk。此处以抛出业务异常为例进行说明,示例代码如下所示:
public async Task Caller()
{
try
{
return await Wrapper();
} catch (LogServiceException e)
{
// 捕获LogServiceException异常后,获取如下信息:
Console.WriteLine($@"
RequestId (请求ID): {e.RequestId}
ErrorCode (错误码): {e.ErrorCode}
ErrorMessage (错误消息): {e.ErrorMessage}");
throw;
}
}
private async Task<IResponse> Wrapper()
{
var response = await client.GetLogsAsync(...);
return response
// 如果请求返回结果不成功,则抛出LogServiceException异常。
.EnsureSuccess()
.Result;
}