Listar Coleções

  • Artigo

Executar um GET no recurso de coleções de uma base de dados específica, ou seja, o caminho do URI de agrupamento devolve uma lista das coleções na base de dados.

Nota

Estes artigos de referência da API mostram como criar recursos com a API do plano de dados do Azure Cosmos DB. Com a API do plano de dados, pode configurar opções básicas, como a política de indexação, chaves de partição da mesma forma que pode com os SDKs do Cosmos DB. Se precisar de suporte completo de funcionalidades para todos os recursos do Azure Cosmos DB, recomendamos que utilize o Fornecedor de Recursos do Cosmos DB.

Pedir

Método URI do pedido Descrição
GET https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls A {databaseaccount} é o nome da conta do Azure Cosmos DB criada na sua subscrição. O valor {db-id} é o nome/id gerado pelo utilizador da base de dados e não o ID gerado pelo sistema (rid).

Cabeçalhos

Veja Common Azure Cosmos DB REST request headers for headers that are used by all Cosmos DB requests (Cabeçalhos de pedido REST do Azure Cosmos DB comuns para cabeçalhos que são utilizados por todos os pedidos do Cosmos DB).

Corpo

Nenhum.

Resposta

As Coleções de Lista devolvem uma matriz de coleções na base de dados especificada.

Cabeçalhos

Veja Common Azure Cosmos DB REST response headers for headers that are returned by all Cosmos DB responses (Cabeçalhos de resposta REST do Azure Cosmos DB comuns para cabeçalhos devolvidos por todas as respostas do Cosmos DB).

Códigos de estado

A tabela seguinte lista os códigos de estado comuns devolvidos por esta operação. Para obter uma lista completa dos códigos de estado, consulte Códigos de Estado HTTP.

Código de estado de HTTP Descrição
200 OK A operação foi bem-sucedida.

Corpo

Propriedade Descrição
_rid Esta propriedade é o ID de recurso da base de dados onde residem as coleções.
_count Esta propriedade mostra o número de ligações devolvidas como parte da operação de lista.
DocumentCollections Esta propriedade é a matriz que contém as coleções devolvidas como parte da operação de lista. Para obter detalhes sobre as propriedades contidas numa coleção, consulte Coleções. 
{  
  "_rid": "PaYSAA==",  
  "DocumentCollections": [  
    {  
      "id": "SampleCollection",  
      "indexingPolicy": {  
        "indexingMode": "consistent",  
        "automatic": true,  
        "includedPaths": [  
          {  
            "path": "/*",  
            "indexes": [  
              {  
                "kind": "Range",  
                "dataType": "Number",  
                "precision": -1  
              },  
              {  
                "kind": "Hash",  
                "dataType": "String",  
                "precision": 3  
              }  
            ]  
          }  
        ],  
        "excludedPaths": []  
      },  
      "_rid": "PaYSAPH7qAo=",  
      "_ts": 1459194239,  
      "_self": "dbs/PaYSAA==/colls/PaYSAPH7qAo=/",  
      "_etag": "\"00001300-0000-0000-0000-56f9897f0000\"",  
      "_docs": "docs/",  
      "_sprocs": "sprocs/",  
      "_triggers": "triggers/",  
      "_udfs": "udfs/",  
      "_conflicts": "conflicts/"  
    },  
    {  
      "id": "SampleCollectionWithCustomIndexPolicy",  
      "indexingPolicy": {  
        "indexingMode": "lazy",  
        "automatic": true,  
        "includedPaths": [  
          {  
            "path": "/*",  
            "indexes": [  
              {  
                "kind": "Range",  
                "dataType": "Number",  
                "precision": -1  
              },  
              {  
                "kind": "Hash",  
                "dataType": "String",  
                "precision": 3  
              }  
            ]  
          }  
        ],  
        "excludedPaths": []  
      },  
      "_rid": "PaYSAIxUPws=",  
      "_ts": 1459194241,  
      "_self": "dbs/PaYSAA==/colls/PaYSAIxUPws=/",  
      "_etag": "\"00001500-0000-0000-0000-56f989810000\"",  
      "_docs": "docs/",  
      "_sprocs": "sprocs/",  
      "_triggers": "triggers/",  
      "_udfs": "udfs/",  
      "_conflicts": "conflicts/"  
    }  
  ],  
  "_count": 2  
}

