Gremlin Resources - Get Gremlin Database Throughput
Ruft die RUs pro Sekunde der Gremlin-Datenbank unter einem vorhandenen Azure Cosmos DB-Datenbankkonto mit dem angegebenen Namen ab.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/throughputSettings/default?api-version=2023-11-15
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
account
|
path | True |
string |
Name des Cosmos DB-Datenbankkontos. Regex pattern: |
database
|
path | True |
string |
Cosmos DB-Datenbankname. |
resource
|
path | True |
string |
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet. |
subscription
|
path | True |
string |
Hierbei handelt es sich um die ID des Zielabonnements. |
api-version
|
query | True |
string |
Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Die RUs pro Sekunde der Gremlin-Datenbank wurden erfolgreich abgerufen. |
Sicherheit
azure_auth
Azure Active Directory-OAuth2-Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel Ihres Benutzerkontos |
Beispiele
CosmosDBGremlinDatabaseThroughputGet
Sample Request
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/gremlinDatabases/databaseName/throughputSettings/default?api-version=2023-11-15
Sample Response
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/gremlinDatabases/databaseName/throughputSettings/default",
"name": "default",
"type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings",
"location": "West US",
"tags": {},
"properties": {
"resource": {
"throughput": 400,
"minimumThroughput": "400",
"offerReplacePending": "true",
"instantMaximumThroughput": "10000",
"softAllowedMaximumThroughput": "1000000",
"_rid": "PD5DALigDgw=",
"_ts": 1459200611,
"_etag": "\"00005900-0000-0000-0000-56f9a2630000\""
}
}
}
Definitionen
Name | Beschreibung |
---|---|
Autoscale |
Cosmos DB-Objekt für bereitgestellte Durchsatzeinstellungen |
Auto |
Cosmos DB-Ressourcenrichtlinie für automatisches Upgrade |
Resource | |
Throughput |
Cosmos DB-Ressourcendurchsatzrichtlinie |
Throughput |
Ein Azure Cosmos DB-Ressourcendurchsatz. |
AutoscaleSettingsResource
Cosmos DB-Objekt für bereitgestellte Durchsatzeinstellungen
Name | Typ | Beschreibung |
---|---|---|
autoUpgradePolicy |
Cosmos DB-Ressourcenrichtlinie für automatisches Upgrade |
|
maxThroughput |
integer |
Stellt den maximalen Durchsatz eines Containers dar, auf den hochskaliert werden kann. |
targetMaxThroughput |
integer |
Stellt den Maximalen Durchsatz des Zielcontainers dar, der auf hochskaliert werden kann, sobald sich das Angebot nicht mehr im Status "Ausstehend" befindet. |
AutoUpgradePolicyResource
Cosmos DB-Ressourcenrichtlinie für automatisches Upgrade
Name | Typ | Beschreibung |
---|---|---|
throughputPolicy |
Stellt eine Durchsatzrichtlinie dar, die der Dienst für das automatische Upgrade einhalten muss. |
Resource
Name | Typ | Beschreibung |
---|---|---|
_etag |
string |
Eine vom System generierte Eigenschaft, die das Ressourcen-Etag darstellt, das für die Steuerung der optimistischen Parallelität erforderlich ist. |
_rid |
string |
Eine vom System generierte Eigenschaft. Einen eindeutigen Bezeichner. |
_ts |
number |
Eine vom System generierte Eigenschaft, die den zuletzt aktualisierten Zeitstempel der Ressource angibt. |
autoscaleSettings |
Cosmos DB-Ressource für Einstellungen für die automatische Skalierung. Entweder ist Durchsatz erforderlich, oder autoscaleSettings ist erforderlich, aber nicht beides. |
|
instantMaximumThroughput |
string |
Der Angebotsdurchsatzwert, der sofort hochskaliert werden kann, ohne Teilungen auszulösen |
minimumThroughput |
string |
Der minimale Durchsatz der Ressource |
offerReplacePending |
string |
Der Durchsatzersetzung steht aus. |
softAllowedMaximumThroughput |
string |
Der maximale Durchsatzwert oder der maximale MaxThroughput-Wert (für die automatische Skalierung), der angegeben werden kann |
throughput |
integer |
Wert des Cosmos DB-Ressourcendurchsatzes. Entweder ist Durchsatz erforderlich, oder autoscaleSettings ist erforderlich, aber nicht beides. |
ThroughputPolicyResource
Cosmos DB-Ressourcendurchsatzrichtlinie
Name | Typ | Beschreibung |
---|---|---|
incrementPercent |
integer |
Stellt den Prozentsatz dar, um den der Durchsatz bei jeder Durchsatzrichtlinie erhöht werden kann. |
isEnabled |
boolean |
Bestimmt, ob die ThroughputPolicy aktiv ist oder nicht |
ThroughputSettingsGetResults
Ein Azure Cosmos DB-Ressourcendurchsatz.
Name | Typ | Beschreibung |
---|---|---|
id |
string |
Der eindeutige Ressourcenbezeichner der ARM-Ressource. |
location |
string |
Der Speicherort der Ressourcengruppe, zu der die Ressource gehört. |
name |
string |
Der Name der ARM-Ressource. |
properties.resource | ||
tags |
object |
Tags sind eine Liste von Schlüssel-Wert-Paaren, die die Ressource beschreiben. Diese Tags können über Ressourcengruppen hinweg zum Anzeigen und Gruppieren von Ressourcen verwendet werden. Für eine Ressource können maximal 15 Tags bereitgestellt werden. Der Schlüssel eines Tags darf nicht länger als 128 Zeichen und der Wert nicht länger als 256 Zeichen sein. Die Standardumgebung für einen Vorlagentyp ist beispielsweise mit "defaultExperience": "Cassandra" festgelegt. Zu den aktuellen "defaultExperience"-Werten gehören auch "Table", "Graph", "DocumentDB" und "MongoDB". |
type |
string |
Der Typ der Azure-Ressource. |