HttpClient.GetAsync 方法

定义

命名空间:: System.Net.Http

程序集:: System.Net.Http.dll

程序集:: netstandard.dll

重要

一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。

将 GET 请求作为异步操作发送到指定的 URI。

重载

名称	说明
GetAsync(String)	将 GET 请求作为异步操作发送到指定的 URI。
GetAsync(Uri)	将 GET 请求作为异步操作发送到指定的 URI。
GetAsync(String, HttpCompletionOption)	使用 HTTP 完成选项作为异步操作将 GET 请求发送到指定的 URI。
GetAsync(String, CancellationToken)	将 GET 请求作为异步操作发送到具有取消令牌的指定 URI。
GetAsync(Uri, HttpCompletionOption)	使用 HTTP 完成选项作为异步操作将 GET 请求发送到指定的 URI。
GetAsync(Uri, CancellationToken)	将 GET 请求作为异步操作发送到具有取消令牌的指定 URI。
GetAsync(String, HttpCompletionOption, CancellationToken)	使用 HTTP 完成选项和取消令牌作为异步操作将 GET 请求发送到指定的 URI。
GetAsync(Uri, HttpCompletionOption, CancellationToken)	使用 HTTP 完成选项和取消令牌作为异步操作将 GET 请求发送到指定的 URI。

注解

该操作不会阻止。

GetAsync(String)

将 GET 请求作为异步操作发送到指定的 URI。

public:
 System::Threading::Tasks::Task<System::Net::Http::HttpResponseMessage ^> ^ GetAsync(System::String ^ requestUri);

public System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage> GetAsync(string requestUri);

member this.GetAsync : string -> System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage>

Public Function GetAsync (requestUri As String) As Task(Of HttpResponseMessage)

参数

requestUri: String

请求发送到的 URI。

Task<HttpResponseMessage>

表示异步操作的任务对象。

例外

InvalidOperationException

requestUri不是绝对 URI，BaseAddress未设置。

HttpRequestException

请求由于收到有效的 HTTP 响应（例如网络连接失败、DNS 失败、服务器证书验证错误或服务器响应无效）而失败。在 .NET 8 及更高版本中，原因由 HttpRequestError

-或-

仅.NET框架：请求超时。

OperationCanceledException

.NET Core 和 .NET 5 及更高版本：请求因超时而失败。

UriFormatException

提供的请求 URI 不是有效的相对 URI 或绝对 URI。

注解

此操作不会阻止。返回 Task<TResult> 的对象将在读取整个响应（包括内容）后完成。行为与显式指定的行为相同 ResponseContentRead 。

注释

如果超时，则会在不同的.NET实现上引发不同的异常。

HttpRequestException在所有适用的 .NET框架版本上引发。
OperationCanceledException在所有适用的 .NET Core 版本上引发任何内部异常。
嵌套 TimeoutException 的 OperationCanceledException 会在 5 及更高版本.NET引发。

适用于

GetAsync(Uri)

将 GET 请求作为异步操作发送到指定的 URI。

public:
 System::Threading::Tasks::Task<System::Net::Http::HttpResponseMessage ^> ^ GetAsync(Uri ^ requestUri);

public System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage> GetAsync(Uri requestUri);

member this.GetAsync : Uri -> System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage>

Public Function GetAsync (requestUri As Uri) As Task(Of HttpResponseMessage)

参数

requestUri: Uri

请求发送到的 URI。

Task<HttpResponseMessage>

表示异步操作的任务对象。

例外

InvalidOperationException

requestUri不是绝对 URI，BaseAddress未设置。

HttpRequestException

-或-

仅.NET框架：请求超时。

OperationCanceledException

.NET Core 和 .NET 5 及更高版本：请求因超时而失败。

注解

此操作不会阻止。返回 Task<TResult> 的对象将在读取整个响应（包括内容）后完成。行为与显式指定的行为相同 ResponseContentRead 。

注释

如果超时，则会在不同的.NET实现上引发不同的异常。

HttpRequestException在所有适用的 .NET框架版本上引发。
OperationCanceledException在所有适用的 .NET Core 版本上引发任何内部异常。
嵌套 TimeoutException 的 OperationCanceledException 会在 5 及更高版本.NET引发。

适用于

GetAsync(String, HttpCompletionOption)

使用 HTTP 完成选项作为异步操作将 GET 请求发送到指定的 URI。

public:
 System::Threading::Tasks::Task<System::Net::Http::HttpResponseMessage ^> ^ GetAsync(System::String ^ requestUri, System::Net::Http::HttpCompletionOption completionOption);

public System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage> GetAsync(string requestUri, System.Net.Http.HttpCompletionOption completionOption);

