Question

我正在评估DocumentDb并尝试通过DocumentDb Rest api提交查询。

当我尝试发布查询时，我收到以下错误消息：

"The input content is invalid because the required properties - 'id; ' - are missing"
"The request payload is invalid. Ensure to provide a valid request payload."

这似乎表明集合中的文档没有id属性，但这是我从azure门户网站检索到的当前测试数据，你可以看到它有一个id属性：

[
  {
    "id": "c1058415-8e03-49e2-8c41-97bc902ebfb0",
    "name": "Add a thing",
    "description": "Ad a thing to the list"
  },
  {
    "id": "0f88f4af-7afc-4928-a60f-c3546b28e243",
    "name": "find another thing",
    "description": "find another thing"
  },
  {
    "id": "b669dbc6-6056-4392-a898-4d846e6c0126",
    "name": "stuff goes there",
    "description": "stuff goes there"
  }
]

以下是我目前正在尝试使用的代码（请注意，实际值已被虚拟数据替换）：

private static readonly string MasterKey = "my master key";
private static readonly Uri BaseUri = new Uri("https://mydocdb.documents.azure.com");

private static bool _useNames = true;
private static readonly string DatabaseId = _useNames ? "MyDatabase" : "prdnAA==";
private static readonly string CollectionId = _useNames ? "MyCollection" : "prdnAKFrZAA=";

private static readonly string UtcDate = DateTime.UtcNow.ToString("r");
private static void Main(string[] args)
{
    var client = new HttpClient();
    client.DefaultRequestHeaders.Add("x-ms-date", UtcDate);
    client.DefaultRequestHeaders.Add("x-ms-documentdb-isquery", "True");
    client.DefaultRequestHeaders.Add("x-ms-version", "2015-08-06");

    string verb = "POST";
    string resourceType = "docs";
    string resourceLink = $"dbs/{DatabaseId}/colls/{CollectionId}/docs";
    string resourceId = _useNames ? $"dbs/{DatabaseId}/colls/{CollectionId}" : $"{CollectionId}";

    string authHeader = GenerateAuthToken(verb, resourceId, resourceType, MasterKey, "master", "1.0");
    client.DefaultRequestHeaders.Remove("authorization");
    client.DefaultRequestHeaders.Add("authorization", authHeader);

    var response = client.PostAsync(
        new Uri(BaseUri, resourceLink),
        new StringContent("{\"query\":\"SELECT * FROM root \"}",
            Encoding.UTF8,
            "application/query+json")
        ).Result;
    string result = response.Content.ReadAsStringAsync().Result;
    Console.WriteLine(result);
}

private static string GenerateAuthToken(string verb, string resourceId, string resourceType, string key,
    string keyType, string tokenVersion)
{
    var verbInput = verb ?? "";
    var resourceIdInput = resourceId ?? "";
    var resourceTypeInput = resourceType ?? "";

    var payLoad = string.Format(CultureInfo.InvariantCulture, 
        "{0}\n{1}\n{2}\n{3}\n{4}\n",
        verbInput.ToLowerInvariant(),
        resourceTypeInput.ToLowerInvariant(),
        resourceIdInput,
        UtcDate.ToLowerInvariant(),
        ""
        );

    var hmacSha256 = new HMACSHA256 { Key = Convert.FromBase64String(key) };
    var hashPayLoad = hmacSha256.ComputeHash(Encoding.UTF8.GetBytes(payLoad));
    var signature = Convert.ToBase64String(hashPayLoad);

    return HttpUtility.UrlEncode(
        string.Format(
            CultureInfo.InvariantCulture,
            "type={0}&ver={1}&sig={2}",
            keyType,
            tokenVersion,
            signature)
        );
}

此代码是Access Control on DocumentDB Resources文档中示例代码的变体。页面上给出的示例代码相当有缺陷，因为它使用函数GenerateMasterKeyAuthorizationSignature，但函数名为GenerateAuthToken，就像这个例子一样。它还仅显示针对api的GET请求，并且不指示如何为POST请求创建授权令牌有效内容。这就是为什么我最关心的主要是授权标题。我不相信我正确设置了resourceId或resourceType。如果我尝试一个空的resourceId，这是我期望用于查询的，那么我会得到一个未经授权的响应，指示有效负载的预期resourceId是对集合的引用（如果我使用_rid的，则为小写的collectionId）数据库和集合的名称，如果我使用名称，则为命名路径。）

注意自此更新了引用的文档页面，并删除了示例代码。我还找到了生成auth头的其他引用，发现我正确创建它。

创建授权有效负载时，我是否使用了正确的ResourceType和ResourceId值？如果我是，为什么我收到有关所需id属性的错误？

如果我没有使用正确的值，它们应该是什么？

解决方案更新

正如Ryan指出的那样，问题在于ContentType标头的CharSet属性。他的链接代码可能是更好的方法，但我也发现我可以创建StringContent的变量并在发布之前对其进行修改以获得预期的结果。

var stringQuery = new StringContent("{\"query\":\"SELECT * FROM root \"}",
    Encoding.UTF8,
    "application/query+json");
stringQuery.Headers.ContentType.CharSet = null;
HttpResponseMessage response = client.PostAsync(new Uri(BaseUri, resourceLink)
    ,stringQuery).Result;

Answer 1

请参阅REST API文档以查询资源 - https://msdn.microsoft.com/en-us/library/azure/dn783363.aspx

看起来您缺少ContentType标头。这必须设置为＆＃34; application / query + json＆＃34;查询。

即使您添加了这个，我怀疑您接下来会遇到的问题是.NET HttpClient在执行POST时总是在此标头的末尾添加一个字符集。在您使用Encoding.UTF8的代码中可以看到。

不幸的是，.NET（我知道）没有简单的方法可以在不指定字符集的情况下进行POST。

我创建了一个带有.NET HttpClient自定义扩展的示例。

看看来自.NET的＃34; REST＆＃34;样本发布在github上 - https://github.com/Azure/azure-documentdb-dotnet/tree/master/samples/rest-from-.net

此示例将准确显示应使用的值和时间。它对所有主要资源进行GET，并对执行查询执行POST。

为DocumentDb查询帖子创建授权有效负载的正确方法是什么？

1 个答案: