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

获取集合

项目
08/05/2023

对特定集合资源执行 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}	{databaseaccount} 是在订阅下创建的 Azure Cosmos DB 帐户的名称。 {db-id} 值是用户生成的数据库名称/ID，而不是系统生成的 ID (rid) 。 {coll-id} 值是集合的名称。

标头

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

正文

无。

响应

Get Collection 返回在 Cosmos DB 中保留的集合正文，以及报告集合配额和使用情况的响应标头。

标头

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

状态代码

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

HTTP 状态代码	说明
200 正常	操作成功。
404 未找到	集合不再是资源，即集合已被删除。

正文

属性	说明
id	它是标识新集合的唯一名称。
_摆脱	它是系统生成的属性。资源 ID (_rid) 是一个唯一标识符，也是按资源模型上的资源堆栈分层的标识符。它可供内部用于放置和导航权限资源。
_ts	它是系统生成的属性。它指定资源的上次更新时间戳。高值是一个时间戳。
_自我	它是系统生成的属性。它是资源的唯一可寻址 URI。
_Etag	它是系统生成的属性，表示乐观并发控制所需的资源 etag 。
_医生	它是一个系统生成的属性，用于指定文档资源的可寻址路径。
_sprocs	它是系统生成的属性，指定 (sprocs) 资源的存储过程的可寻址路径。
_触发器	它是一个系统生成的属性，用于指定触发器资源的可寻址路径。
_Udf	它是一个系统生成的属性，指定用户定义函数 (udfs) 资源的可寻址路径。
_冲突	它是系统生成的属性，用于指定冲突资源的可寻址路径。针对某个集合中的资源进行操作时，如果发生冲突，用户可以通过对冲突 URI 路径执行 GET 操作来检查发生冲突的资源。
indexingPolicy	它是集合的索引策略设置。

索引策略下的属性

属性	说明
自动	指示自动索引是打开还是关闭。默认值为 True，因此会为所有文档编制索引。将值设置为 False 即可对索引路径进行手动配置。
indexingMode	默认情况下，索引模式为“一致”。这意味着在插入、替换或删除文档期间同步进行索引编制。若要让索引异步发生，可将索引模式设置为 lazy。
includedPaths	一个数组，包含要编制索引的文档路径。默认情况下，包括两个路径：指定所有文档路径索引的 / 路径和_ts路径（为时间戳范围比较编制索引）。数组中的元素内。

包含路径下的属性

属性	说明
路径	索引行为适用的路径。索引路径以根 (/) 开头，通常以问号 (？) 通配符运算符结尾，表示前缀有多个可能值。例如，对于 SELECT * FROM Families F WHERE F.familyName = "Andersen"，必须在集合的索引策略中包含 /familyName/? 的索引路径。索引路径还可以使用 * 通配符操作符以递归方式指定路径在前缀下的行为。例如，/payload/* 可用于从索引中排除有效负载属性下的所有内容。
dataType	它是对其应用索引行为的数据类型。可以是 String、 Number、 Point、 Polygon 或 LineString。布尔值和 null 自动编制索引
kind	索引的类型。哈希索引可用于相等比较，而范围索引可用于相等、范围比较和排序。空间索引对于空间查询很有用。
精度	索引的精度。对于最大精度，可以设置为 -1;对于 Number，可以设置为 1-8;对于 String，可以设置为 1-100。不适用于 Point、 Polygon 和 LineString 数据类型。

分区键下的属性

属性	说明
路径	一个路径数组，使用集合中的数据可以分区。路径不得包含通配符或尾随斜杠。例如，JSON 属性“AccountNumber”指定为“/AccountNumber”。数组必须仅包含单个值。
kind	用于分区的算法。仅支持哈希。

{  
  "id": "testcoll",  
  "indexingPolicy": {  
    "indexingMode": "consistent",  
    "automatic": true,  
    "includedPaths": [  
      {  
        "path": "/*",  
        "indexes": [  
          {  
            "kind": "Range",  
            "dataType": "String",  
            "precision": -1  
          },  
          {  
            "kind": "Range",  
            "dataType": "Number",  
            "precision": -1  
          }  
        ]  
      }  
    ],  
    "excludedPaths": []  
  },  
  "partitionKey": {  
    "paths": [  
      "/AccountNumber"  
    ],  
    "kind": "Hash"  
  },  
  "_rid": "1tAvAP4XWww=",  
  "_ts": 1459198933,  
  "_self": "dbs/1tAvAA==/colls/1tAvAP4XWww=/",  
  "_etag": "\"00005600-0000-0000-0000-56f99bd50000\"",  
  "_docs": "docs/",  
  "_sprocs": "sprocs/",  
  "_triggers": "triggers/",  
  "_udfs": "udfs/",  
  "_conflicts": "conflicts/"  
}

示例

GET https://querydemo.documents.azure.com/dbs/testdb/colls HTTP/1.1  
x-ms-offer-throughput: 1000  
x-ms-date: Mon, 28 Mar 2016 21:02:12 GMT  
authorization: type%3dmaster%26ver%3d1.0%26sig%3dP8r7%2fEZnOxv2wQr2smp4G1tCH9PkOkIZscHqsqdn6y4%3d  
Cache-Control: no-cache  
User-Agent: Microsoft.Azure.Documents.Client/1.6.0.0  
x-ms-version: 2015-12-16  
Accept: application/json  
Host: querydemo.documents.azure.com  
Content-Length: 235  
Expect: 100-continue

HTTP/1.1 201 Created  
Cache-Control: no-store, no-cache  
Pragma: no-cache  
Transfer-Encoding: chunked  
Content-Type: application/json  
Server: Microsoft-HTTPAPI/2.0  
Strict-Transport-Security: max-age=31536000  
x-ms-last-state-change-utc: Mon, 28 Mar 2016 20:10:13.601 GMT  
etag: "00005600-0000-0000-0000-56f99bd50000"  
collection-partition-index: 0  
collection-service-index: 24  
x-ms-schemaversion: 1.1  
x-ms-alt-content-path: dbs/testdb  
x-ms-quorum-acked-lsn: 6  
x-ms-current-write-quorum: 3  
x-ms-current-replica-set-size: 4  
x-ms-request-charge: 4.95  
x-ms-serviceversion: version=1.6.52.5  
x-ms-activity-id: fbc3f36d-15d5-45fa-8f19-8579945451f8  
x-ms-session-token: 0:7  
Set-Cookie: x-ms-session-token#0=7; Domain=querydemo.documents.azure.com; Path=/dbs/1tAvAA==/colls/1tAvAP4XWww=  
Set-Cookie: x-ms-session-token=7; Domain=querydemo.documents.azure.com; Path=/dbs/1tAvAA==/colls/1tAvAP4XWww=  
x-ms-gatewayversion: version=1.6.52.5  
Date: Mon, 28 Mar 2016 21:02:13 GMT  
  
{  
  "id": "testcoll",  
  "indexingPolicy": {  
    "indexingMode": "consistent",  
    "automatic": true,  
    "includedPaths": [  
      {  
        "path": "/*",  
        "indexes": [  
          {  
            "kind": "Range",  
            "dataType": "String",  
            "precision": -1  
          },  
          {  
            "kind": "Range",  
            "dataType": "Number",  
            "precision": -1  
          }  
        ]  
      }  
    ],  
    "excludedPaths": []  
  },  
  "partitionKey": {  
    "paths": [  
      "/AccountNumber"  
    ],  
    "kind": "Hash"  
  },  
  "_rid": "1tAvAP4XWww=",  
  "_ts": 1459198933,  
  "_self": "dbs/1tAvAA==/colls/1tAvAP4XWww=/",  
  "_etag": "\"00005600-0000-0000-0000-56f99bd50000\"",  
  "_docs": "docs/",  
  "_sprocs": "sprocs/",  
  "_triggers": "triggers/",  
  "_udfs": "udfs/",  
  "_conflicts": "conflicts/"  
}

通过

获取集合

请求

标头

正文

响应

标头

状态代码

正文

示例

另请参阅

其他资源