Partition Key Range Id Region - List Metrics
Recupera as métricas determinadas pelo filtro fornecido para a ID e a região do intervalo de chaves de partição fornecidas.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/region/{region}/databases/{databaseRid}/collections/{collectionRid}/partitionKeyRangeId/{partitionKeyRangeId}/metrics?api-version=2023-11-15&$filter={$filter}
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
account
|
path | True |
string |
Nome da conta de banco de dados do Cosmos DB. Regex pattern: |
collection
|
path | True |
string |
Rid da coleção do Cosmos DB. |
database
|
path | True |
string |
Banco de dados do Cosmos DB rid. |
partition
|
path | True |
string |
ID do Intervalo de Chaves de Partição para a qual obter dados. |
region
|
path | True |
string |
Região do Cosmos DB, com espaços entre palavras e cada palavra em maiúscula. |
resource
|
path | True |
string |
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas. |
subscription
|
path | True |
string |
A ID da assinatura de destino. |
$filter
|
query | True |
string |
Uma expressão de filtro OData que descreve um subconjunto de métricas a serem retornadas. Os parâmetros que podem ser filtrados são name.value (nome da métrica, pode ter um ou de vários nomes), startTime, endTime e timeGrain. O operador com suporte é eq. |
api-version
|
query | True |
string |
A versão da API a ser usada para esta operação. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
As métricas no nível da partição para a ID e a região do intervalo de chaves de partição foram recuperadas com êxito. |
Segurança
azure_auth
Fluxo do OAuth2 do Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nome | Description |
---|---|
user_impersonation | Representar sua conta de usuário |
Exemplos
CosmosDBDatabaseAccountRegionGetMetrics
Sample Request
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/region/West US/databases/databaseRid/collections/collectionRid/partitionKeyRangeId/0/metrics?api-version=2023-11-15&$filter=$filter=(name.value eq 'Max RUs Per Second') and timeGrain eq duration'PT1M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T23:58:55.2780000Z
Sample Response
{
"value": [
{
"timeGrain": "PT1M",
"startTime": "2017-11-19T23:53:55.2780000Z",
"endTime": "2017-11-20T23:58:55.2780000Z",
"unit": "Count",
"partitionId": "00000000-0000-0000-0000-000000000000",
"partitionKeyRangeId": "0",
"metricValues": [
{
"timestamp": "2017-11-19T23:53:55.2780000Z",
"maximum": 5
},
{
"timestamp": "2017-11-19T23:54:55.2780000Z",
"maximum": 5
},
{
"timestamp": "2017-11-19T23:55:55.2780000Z",
"maximum": 5
},
{
"timestamp": "2017-11-19T23:56:55.2780000Z",
"maximum": 5
},
{
"timestamp": "2017-11-19T23:57:55.2780000Z",
"maximum": 5
},
{
"timestamp": "2017-11-19T23:58:55.2780000Z",
"maximum": 5
}
],
"name": {
"value": "Max RUs Per Second",
"localizedValue": "Max RUs Per Second"
}
}
]
}
Definições
Nome | Description |
---|---|
Metric |
Um nome de métrica. |
Metric |
Representa valores de métricas. |
Partition |
Os valores de métrica para uma única partição. |
Partition |
A resposta a uma solicitação de métricas de partição de lista. |
Unit |
A unidade da métrica. |
MetricName
Um nome de métrica.
Nome | Tipo | Description |
---|---|---|
localizedValue |
string |
O nome amigável da métrica. |
value |
string |
O nome da métrica. |
MetricValue
Representa valores de métricas.
Nome | Tipo | Description |
---|---|---|
_count |
number |
O número de valores para a métrica. |
average |
number |
O valor médio da métrica. |
maximum |
number |
O valor máximo da métrica. |
minimum |
number |
O valor mínimo da métrica. |
timestamp |
string |
O carimbo de data/hora da métrica (formato ISO-8601). |
total |
number |
O valor total da métrica. |
PartitionMetric
Os valores de métrica para uma única partição.
Nome | Tipo | Description |
---|---|---|
endTime |
string |
A hora de término da métrica (formato ISO-8601). |
metricValues |
Os valores de métrica para a janela de tempo e o carimbo de data/hora especificados. |
|
name |
As informações de nome da métrica. |
|
partitionId |
string |
A ID da partição (identificador GUID) dos valores de métrica. |
partitionKeyRangeId |
string |
A ID do intervalo de chaves de partição (identificador inteiro) dos valores de métrica. |
startTime |
string |
A hora de início da métrica (formato ISO-8601). |
timeGrain |
string |
A granularidade de tempo a ser usada para resumir os valores de métrica. |
unit |
A unidade da métrica. |
PartitionMetricListResult
A resposta a uma solicitação de métricas de partição de lista.
Nome | Tipo | Description |
---|---|---|
value |
A lista de métricas no nível da partição para a conta. |
UnitType
A unidade da métrica.
Nome | Tipo | Description |
---|---|---|
Bytes |
string |
|
BytesPerSecond |
string |
|
Count |
string |
|
CountPerSecond |
string |
|
Milliseconds |
string |
|
Percent |
string |
|
Seconds |
string |