Cassandra Clusters - List Command

Service:

Cosmos DB Resource Provider

API-versie:

2025-05-01-preview

Alle opdrachten weergeven die momenteel worden uitgevoerd op ringgegevens

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/commands?api-version=2025-05-01-preview

URI-parameters

Name	In	Vereist	Type	Description
clusterName	path	True	string minLength: 1 maxLength: 100 pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$	Naam van beheerde Cassandra-cluster.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is hoofdletterongevoelig.
subscriptionId	path	True	string (uuid)	De id van het doelabonnement. De waarde moet een UUID zijn.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name	Type	Description
200 OK	ListCommands	De lijst met shell-opdrachten is opgehaald.
Other Status Codes	CloudError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount nabootsen

Voorbeelden

CosmosDBManagedCassandraListCommand

Voorbeeldaanvraag

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cassandra-prod-rg/providers/Microsoft.DocumentDB/cassandraClusters/cassandra-prod/commands?api-version=2025-05-01-preview

Voorbeeldrespons

Statuscode:

200

{
  "value": [
    {
      "command": "nodetool",
      "commandId": "1234",
      "status": "Enqueued",
      "arguments": {
        "status": ""
      },
      "host": "10.0.1.12",
      "readWrite": true,
      "cassandraStopStart": false
    }
  ]
}

Definities

Name	Description
CloudError	Een foutreactie van de service.
CommandPublicResource	resource die een opdracht vertegenwoordigt
CommandStatus	Status van de opdracht.
ErrorResponse	Foutreactie.
ListCommands	Lijst met opdrachten voor cluster.

CloudError

Object

Een foutreactie van de service.

Name	Type	Description
error	ErrorResponse	Foutreactie.

CommandPublicResource

Object

resource die een opdracht vertegenwoordigt

Name	Type	Description
arguments	object	De argumenten voor de opdracht die moet worden uitgevoerd
cassandraStopStart	boolean	Als waar, stopt u cassandra voordat u de opdracht uitvoert en start u deze opnieuw
command	string	De opdracht die moet worden uitgevoerd
commandId	string	De unieke id van de opdracht
host	string	IP-adres van de cassandra-host om de opdracht uit te voeren op
isAdmin	boolean	Of de opdracht beheerdersbevoegdheden heeft
outputFile	string	De naam van het bestand waarin het resultaat is geschreven.
readWrite	boolean	Indien waar, kan de opdracht schrijven naar de cassandra-map, anders alleen-lezen.
result	string	Resultaatuitvoer van de opdracht.
status	CommandStatus	Status van de opdracht.

CommandStatus

Inventarisatie

Status van de opdracht.

Waarde	Description
Done
Enqueue
Failed
Finished
Processing
Running

ErrorResponse

Object

Foutreactie.

Name	Type	Description
code	string	Foutcode.
message	string	Foutbericht dat aangeeft waarom de bewerking is mislukt.

ListCommands

Object

Lijst met opdrachten voor cluster.

Name	Type	Description
value	CommandPublicResource[]	Container voor matrix met opdrachten.