PowerShell调用API执行CosmosDB跨分区查询失败求助

问题描述 #

我有一个PowerShell脚本，能够正常执行多项操作，比如按ID查询容器中的特定项、查询同一分区键下的一组项等。

但在执行跨分区查询时，脚本失败，报错如下：

Invoke-RestMethod : The remote server returned an error: (400) Bad Request.
At line:1 char:15
+ ...   $result = Invoke-RestMethod -Uri $requestURI -Headers $header -Meth ...
+                 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : InvalidOperation: (System.Net.HttpWebRequest:HttpWebRequest) [Invoke-RestMethod], WebException
    + FullyQualifiedErrorId : WebCmdletWebResponseException,Microsoft.PowerShell.Commands.InvokeRestMethodCommand

请求头配置如下：

$header = @{
        "Authorization"                              = "$Authorization";
        "Content-Type"                               = "application/query+json";
        "x-ms-date"                                  = $($xmsdate.ToString().ToLower());
        "x-ms-documentdb-isquery"                    = "true";
        "x-ms-documentdb-query-enablecrosspartition" = "true";
        "x-ms-documentdb-populatequerymetrics"       = "true";
    }

示例 #

可正常执行的查询 #

$body = @{
    query = 'SELECT VALUE COUNT(1) FROM c WHERE c.partitionKey IN ("ef5af949")'
    parameters = @()
} | ConvertTo-Json

$body = @{
    query = 'SELECT VALUE COUNT(1) FROM c WHERE c.partitionKey = "ef5af949"'
    parameters = @()
} | ConvertTo-Json

执行失败的查询 #

$body = @{
    query = 'SELECT VALUE COUNT(1) FROM c'
    parameters = @()
} | ConvertTo-Json

$body = @{
    query = 'SELECT VALUE COUNT(1) FROM c WHERE c.partitionKey IN ("ef5af949", "eaafb5a5")'
    parameters = @()
} | ConvertTo-Json

需求 #

请问问题出在哪里？我仅需执行'SELECT VALUE COUNT(1) FROM c'来统计指定容器中的项目数量。

若需要更多信息，请告知。另外，我不确定这是否属于网关无法处理的查询限制。

解决方案 #

1. 核心问题：签名计算遗漏跨分区请求头 #

Cosmos DB REST API要求所有x-ms-*开头的请求头都必须纳入Authorization签名的哈希计算。你的请求头中已经添加了x-ms-documentdb-query-enablecrosspartition=true，但如果生成Authorization签名时没有将这个头包含进去，就会触发400 Bad Request错误。

检查你的签名生成逻辑，确保将所有x-ms-开头的请求头（包括x-ms-documentdb-query-enablecrosspartition）都加入到签名的待哈希字符串中。

2. 验证查询语法兼容性 #

虽然COUNT(1)和COUNT(*)语义一致，但部分跨分区场景下COUNT(*)的兼容性更好，可以尝试修改查询语句：

$body = @{
    query = 'SELECT VALUE COUNT(*) FROM c'
    parameters = @()
} | ConvertTo-Json

3. 指定API版本（可选） #

如果使用的是较旧的Cosmos DB API版本，可能对跨分区聚合查询支持有限。在请求头中添加指定版本的x-ms-version（建议使用2021-05-15或更高版本）：

$header.Add("x-ms-version", "2021-05-15")

4. 替代方案：使用容器元数据获取近似计数 #

如果跨分区查询始终无法生效，可以直接读取容器的元数据获取近似文档总数，这种方式无需执行查询，性能更高：

# 替换为你的容器URI
$containerUri = "https://<your-account>.documents.azure.com/dbs/<your-db-id>/colls/<your-container-id>"
$containerInfo = Invoke-RestMethod -Uri $containerUri -Headers $header -Method Get
$totalDocuments = $containerInfo.documentCount

注意：该计数为近似值，存在几分钟的延迟，但足以满足大多数统计场景需求。

内容的提问来源于stack exchange，提问作者Yousef Imran