查询/管理 HTTP 请求Query/management HTTP request

• 10/29/2020
• • o
  • v

请求谓词和资源Request verb and resource

例如，若要将控制命令（“management”）发送到服务终结点，请使用以下请求行：For example, to send a control command ("management") to a service endpoint, use the following request line:

POST https://help.kusto.chinacloudapi.cn/v1/rest/mgmt HTTP/1.1

有关要包含的请求标头和正文，请参见下文。See below for the request headers and body to include.

请求标头Request headers

下表包含用于查询和管理操作的常用标头。The following table contains the common headers used for query and management operations.

下表包含用于查询和管理操作的常用自定义标头。The following table contains the common custom headers used for query and management operations. 除非另有说明，否则这些标头仅用于遥测目的，而不会影响功能。Unless otherwise indicated, these headers are used for telemetry purposes only, and have no functionality impact.

所有标头都是可选项。All headers are optional. 建议指定 x-ms-client-request-id 自定义标头。We recommend that you specify the x-ms-client-request-id custom header. 在某些情况下（例如取消正在运行的查询），此标头是必需的，因为它用于标识请求。In some scenarios, such as canceling a running query, this header is required because it's used to identify the request.

请求参数Request parameters

以下参数可以在请求中传递。The following parameters can be passed in the request. 它们在请求中被编码为查询参数，或编码为正文的一部分，具体取决于是使用 GET 还是 POST。They're encoded in the request as query parameters or as part of the body, depending on whether GET or POST is used.

GET 查询参数GET query parameters

使用 GET 时，请求的查询参数会指定请求参数。When GET is used, the query parameters of the request specify the request parameters.

正文Body

使用 POST 时，请求正文是以 UTF-8 编码的单个 JSON 文档，其中包含请求参数的值。When POST is used, the body of the request is a single JSON document encoded in UTF-8, with the values of the request parameters.

示例Examples

此示例显示查询的 HTTP POST 请求。This example shows the HTTP POST request for a query.

POST https://help.kusto.chinacloudapi.cn/v2/rest/query HTTP/1.1

请求标头Request headers

Accept: application/json
Authorization: Bearer ...AzureActiveDirectoryAccessToken...
Accept-Encoding: deflate
Content-Type: application/json; charset=utf-8
Host: help.kusto.chinacloudapi.cn
x-ms-client-request-id: MyApp.Query;e9f884e4-90f0-404a-8e8b-01d883023bf1
x-ms-user-id: EARTH\davidbg
x-ms-app: MyApp

请求正文Request body

{
  "db":"Samples",
  "csl":"print Test=\"Hello, World!\"",
  "properties":"{\"Options\":{\"queryconsistency\":\"strongconsistency\"},\"Parameters\":{},\"ClientRequestId\":\"MyApp.Query;e9f884e4-90f0-404a-8e8b-01d883023bf1\"}"
}

此示例演示如何使用 curl 创建用于发送上述查询的请求。This example shows how to create a request that sends the query above, using curl.

1. 获取用于身份验证的令牌。Obtain a token for authentication.

   在设置了 AAD 应用程序身份验证之后，将 AAD_TENANT_NAME_OR_ID、AAD_APPLICATION_ID 和 AAD_APPLICATION_KEY 替换为相关值Replace AAD_TENANT_NAME_OR_ID, AAD_APPLICATION_ID, and AAD_APPLICATION_KEY with the relevant values, after having set up AAD application authentication

   curl "https://login.partner.microsoftonline.cn/AAD_TENANT_NAME_OR_ID/oauth2/token" \
     -F "grant_type=client_credentials" \
     -F "resource=https://help.kusto.chinacloudapi.cn" \
     -F "client_id=AAD_APPLICATION_ID" \
     -F "client_secret=AAD_APPLICATION_KEY"
   

   此代码片段将为你提供持有者令牌。This code snippet will provide you with the bearer token.

   {
     "token_type": "Bearer",
     "expires_in": "3599",
     "ext_expires_in":"3599", 
     "expires_on":"1578439805",
     "not_before":"1578435905",
     "resource":"https://help.kusto.chinacloudapi.cn",
     "access_token":"eyJ0...uXOQ"
   }
   

2. 在向查询终结点发送的请求中使用持有者令牌。Use the bearer token in your request to the query endpoint.

   curl -d '{"db":"Samples","csl":"print Test=\"Hello, World!\"","properties":"{\"Options\":{\"queryconsistency\":\"strongconsistency\"}}"}"' \
   -H "Accept: application/json" \
   -H "Authorization: Bearer eyJ0...uXOQ" \
   -H "Content-Type: application/json; charset=utf-8" \
   -H "Host: help.kusto.chinacloudapi.cn" \
   -H "x-ms-client-request-id: MyApp.Query;e9f884e4-90f0-404a-8e8b-01d883023bf1" \
   -H "x-ms-user-id: EARTH\davidbg" \
   -H "x-ms-app: MyApp" \
   -X POST https://help.kusto.chinacloudapi.cn/v2/rest/query
   

3. 根据此规范，读取响应。Read the response according to this specification.