member this.GetAsync : string * System.Net.Http.HttpCompletionOption -> System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage>

Public Function GetAsync (requestUri As String, completionOption As HttpCompletionOption) As Task(Of HttpResponseMessage)

参数

requestUri: String

请求发送到的 URI。

completionOption: HttpCompletionOption

一个 HTTP 完成选项值，该值指示何时应将操作视为已完成。

Task<HttpResponseMessage>

表示异步操作的任务对象。

例外

InvalidOperationException

requestUri不是绝对 URI，BaseAddress未设置。

HttpRequestException

由于网络连接、DNS 故障、服务器证书验证或超时等基础问题，请求失败。

OperationCanceledException

.NET Core 和 .NET 5 及更高版本：请求因超时而失败。

UriFormatException

提供的请求 URI 不是有效的相对 URI 或绝对 URI。

注解

此操作不会阻止。在读取部分或所有响应（包括内容）后，completionOption返回Task<TResult>的对象将基于参数完成。

注释

如果超时，则会在不同的.NET实现上引发不同的异常。

HttpRequestException在所有适用的 .NET框架版本上引发。
OperationCanceledException在所有适用的 .NET Core 版本上引发任何内部异常。
嵌套 TimeoutException 的 OperationCanceledException 会在 5 及更高版本.NET引发。

适用于

GetAsync(String, CancellationToken)

将 GET 请求作为异步操作发送到具有取消令牌的指定 URI。

public:
 System::Threading::Tasks::Task<System::Net::Http::HttpResponseMessage ^> ^ GetAsync(System::String ^ requestUri, System::Threading::CancellationToken cancellationToken);

public System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage> GetAsync(string requestUri, System.Threading.CancellationToken cancellationToken);

member this.GetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage>

Public Function GetAsync (requestUri As String, cancellationToken As CancellationToken) As Task(Of HttpResponseMessage)

参数

requestUri: String

请求发送到的 URI。

cancellationToken: CancellationToken

其他对象或线程可以使用的取消令牌来接收取消通知。

Task<HttpResponseMessage>

表示异步操作的任务对象。

例外

InvalidOperationException

requestUri不是绝对 URI，BaseAddress未设置。

HttpRequestException

-或-

仅.NET框架：请求超时。

UriFormatException

提供的请求 URI 不是有效的相对 URI 或绝对 URI。

OperationCanceledException

取消令牌已取消。此异常存储在返回的任务中。

-或-

.NET Core 和 .NET 5 及更高版本：请求因超时而失败。

注解

此操作不会阻止。返回 Task<TResult> 的对象将在读取整个响应（包括内容）后完成。行为与显式指定的行为相同 ResponseContentRead 。

注释

如果超时，则会在不同的.NET实现上引发不同的异常。

HttpRequestException在所有适用的 .NET框架版本上引发。
OperationCanceledException在所有适用的 .NET Core 版本上引发任何内部异常。
嵌套 TimeoutException 的 OperationCanceledException 会在 5 及更高版本.NET引发。

适用于

GetAsync(Uri, HttpCompletionOption)

使用 HTTP 完成选项作为异步操作将 GET 请求发送到指定的 URI。

public:
 System::Threading::Tasks::Task<System::Net::Http::HttpResponseMessage ^> ^ GetAsync(Uri ^ requestUri, System::Net::Http::HttpCompletionOption completionOption);

public System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage> GetAsync(Uri requestUri, System.Net.Http.HttpCompletionOption completionOption);

member this.GetAsync : Uri * System.Net.Http.HttpCompletionOption -> System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage>

Public Function GetAsync (requestUri As Uri, completionOption As HttpCompletionOption) As Task(Of HttpResponseMessage)

参数

requestUri: Uri

请求发送到的 URI。

completionOption: HttpCompletionOption

一个 HTTP 完成选项值，该值指示何时应将操作视为已完成。

Task<HttpResponseMessage>

表示异步操作的任务对象。

例外

InvalidOperationException

requestUri不是绝对 URI，BaseAddress未设置。

HttpRequestException

-或-

仅.NET框架：请求超时。

OperationCanceledException

.NET Core 和 .NET 5 及更高版本：请求因超时而失败。

注解

此操作不会阻止。在读取部分或所有响应（包括内容）后，completionOption返回Task<TResult>的对象将基于参数完成。

注释

如果超时，则会在不同的.NET实现上引发不同的异常。

HttpRequestException在所有适用的 .NET框架版本上引发。
OperationCanceledException在所有适用的 .NET Core 版本上引发任何内部异常。
嵌套 TimeoutException 的 OperationCanceledException 会在 5 及更高版本.NET引发。

适用于