Exemplo

GET https://querydemo.documents.azure.com/dbs/SampleDatabase/colls HTTP/1.1  
x-ms.date: 04/20/2021
authorization: type%3dmaster%26ver%3d1.0%26sig%3dQdp6TjZxdeJAKSiUfG%2fd7dS46USXy1IF%2bt5ToLdvOaA%3d  
Cache-Control: no-cache  
User-Agent: Microsoft.Azure.Documents.Client/1.6.0.0Internal Azure DocumentDB Studio/0.61  
x-ms-version: 2015-12-16  
Accept: application/json  
Host: querydemo.documents.azure.com  
  

HTTP/1.1 200 Ok  
Cache-Control: no-store, no-cache  
Pragma: no-cache  
Transfer-Encoding: chunked  
Content-Type: application/json  
Content-Location: https://querydemo.documents.azure.com/dbs/SampleDatabase/colls  
Server: Microsoft-HTTPAPI/2.0  
Strict-Transport-Security: max-age=31536000  
x-ms-last-state-change-utc: Fri, 25 Mar 2016 22:55:02.762 GMT  
x-ms-resource-quota: collections=5000;  
x-ms-resource-usage: collections=27;  
x-ms-item-count: 2  
x-ms-schemaversion: 1.1  
x-ms-alt-content-path: dbs/SampleDatabase  
x-ms-content-path: PaYSAA==  
x-ms-request-charge: 2  
x-ms-serviceversion: version=1.6.52.5  
x-ms-activity-id: 9c102725-4c2b-48ba-8f51-7ac1dc6dbce7  
x-ms-session-token: M:7860  
x-ms-gatewayversion: version=1.6.52.5  
Date: Mon, 28 Mar 2016 21:25:59 GMT  
  
{  
  "_rid": "PaYSAA==",  
  "DocumentCollections": [  
    {  
      "id": "SampleCollection",  
      "indexingPolicy": {  
        "indexingMode": "consistent",  
        "automatic": true,  
        "includedPaths": [  
          {  
            "path": "/*",  
            "indexes": [  
              {  
                "kind": "Range",  
                "dataType": "Number",  
                "precision": -1  
              },  
              {  
                "kind": "Hash",  
                "dataType": "String",  
                "precision": 3  
              }  
            ]  
          }  
        ],  
        "excludedPaths": []  
      },  
      "_rid": "PaYSAPH7qAo=",  
      "_ts": 1459194239,  
      "_self": "dbs/PaYSAA==/colls/PaYSAPH7qAo=/",  
      "_etag": "\"00001300-0000-0000-0000-56f9897f0000\"",  
      "_docs": "docs/",  
      "_sprocs": "sprocs/",  
      "_triggers": "triggers/",  
      "_udfs": "udfs/",  
      "_conflicts": "conflicts/"  
    },  
    {  
      "id": "SampleCollectionWithCustomIndexPolicy",  
      "indexingPolicy": {  
        "indexingMode": "lazy",  
        "automatic": true,  
        "includedPaths": [  
          {  
            "path": "/*",  
            "indexes": [  
              {  
                "kind": "Range",  
                "dataType": "Number",  
                "precision": -1  
              },  
              {  
                "kind": "Hash",  
                "dataType": "String",  
                "precision": 3  
              }  
            ]  
          }  
        ],  
        "excludedPaths": []  
      },  
      "_rid": "PaYSAIxUPws=",  
      "_ts": 1459194241,  
      "_self": "dbs/PaYSAA==/colls/PaYSAIxUPws=/",  
      "_etag": "\"00001500-0000-0000-0000-56f989810000\"",  
      "_docs": "docs/",  
      "_sprocs": "sprocs/",  
      "_triggers": "triggers/",  
      "_udfs": "udfs/",  
      "_conflicts": "conflicts/"  
    }  
  ],  
  "_count": 2  
}

Consulte também