你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

获取分区键范围

对特定集合的pkranges子资源执行操作GET可检索集合的分区键范围列表。

注意

这些 API 参考文章演示如何使用 Azure Cosmos DB 数据平面 API 创建资源。 使用数据平面 API,可以配置基本选项,例如索引策略,分区键非常类似于使用 Cosmos DB SDK。 如果需要对所有 Azure Cosmos DB 资源提供完整的功能支持,我们建议使用 Cosmos DB 资源提供程序

请求

方法 请求 URI 说明
GET https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id}/pkranges 请注意,这是{databaseaccount}在订阅下创建的 Azure Cosmos DB 帐户的名称。 {db-id}数据库的 ID 和 {coll-id} 值是集合的 ID。

头文件

有关所有Cosmos DB 请求使用的标头,请参阅常见的 Azure Cosmos DB REST 请求标头

Body

无。

响应

返回集合的分区键范围列表。

头文件

有关所有Cosmos DB 响应返回的标头,请参阅常见的 Azure Cosmos DB REST 响应标头

状态代码

下表列出了此操作返回的常见状态代码。 有关状态代码的完整列表,请参阅 HTTP 状态代码

HTTP 状态代码 说明
200 正常 操作成功。
404 未找到 找不到集合。

正文

属性 描述
id 这是标识集合的唯一名称。
_rid 这是系统生成的属性。 资源 ID (_rid) 是一个唯一标识符,也是资源模型中的资源堆栈的分层标识符。 它可供内部用于放置和导航权限资源。
_ts 这是系统生成的属性。 它指定资源的上次更新时间戳。 高值是一个时间戳。
_self 这是系统生成的属性。 它是资源的唯一可寻址 URI。
_etag 这是一个系统生成的属性,表示乐观并发控制所需的资源 etag
PartitionKeyRanges 这是集合的分区键范围列表。 这可用于标头的 x-ms-documentdb-partitionkeyrangeid 增量读取。

PartitionKeyRanges 的属性

属性 描述
id

分区键范围的 ID。 此 ID 在每个集合中是固定且唯一的。

可用于按分区键范围读取文档。

maxExclusive 分区键范围的最大分区键哈希值。 供内部使用。
minInclusive 分区键范围的最小分区键哈希值。 供内部使用。

示例

可以通过请求集合中的 pkranges 资源来检索分区键范围。 例如,以下请求检索 serverlogs 集合的分区键范围列表:

    GET https://querydemo.documents.azure.com/dbs/bigdb/colls/serverlogs/pkranges HTTP/1.1
    x-ms.date: 04/20/2021
    authorization: type%3dmaster%26ver%3d1.0%26sig%3dEConYmRgDExu6q%2bZ8GjfUGOH0AcOx%2behkancw3LsGQ8%3d
    x-ms-consistency-level: Session
    x-ms-version: 2016-07-11
    Accept: application/json
    Host: querydemo.documents.azure.com

此请求返回以下响应,其中包含有关分区键范围的元数据:

    HTTP/1.1 200 Ok
    Content-Type: application/json
    x-ms-item-count: 25
    x-ms-schemaversion: 1.1
    Date: Tue, 15 Nov 2016 07:26:51 GMT

    {
       "_rid":"qYcAAPEvJBQ=",
       "PartitionKeyRanges":[
          {
             "_rid":"qYcAAPEvJBQCAAAAAAAAUA==",
             "id":"0",
             "_etag":"\"00002800-0000-0000-0000-580ac4ea0000\"",
             "minInclusive":"",
             "maxExclusive":"05C1CFFFFFFFF8",
             "_self":"dbs\/qYcAAA==\/colls\/qYcAAPEvJBQ=\/pkranges\/qYcAAPEvJBQCAAAAAAAAUA==\/",
             "_ts":1477100776
          },
          ...
       ],
       "_count": 25
    }

另请参阅