GetAsync(Uri, CancellationToken)

将 GET 请求作为异步操作发送到具有取消令牌的指定 URI。

public:
 System::Threading::Tasks::Task<System::Net::Http::HttpResponseMessage ^> ^ GetAsync(Uri ^ requestUri, System::Threading::CancellationToken cancellationToken);

public System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage> GetAsync(Uri requestUri, System.Threading.CancellationToken cancellationToken);

member this.GetAsync : Uri * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage>

Public Function GetAsync (requestUri As Uri, cancellationToken As CancellationToken) As Task(Of HttpResponseMessage)

参数

requestUri: Uri

请求发送到的 URI。

cancellationToken: CancellationToken

其他对象或线程可以使用的取消令牌来接收取消通知。

Task<HttpResponseMessage>

表示异步操作的任务对象。

例外

InvalidOperationException

requestUri不是绝对 URI，BaseAddress未设置。

HttpRequestException

由于收到 HTTP 响应（例如网络连接、DNS 失败或服务器证书验证）的问题，请求失败。在 .NET 8 及更高版本中，原因由 HttpRequestError

-或-

仅.NET框架：请求超时。

OperationCanceledException

取消令牌已取消。此异常存储在返回的任务中。

-或-

.NET Core 和 .NET 5 及更高版本：请求因超时而失败。

注解

此操作不会阻止。返回 Task<TResult> 的对象将在读取整个响应（包括内容）后完成。行为与显式指定的行为相同 ResponseContentRead 。

注释

如果超时，则会在不同的.NET实现上引发不同的异常。

HttpRequestException在所有适用的 .NET框架版本上引发。
OperationCanceledException在所有适用的 .NET Core 版本上引发任何内部异常。
嵌套 TimeoutException 的 OperationCanceledException 会在 5 及更高版本.NET引发。

适用于

GetAsync(String, HttpCompletionOption, CancellationToken)

使用 HTTP 完成选项和取消令牌作为异步操作将 GET 请求发送到指定的 URI。

public:
 System::Threading::Tasks::Task<System::Net::Http::HttpResponseMessage ^> ^ GetAsync(System::String ^ requestUri, System::Net::Http::HttpCompletionOption completionOption, System::Threading::CancellationToken cancellationToken);

public System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage> GetAsync(string requestUri, System.Net.Http.HttpCompletionOption completionOption, System.Threading.CancellationToken cancellationToken);

member this.GetAsync : string * System.Net.Http.HttpCompletionOption * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage>

Public Function GetAsync (requestUri As String, completionOption As HttpCompletionOption, cancellationToken As CancellationToken) As Task(Of HttpResponseMessage)

参数

requestUri: String

请求发送到的 URI。

completionOption: HttpCompletionOption

一个 HTTP 完成选项值，该值指示何时应将操作视为已完成。

cancellationToken: CancellationToken

其他对象或线程可以使用的取消令牌来接收取消通知。

Task<HttpResponseMessage>

表示异步操作的任务对象。

例外

InvalidOperationException

requestUri不是绝对 URI，BaseAddress未设置。

HttpRequestException

-或-

仅.NET框架：请求超时。

UriFormatException

提供的请求 URI 不是有效的相对 URI 或绝对 URI。

OperationCanceledException

取消令牌已取消。此异常存储在返回的任务中。

-或-

.NET Core 和 .NET 5 及更高版本：请求因超时而失败。

注解

此操作不会阻止。在读取部分或所有响应（包括内容）后，completionOption返回Task<TResult>的对象将基于参数完成。

注释

如果超时，则会在不同的.NET实现上引发不同的异常。

HttpRequestException在所有适用的 .NET框架版本上引发。
OperationCanceledException在所有适用的 .NET Core 版本上引发任何内部异常。
嵌套 TimeoutException 的 OperationCanceledException 会在 5 及更高版本.NET引发。

适用于

GetAsync(Uri, HttpCompletionOption, CancellationToken)

使用 HTTP 完成选项和取消令牌作为异步操作将 GET 请求发送到指定的 URI。

public:
 System::Threading::Tasks::Task<System::Net::Http::HttpResponseMessage ^> ^ GetAsync(Uri ^ requestUri, System::Net::Http::HttpCompletionOption completionOption, System::Threading::CancellationToken cancellationToken);

public System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage> GetAsync(Uri requestUri, System.Net.Http.HttpCompletionOption completionOption, System.Threading.CancellationToken cancellationToken);

member this.GetAsync : Uri * System.Net.Http.HttpCompletionOption * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage>

Public Function GetAsync (requestUri As Uri, completionOption As HttpCompletionOption, cancellationToken As CancellationToken) As Task(Of HttpResponseMessage)