Strumento: create_cluster
Crea un cluster in Memorystore for Redis Cluster.
Il seguente esempio mostra come utilizzare curl per richiamare lo strumento MCP create_cluster.
| Richiesta curl |
|---|
curl --location 'https://redis.googleapis.com/mcp' \ --header 'content-type: application/json' \ --header 'accept: application/json, text/event-stream' \ --data '{ "method": "tools/call", "params": { "name": "create_cluster", "arguments": { // provide these details according to the tool's MCP specification } }, "jsonrpc": "2.0", "id": 1 }' |
Schema di input
Richiesta per CreateCluster.
CreateClusterRequest
| Rappresentazione JSON |
|---|
{
"parent": string,
"clusterId": string,
"cluster": {
object ( |
| Campi | |
|---|---|
parent |
Obbligatorio. Il nome della risorsa della località del cluster utilizzando il modulo: |
clusterId |
Obbligatorio. Il nome logico del cluster Redis nel progetto del cliente con le seguenti limitazioni:
|
cluster |
Obbligatorio. Il cluster da creare. |
requestId |
Facoltativo. UUID richiesta idempotente. |
Cluster
| Rappresentazione JSON |
|---|
{ "name": string, "createTime": string, "state": enum ( |
| Campi | |
|---|---|
name |
Obbligatorio. Identificatore. Nome univoco della risorsa in questo ambito, inclusi progetto e località, nel formato: |
createTime |
Solo output. Il timestamp associato alla richiesta di creazione del cluster. Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: |
state |
Solo output. Lo stato attuale di questo cluster. Può essere CREAZIONE IN CORSO, PRONTO, AGGIORNAMENTO IN CORSO, ELIMINAZIONE IN CORSO e SOSPESO |
uid |
Solo output. Identificatore univoco assegnato dal sistema per il cluster. |
authorizationMode |
Facoltativo. La modalità di autorizzazione del cluster Redis. Se non viene fornita, la funzionalità di autenticazione è disabilitata per il cluster. |
transitEncryptionMode |
Facoltativo. La crittografia in transito per il cluster Redis. Se non viene fornita, la crittografia è disabilitata per il cluster. |
pscConfigs[] |
Facoltativo. Ogni PscConfig configura la rete consumer in cui gli IP verranno assegnati al cluster per l'accesso client tramite l'automazione di Private Service Connect. Al momento è supportato solo un PscConfig. |
discoveryEndpoints[] |
Solo output. Endpoint creati su ogni rete specificata, per consentire ai client Redis di connettersi al cluster. Al momento è supportato un solo endpoint di rilevamento. |
pscConnections[] |
Solo output. L'elenco delle connessioni PSC create automaticamente tramite l'automazione della connettività dei servizi. |
stateInfo |
Solo output. Informazioni aggiuntive sullo stato attuale del cluster. |
nodeType |
Facoltativo. Il tipo di nodo Redis nel cluster. NodeType determina il tipo di macchina sottostante di un nodo Redis. |
persistenceConfig |
Facoltativo. Configurazione della persistenza (RDB, AOF) per il cluster. |
redisConfigs |
Facoltativo. Coppie chiave/valore di override del cliente per le configurazioni Redis modificabili Un oggetto contenente un elenco di coppie |
zoneDistributionConfig |
Facoltativo. Questa configurazione verrà utilizzata per determinare in che modo il cliente vuole che distribuiamo le risorse del cluster all'interno della regione. |
crossClusterReplicationConfig |
Facoltativo. Configurazione della replica tra cluster. |
pscServiceAttachments[] |
Solo output. Dettagli del collegamento del servizio per configurare le connessioni PSC |
clusterEndpoints[] |
Facoltativo. Un elenco di endpoint del cluster. |
automatedBackupConfig |
Facoltativo. La configurazione del backup automatico per il cluster. |
encryptionInfo |
Solo output. Informazioni sulla crittografia dei dati at-rest del cluster. |
availableMaintenanceVersions[] |
Solo output. Questo campo viene utilizzato per determinare le versioni di manutenzione disponibili per l'aggiornamento self-service. |
allowFewerZonesDeployment |
Facoltativo. Immutabile. Deprecato, non utilizzare. |
labels |
Facoltativo. Etichette per rappresentare i metadati forniti dall'utente. Un oggetto contenente un elenco di coppie |
aclPolicy |
Facoltativo. La policy ACL da applicare al cluster. |
Campo unione import_sources. L'origine da cui importare. import_sources può essere solo uno dei seguenti tipi: |
|
gcsSource |
Facoltativo. Backup archiviati nei bucket Cloud Storage. I bucket Cloud Storage devono trovarsi nella stessa regione dei cluster. Per importare dagli oggetti Cloud Storage forniti è necessaria l'autorizzazione di lettura. |
managedBackupSource |
Facoltativo. Backup generati e gestiti dal servizio Memorystore. |
Campo unione
|
|
replicaCount |
Facoltativo. Il numero di nodi di replica per shard. |
Campo unione
|
|
sizeGb |
Solo output. Dimensioni della memoria Redis in GB per l'intero cluster arrotondate all'intero successivo. |
Campo unione
|
|
shardCount |
Facoltativo. Numero di shard per il cluster Redis. |
Campo unione
|
|
preciseSizeGb |
Solo output. Valore esatto delle dimensioni della memoria Redis in GB per l'intero cluster. |
Campo unione
|
|
deletionProtectionEnabled |
Facoltativo. L'operazione di eliminazione non riuscirà quando il valore è impostato su true. |
Campo unione
|
|
maintenancePolicy |
Facoltativo. ClusterMaintenancePolicy determina quando consentire o negare gli aggiornamenti. |
Campo unione
|
|
maintenanceSchedule |
Solo output. ClusterMaintenanceSchedule Solo output Programma di manutenzione pubblicato. |
Campo unione
|
|
satisfiesPzs |
Facoltativo. Solo output. Riservato per l'uso futuro. |
Campo unione
|
|
satisfiesPzi |
Facoltativo. Solo output. Riservato per l'uso futuro. |
Campo unione
|
|
simulateMaintenanceEvent |
Facoltativo. Solo input. Simula un evento di manutenzione. |
Campo unione
|
|
backupCollection |
Facoltativo. Solo output. Il nome completo della risorsa della raccolta di backup. Esempio: projects/{project}/locations/{location}/backupCollections/{collection} |
Campo unione
|
|
kmsKey |
Facoltativo. La chiave KMS utilizzata per criptare i dati at-rest del cluster. |
Campo unione
|
|
ondemandMaintenance |
Facoltativo. Solo input. Manutenzione on demand per il cluster. Questo campo può essere utilizzato per attivare l'aggiornamento critico on demand sul cluster. |
Campo unione
|
|
asyncClusterEndpointsDeletionEnabled |
Facoltativo. Se è vero, gli endpoint del cluster creati e registrati dai clienti possono essere eliminati in modo asincrono. ovvero, un endpoint del cluster può essere annullato prima dell'eliminazione delle regole di forwarding nell'endpoint del cluster. |
Campo unione
|
|
maintenanceVersion |
Facoltativo. Questo campo può essere utilizzato per attivare l'aggiornamento self-service per indicare la versione di manutenzione desiderata. L'input di questo campo può essere determinato dal campo available_maintenance_versions. |
Campo unione
|
|
effectiveMaintenanceVersion |
Solo output. Questo campo rappresenta la versione di manutenzione effettiva del cluster. |
Campo unione
|
|
serverCaMode |
Facoltativo. Modalità CA server per il cluster. |
Campo unione
|
|
serverCaPool |
Facoltativo. Pool di CA gestito dal cliente per il cluster. Applicabile solo per BYOCA, ovvero se server_ca_mode è SERVER_CA_MODE_CUSTOMER_MANAGED_CAS_CA. Formato: "projects/{project}/locations/{region}/caPools/{ca_pool}". |
Campo unione
|
|
rotateServerCertificate |
Facoltativo. Solo input. Ruota i certificati del server. |
Campo unione
|
|
aclPolicyInSync |
Facoltativo. Solo output. Indica se le regole ACL applicate al cluster sono sincronizzate con le regole dei criteri ACL più recenti. Questo campo è applicabile solo se il criterio ACL è impostato per il cluster. |
GcsBackupSource
| Rappresentazione JSON |
|---|
{ "uris": [ string ] } |
| Campi | |
|---|---|
uris[] |
Facoltativo. URI degli oggetti Cloud Storage da importare. Esempio: gs://bucket1/object1, gs://bucket2/folder2/object2 |
ManagedBackupSource
| Rappresentazione JSON |
|---|
{ "backup": string } |
| Campi | |
|---|---|
backup |
Facoltativo. Esempio: //redis.googleapis.com/projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backup} È supportata anche una versione più breve (senza prefisso) del nome del backup, ad esempio projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backup_id}. In questo caso, si presume che il backup si trovi in redis.googleapis.com. |
Timestamp
| Rappresentazione JSON |
|---|
{ "seconds": string, "nanos": integer } |
| Campi | |
|---|---|
seconds |
Rappresenta i secondi del tempo UTC a partire dall'epoca Unix 1970-01-01T00:00:00Z. Deve essere compreso tra -62135596800 e 253402300799 inclusi (corrispondenti a 0001-01-01T00:00:00Z e 9999-12-31T23:59:59Z). |
nanos |
Frazioni di secondo non negative con risoluzione in nanosecondi. Questo campo è la porzione di nanosecondi della durata, non un'alternativa ai secondi. I valori negativi dei secondi con frazioni devono comunque avere valori di nanosecondi non negativi che contano in avanti nel tempo. Deve essere compreso tra 0 e 999.999.999 inclusi. |
PscConfig
| Rappresentazione JSON |
|---|
{ "network": string } |
| Campi | |
|---|---|
network |
Obbligatorio. La rete in cui verrà riservato l'indirizzo IP dell'endpoint di rilevamento, nel formato projects/{network_project}/global/networks/{network_id}. |
DiscoveryEndpoint
| Rappresentazione JSON |
|---|
{
"address": string,
"port": integer,
"pscConfig": {
object ( |
| Campi | |
|---|---|
address |
Solo output. Indirizzo dell'endpoint Redis esposto utilizzato dai client per connettersi al servizio. L'indirizzo può essere un indirizzo IP o un nome host. |
port |
Solo output. Il numero di porta dell'endpoint Redis esposto. |
pscConfig |
Solo output. Configurazione del cliente per la posizione da cui viene creato e a cui si accede all'endpoint. |
PscConnection
| Rappresentazione JSON |
|---|
{ "pscConnectionId": string, "address": string, "forwardingRule": string, "projectId": string, "network": string, "serviceAttachment": string, "pscConnectionStatus": enum ( |
| Campi | |
|---|---|
pscConnectionId |
Obbligatorio. L'ID connessione PSC della regola di forwarding connessa al collegamento del servizio. |
address |
Obbligatorio. L'IP allocato sulla rete consumer per la regola di forwarding PSC. |
forwardingRule |
Obbligatorio. L'URI della regola di forwarding lato consumer. Esempio: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. |
projectId |
Facoltativo. ID progetto del progetto consumer in cui viene creata la regola di forwarding. |
network |
Obbligatorio. La rete consumer in cui risiede l'indirizzo IP, nel formato projects/{project_id}/global/networks/{network_id}. |
serviceAttachment |
Obbligatorio. Il collegamento del servizio che è la destinazione della connessione PSC, nel formato projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id}. |
pscConnectionStatus |
Solo output. Lo stato della connessione PSC. Tieni presente che questo valore viene aggiornato periodicamente. Per ottenere lo stato più recente di una connessione PSC, segui la procedura descritta in https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. |
connectionType |
Solo output. Tipo di connessione PSC. |
Campo unione ports. Il numero di porta dell'endpoint di individuazione esposto. ports può essere solo uno dei seguenti tipi: |
|
port |
Solo output. La porta verrà impostata solo per l'endpoint primario/lettore o di rilevamento. |
StateInfo
| Rappresentazione JSON |
|---|
{ // Union field |
| Campi | |
|---|---|
Campo unione
|
|
updateInfo |
Descrive l'aggiornamento in corso del cluster quando lo stato del cluster è UPDATING. |
UpdateInfo
| Rappresentazione JSON |
|---|
{ // Union field |
| Campi | |
|---|---|
Campo unione
|
|
targetShardCount |
Numero di shard di destinazione per il cluster Redis |
Campo unione
|
|
targetReplicaCount |
Numero target di nodi di replica per shard. |
Campo unione
|
|
targetNodeType |
Tipo di nodo di destinazione per il cluster Redis. |
ClusterPersistenceConfig
| Rappresentazione JSON |
|---|
{ "mode": enum ( |
| Campi | |
|---|---|
mode |
Facoltativo. La modalità di persistenza. |
rdbConfig |
Facoltativo. Configurazione RDB. Questo campo verrà ignorato se la modalità non è RDB. |
aofConfig |
Facoltativo. Configurazione AOF. Questo campo verrà ignorato se la modalità non è AOF. |
RDBConfig
| Rappresentazione JSON |
|---|
{
"rdbSnapshotPeriod": enum ( |
| Campi | |
|---|---|
rdbSnapshotPeriod |
Facoltativo. Periodo tra gli snapshot RDB. |
rdbSnapshotStartTime |
Facoltativo. L'ora in cui è stato/verrà tentato il primo snapshot e a cui verranno allineati gli snapshot futuri. Se non viene specificato, verrà utilizzato l'orario attuale. Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: |
AOFConfig
| Rappresentazione JSON |
|---|
{
"appendFsync": enum ( |
| Campi | |
|---|---|
appendFsync |
(Facoltativo) Configurazione fsync. |
RedisConfigsEntry
| Rappresentazione JSON |
|---|
{ "key": string, "value": string } |
| Campi | |
|---|---|
key |
|
value |
|
ZoneDistributionConfig
| Rappresentazione JSON |
|---|
{
"mode": enum ( |
| Campi | |
|---|---|
mode |
Facoltativo. La modalità di distribuzione delle zone. Se non specificato, il valore predefinito è MULTI_ZONE. |
zone |
Facoltativo. Quando viene selezionata la distribuzione SINGLE ZONE, il campo della zona viene utilizzato per allocare tutte le risorse in quella zona. Questo non è applicabile a MULTI_ZONE e verrà ignorato per i cluster MULTI_ZONE. |
CrossClusterReplicationConfig
| Rappresentazione JSON |
|---|
{ "clusterRole": enum ( |
| Campi | |
|---|---|
clusterRole |
Solo output. Il ruolo del cluster nella replica cross-cluster. |
primaryCluster |
Dettagli del cluster primario utilizzato come origine di replica per questo cluster secondario. Questo campo è impostato solo per un cluster secondario. |
secondaryClusters[] |
Elenco dei cluster secondari che eseguono la replica da questo cluster primario. Questo campo è impostato solo per un cluster primario. |
updateTime |
Solo output. L'ultima volta che è stata aggiornata la configurazione della replica cross-cluster. Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: |
membership |
Solo output. Una visualizzazione di sola uscita di tutti i cluster membri che partecipano alla replica cross-cluster. Questa visualizzazione verrà fornita da ogni cluster membro indipendentemente dal suo ruolo(primario o secondario). Un cluster primario può fornire informazioni su tutti i cluster secondari che lo replicano. Tuttavia, un cluster secondario conosce solo il cluster primario da cui esegue la replica. Tuttavia, per gli scenari in cui il cluster primario non è disponibile(ad es. interruzione regionale), è possibile inviare una richiesta GetCluster a qualsiasi altro cluster membro e questo campo elencherà tutti i cluster membri che partecipano alla replica tra cluster. |
RemoteCluster
| Rappresentazione JSON |
|---|
{ "cluster": string, "uid": string } |
| Campi | |
|---|---|
cluster |
Solo output. Il percorso completo della risorsa del cluster remoto nel formato: projects/ |
uid |
Solo output. L'identificatore univoco del cluster remoto. |
Appartenenza
| Rappresentazione JSON |
|---|
{ "primaryCluster": { object ( |
| Campi | |
|---|---|
primaryCluster |
Solo output. Il cluster primario che funge da origine della replica per i cluster secondari. |
secondaryClusters[] |
Solo output. L'elenco dei cluster secondari che eseguono la replica dal cluster primario. |
ClusterMaintenancePolicy
| Rappresentazione JSON |
|---|
{
"createTime": string,
"updateTime": string,
"weeklyMaintenanceWindow": [
{
object ( |
| Campi | |
|---|---|
createTime |
Solo output. L'ora in cui è stata creata la policy, ovvero è stato assegnato il periodo di manutenzione o il periodo in cui evitare la manutenzione. Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: |
updateTime |
Solo output. L'ora in cui è stata aggiornata la policy, ad esempio il periodo di manutenzione o il periodo di divieto. Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: |
weeklyMaintenanceWindow[] |
Facoltativo. Periodo di manutenzione applicato alle risorse coperte da questa policy. Minimo 1. Per la versione attuale, il numero massimo di weekly_maintenance_window previsto è uno. |
ClusterWeeklyMaintenanceWindow
| Rappresentazione JSON |
|---|
{ "day": enum ( |
| Campi | |
|---|---|
day |
Facoltativo. Consente di definire una pianificazione da eseguire in un giorno specifico della settimana. |
startTime |
Facoltativo. Ora di inizio della finestra in UTC. |
TimeOfDay
| Rappresentazione JSON |
|---|
{ "hours": integer, "minutes": integer, "seconds": integer, "nanos": integer } |
| Campi | |
|---|---|
hours |
Ore di un giorno nel formato 24 ore. Deve essere maggiore o uguale a 0 e in genere deve essere minore o uguale a 23. Un'API può scegliere di consentire il valore "24:00:00" per scenari come l'orario di chiusura dell'attività. |
minutes |
Minuti di un'ora. Deve essere maggiore o uguale a 0 e minore o uguale a 59. |
seconds |
Secondi di un minuto. Deve essere maggiore o uguale a 0 e in genere minore o uguale a 59. Un'API potrebbe consentire il valore 60 se consente i secondi intercalari. |
nanos |
Frazioni di secondi, in nanosecondi. Deve essere maggiore o uguale a 0 e minore o uguale a 999.999.999. |
ClusterMaintenanceSchedule
| Rappresentazione JSON |
|---|
{ "startTime": string, "endTime": string } |
| Campi | |
|---|---|
startTime |
Solo output. L'ora di inizio di qualsiasi manutenzione pianificata imminente per questa istanza. Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: |
endTime |
Solo output. L'ora di fine di qualsiasi manutenzione pianificata imminente per questa istanza. Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: |
PscServiceAttachment
| Rappresentazione JSON |
|---|
{
"serviceAttachment": string,
"connectionType": enum ( |
| Campi | |
|---|---|
serviceAttachment |
Solo output. URI del collegamento al servizio che la PscConnection creata autonomamente deve utilizzare come destinazione |
connectionType |
Solo output. Tipo di connessione PSC che ha come target questo collegamento del servizio. |
ClusterEndpoint
| Rappresentazione JSON |
|---|
{
"connections": [
{
object ( |
| Campi | |
|---|---|
connections[] |
Obbligatorio. Un gruppo di connessioni PSC. Vengono creati nella stessa rete VPC, uno per ogni collegamento del servizio nel cluster. |
ConnectionDetail
| Rappresentazione JSON |
|---|
{ // Union field |
| Campi | |
|---|---|
Campo unione connection. Una connessione PSC a un cluster può essere creata tramite l'automazione della connettività di servizio (connessione registrata automaticamente) durante la creazione del cluster oppure può essere creata direttamente dal cliente (connessione registrata dall'utente). connection può essere solo uno dei seguenti tipi: |
|
pscAutoConnection |
Informazioni dettagliate su una connessione PSC creata tramite l'automazione della connettività di servizio. |
pscConnection |
Informazioni dettagliate su una connessione PSC creata dal cliente proprietario del cluster. |
PscAutoConnection
| Rappresentazione JSON |
|---|
{ "pscConnectionId": string, "address": string, "forwardingRule": string, "projectId": string, "network": string, "serviceAttachment": string, "pscConnectionStatus": enum ( |
| Campi | |
|---|---|
pscConnectionId |
Solo output. L'ID connessione PSC della regola di forwarding connessa al collegamento del servizio. |
address |
Solo output. L'IP allocato sulla rete consumer per la regola di forwarding PSC. |
forwardingRule |
Solo output. L'URI della regola di forwarding lato consumer. Esempio: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. |
projectId |
Obbligatorio. L'ID progetto consumer da cui viene creata la regola di forwarding. |
network |
Obbligatorio. La rete consumer in cui risiede l'indirizzo IP, nel formato projects/{project_id}/global/networks/{network_id}. |
serviceAttachment |
Solo output. Il collegamento del servizio che è la destinazione della connessione PSC, nel formato projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id}. |
pscConnectionStatus |
Solo output. Lo stato della connessione PSC. Tieni presente che questo valore viene aggiornato periodicamente. Utilizza le API Private Service Connect per lo stato più recente. |
connectionType |
Solo output. Tipo di connessione PSC. |
AutomatedBackupConfig
| Rappresentazione JSON |
|---|
{ "automatedBackupMode": enum ( |
| Campi | |
|---|---|
automatedBackupMode |
Facoltativo. La modalità di backup automatico. Se la modalità è disattivata, gli altri campi verranno ignorati. |
Campo unione schedule. La pianificazione dei backup automatici. schedule può essere solo uno dei seguenti tipi: |
|
fixedFrequencySchedule |
Facoltativo. Attiva i backup automatici a una frequenza fissa. |
Campo unione
|
|
retention |
Facoltativo. Per quanto tempo conservare i backup automatici prima che vengano eliminati. Il valore deve essere compreso tra 1 e 365 giorni. Se non è specificato, il valore predefinito è 35 giorni. Una durata in secondi con un massimo di nove cifre frazionarie, che termina con " |
FixedFrequencySchedule
| Rappresentazione JSON |
|---|
{ // Union field |
| Campi | |
|---|---|
Campo unione
|
|
startTime |
Obbligatorio. L'ora di inizio di ogni backup automatico nel fuso orario UTC. Deve essere impostata all'inizio di un'ora. Questo campo è obbligatorio. |
Durata
| Rappresentazione JSON |
|---|
{ "seconds": string, "nanos": integer } |
| Campi | |
|---|---|
seconds |
Secondi firmati dell'intervallo di tempo. Deve essere compreso tra -315.576.000.000 e +315.576.000.000 inclusi. Nota: questi limiti vengono calcolati in base a: 60 sec/min * 60 min/ora * 24 ore/giorno * 365,25 giorni/anno * 10.000 anni |
nanos |
Frazioni di secondo con segno con risoluzione in nanosecondi dell'intervallo di tempo. Le durate inferiori a un secondo sono rappresentate con un campo |
EncryptionInfo
| Rappresentazione JSON |
|---|
{ "encryptionType": enum ( |
| Campi | |
|---|---|
encryptionType |
Solo output. Tipo di crittografia. |
kmsKeyVersions[] |
Solo output. Versioni delle chiavi KMS utilizzate per proteggere i dati inattivi. |
kmsKeyPrimaryState |
Solo output. Lo stato della versione primaria della chiave KMS percepito dal sistema. Questo campo non viene compilato nei backup. |
lastUpdateTime |
Solo output. L'ora più recente in cui sono state aggiornate le informazioni di crittografia. Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: |
LabelsEntry
| Rappresentazione JSON |
|---|
{ "key": string, "value": string } |
| Campi | |
|---|---|
key |
|
value |
|
Schema di output
Questa risorsa rappresenta un'operazione a lunga esecuzione che è il risultato di una chiamata API di rete.
Operazione
| Rappresentazione JSON |
|---|
{ "name": string, "metadata": { "@type": string, field1: ..., ... }, "done": boolean, // Union field |
| Campi | |
|---|---|
name |
Il nome assegnato dal server, che è univoco solo all'interno dello stesso servizio che lo restituisce originariamente. Se utilizzi la mappatura HTTP predefinita, |
metadata |
{
} Un oggetto contenente campi di tipo arbitrario. Un campo aggiuntivo |
done |
Se il valore è |
Campo unione result. Il risultato dell'operazione, che può essere un error o una response valida. Se done == false, né error né response vengono impostati. Se done == true, è possibile impostare esattamente uno tra error e response. Alcuni servizi potrebbero non fornire il risultato. result può essere solo uno dei seguenti tipi: |
|
error |
Il risultato di errore dell'operazione in caso di errore o annullamento. |
response |
La risposta normale e con esito positivo dell'operazione. Se il metodo originale non restituisce dati in caso di esito positivo, ad esempio Un oggetto contenente campi di tipo arbitrario. Un campo aggiuntivo |
Qualsiasi
| Rappresentazione JSON |
|---|
{ "typeUrl": string, "value": string } |
| Campi | |
|---|---|
typeUrl |
Identifica il tipo di messaggio Protobuf serializzato con un riferimento URI costituito da un prefisso che termina con una barra e il nome del tipo completo. Esempio: type.googleapis.com/google.protobuf.StringValue Questa stringa deve contenere almeno un carattere Il prefisso è arbitrario e le implementazioni di Protobuf devono semplicemente rimuovere tutto fino all'ultimo Tutte le stringhe URL di tipo devono essere riferimenti URI validi con l'ulteriore limitazione (per il formato di testo) che il contenuto del riferimento deve essere costituito solo da caratteri alfanumerici, sequenze di escape codificate in percentuale e caratteri del seguente insieme (esclusi i backtick esterni): Nella progettazione originale di |
value |
Contiene una serializzazione Protobuf del tipo descritto da type_url. Una stringa con codifica in base64. |
Stato
| Rappresentazione JSON |
|---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
| Campi | |
|---|---|
code |
Il codice di stato, che deve essere un valore enum di |
message |
Un messaggio di errore rivolto agli sviluppatori, che deve essere in inglese. Qualsiasi messaggio di errore rivolto agli utenti deve essere localizzato e inviato nel campo |
details[] |
Un elenco di messaggi contenenti i dettagli dell'errore. Esiste un insieme comune di tipi di messaggi da utilizzare per le API. Un oggetto contenente campi di tipo arbitrario. Un campo aggiuntivo |
Annotazioni dello strumento
Suggerimento distruttivo: ❌ | Suggerimento idempotente: ❌ | Suggerimento di sola lettura: ❌ | Suggerimento open world: ❌