Herramienta: create_cluster
Crea un clúster en Memorystore for Redis Cluster.
En el siguiente ejemplo, se muestra cómo usar curl para invocar la herramienta de MCP create_cluster.
| Solicitud de 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 }' |
Esquema de entrada
Solicitud para CreateCluster.
CreateClusterRequest
| Representación JSON |
|---|
{
"parent": string,
"clusterId": string,
"cluster": {
object ( |
| Campos | |
|---|---|
parent |
Obligatorio. Es el nombre del recurso de la ubicación del clúster con el formato |
clusterId |
Obligatorio. Es el nombre lógico del clúster de Redis en el proyecto del cliente con las siguientes restricciones:
|
cluster |
Obligatorio. Es el clúster que se creará. |
requestId |
Es opcional. Es el UUID de la solicitud idempotente. |
Clúster
| Representación JSON |
|---|
{ "name": string, "createTime": string, "state": enum ( |
| Campos | |
|---|---|
name |
Obligatorio. Es el identificador. Nombre único del recurso en este permiso, incluido el proyecto y la ubicación mediante el formulario: |
createTime |
Solo salida. Es la marca de tiempo asociada a la solicitud de creación del clúster. Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: |
state |
Solo salida. Es el estado actual de este clúster. Puede ser CREATING, READY, UPDATING, DELETING y SUSPENDED. |
uid |
Solo salida. Es el identificador único asignado por el sistema para el clúster. |
authorizationMode |
Es opcional. Es el modo de autorización del clúster de Redis. Si no se proporciona, la función de autenticación se inhabilita para el clúster. |
transitEncryptionMode |
Es opcional. Es la encriptación en tránsito para el clúster de Redis. Si no se proporciona, se inhabilita el encriptado para el clúster. |
pscConfigs[] |
Es opcional. Cada PscConfig configura la red del consumidor en la que se designarán IPs al clúster para el acceso del cliente a través de la automatización de Private Service Connect. Actualmente, solo se admite un PscConfig. |
discoveryEndpoints[] |
Solo salida. Son los extremos creados en cada red determinada para que los clientes de Redis se conecten al clúster. Actualmente, solo se admite un extremo de detección. |
pscConnections[] |
Solo salida. Es la lista de conexiones de PSC que se crean automáticamente a través de la automatización de la conectividad del servicio. |
stateInfo |
Solo salida. Es información adicional sobre el estado actual del clúster. |
nodeType |
Es opcional. Es el tipo de un nodo de Redis en el clúster. NodeType determina el tipo de máquina subyacente de un nodo de Redis. |
persistenceConfig |
Es opcional. Es la configuración de persistencia (RDB, AOF) para el clúster. |
redisConfigs |
Es opcional. Pares clave/valor de las anulaciones del cliente para los parámetros de configuración de Redis mutables Un objeto que contiene una lista de pares |
zoneDistributionConfig |
Es opcional. Esta configuración se usará para determinar cómo quiere el cliente que distribuyamos los recursos del clúster dentro de la región. |
crossClusterReplicationConfig |
Es opcional. Es la configuración de la replicación entre clústeres. |
pscServiceAttachments[] |
Solo salida. Detalles del adjunto de servicio para configurar conexiones de PSC |
clusterEndpoints[] |
Es opcional. Es una lista de extremos del clúster. |
automatedBackupConfig |
Es opcional. Es la configuración de copia de seguridad automática del clúster. |
encryptionInfo |
Solo salida. Es la información de encriptación de los datos en reposo del clúster. |
availableMaintenanceVersions[] |
Solo salida. Este campo se usa para determinar las versiones de mantenimiento disponibles para la actualización de autoservicio. |
allowFewerZonesDeployment |
Es opcional. Inmutable. Está obsoleto, no se debe usar. |
labels |
Es opcional. Son etiquetas que representan los metadatos proporcionados por el usuario. Un objeto que contiene una lista de pares |
aclPolicy |
Es opcional. Es la política de ACL que se aplicará al clúster. |
Campo de unión import_sources. Es la fuente desde la que se importará. import_sources puede ser solo uno de los parámetros siguientes: |
|
gcsSource |
Es opcional. Copias de seguridad almacenadas en buckets de Cloud Storage Los buckets de Cloud Storage deben estar en la misma región que los clústeres. Se requiere permiso de lectura para importar desde los objetos de Cloud Storage proporcionados. |
managedBackupSource |
Es opcional. Son las copias de seguridad que genera y administra el servicio de Memorystore. |
Campo de unión
|
|
replicaCount |
Es opcional. Es la cantidad de nodos de réplica por fragmento. |
Campo de unión
|
|
sizeGb |
Solo salida. Tamaño de la memoria de Redis en GB para todo el clúster, redondeado al siguiente número entero. |
Campo de unión
|
|
shardCount |
Es opcional. Es la cantidad de fragmentos del clúster de Redis. |
Campo de unión
|
|
preciseSizeGb |
Solo salida. Es el valor preciso del tamaño de la memoria de Redis en GB para todo el clúster. |
Campo de unión
|
|
deletionProtectionEnabled |
Es opcional. La operación de eliminación fallará cuando el valor se establezca como verdadero. |
Campo de unión
|
|
maintenancePolicy |
Es opcional. ClusterMaintenancePolicy determina cuándo permitir o rechazar actualizaciones. |
Campo de unión
|
|
maintenanceSchedule |
Solo salida. ClusterMaintenanceSchedule (solo salida) Programa de mantenimiento publicado. |
Campo de unión
|
|
satisfiesPzs |
Es opcional. Solo salida. Se reserva para usarlo más adelante. |
Campo de unión
|
|
satisfiesPzi |
Es opcional. Solo salida. Se reserva para usarlo más adelante. |
Campo de unión
|
|
simulateMaintenanceEvent |
Es opcional. Solo entrada. Simula un evento de mantenimiento. |
Campo de unión
|
|
backupCollection |
Es opcional. Solo salida. Es el nombre completo del recurso de la colección de copias de seguridad. Ejemplo: projects/{project}/locations/{location}/backupCollections/{collection} |
Campo de unión
|
|
kmsKey |
Es opcional. Es la clave de KMS que se usa para encriptar los datos en reposo del clúster. |
Campo de unión
|
|
ondemandMaintenance |
Es opcional. Solo entrada. Es el mantenimiento a pedido del clúster. Este campo se puede usar para activar una actualización crítica a pedido en el clúster. |
Campo de unión
|
|
asyncClusterEndpointsDeletionEnabled |
Es opcional. Si es verdadero, los extremos del clúster que crean y registran los clientes se pueden borrar de forma asíncrona. Es decir, ese extremo del clúster se puede anular antes de que se borren las reglas de reenvío en el extremo del clúster. |
Campo de unión
|
|
maintenanceVersion |
Es opcional. Este campo se puede usar para activar la actualización de autoservicio y, así, indicar la versión de mantenimiento deseada. El campo available_maintenance_versions puede determinar la entrada de este campo. |
Campo de unión
|
|
effectiveMaintenanceVersion |
Solo salida. Este campo representa la versión de mantenimiento real del clúster. |
Campo de unión
|
|
serverCaMode |
Es opcional. Es el modo de AC del servidor para el clúster. |
Campo de unión
|
|
serverCaPool |
Es opcional. Es el grupo de AC administrado por el cliente para el clúster. Solo se aplica a BYOCA, es decir, si server_ca_mode es SERVER_CA_MODE_CUSTOMER_MANAGED_CAS_CA. Formato: "projects/{project}/locations/{region}/caPools/{ca_pool}". |
Campo de unión
|
|
rotateServerCertificate |
Es opcional. Solo entrada. Rota los certificados del servidor. |
Campo de unión
|
|
aclPolicyInSync |
Es opcional. Solo salida. Indica si las reglas de LCA aplicadas al clúster están sincronizadas con las reglas de la política de LCA más reciente. Este campo solo se aplica si se establece la política de LCA para el clúster. |
GcsBackupSource
| Representación JSON |
|---|
{ "uris": [ string ] } |
| Campos | |
|---|---|
uris[] |
Es opcional. Son los URIs de los objetos de Cloud Storage que se importarán. Ejemplo: gs://bucket1/object1, gs://bucket2/folder2/object2 |
ManagedBackupSource
| Representación JSON |
|---|
{ "backup": string } |
| Campos | |
|---|---|
backup |
Es opcional. Ejemplo: //redis.googleapis.com/projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backup} También se admite una versión más corta (sin el prefijo) del nombre de la copia de seguridad, como projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backup_id}. En este caso, se supone que la copia de seguridad está en redis.googleapis.com. |
Marca de tiempo
| Representación JSON |
|---|
{ "seconds": string, "nanos": integer } |
| Campos | |
|---|---|
seconds |
Representa los segundos de la hora UTC desde la época de Unix 1970-01-01T00:00:00Z. Debe estar entre -62135596800 y 253402300799 inclusive (lo que corresponde a 0001-01-01T00:00:00Z a 9999-12-31T23:59:59Z). |
nanos |
Fracciones no negativas de un segundo a una resolución de nanosegundos. Este campo es la parte de la duración en nanosegundos, no una alternativa a los segundos. Los valores de segundos negativos con fracciones deben tener valores nanos no negativos que se cuentan hacia adelante en el tiempo. Debe ser un valor entre 0 y 999,999,999, inclusive. |
PscConfig
| Representación JSON |
|---|
{ "network": string } |
| Campos | |
|---|---|
network |
Obligatorio. Es la red en la que se reservará la dirección IP del extremo de detección, con el formato projects/{network_project}/global/networks/{network_id}. |
DiscoveryEndpoint
| Representación JSON |
|---|
{
"address": string,
"port": integer,
"pscConfig": {
object ( |
| Campos | |
|---|---|
address |
Solo salida. Es la dirección del extremo de Redis expuesto que usan los clientes para conectarse al servicio. La dirección puede ser una IP o un nombre de host. |
port |
Solo salida. Número de puerto del extremo de Redis expuesto. |
pscConfig |
Solo salida. Es la configuración del cliente para determinar dónde se crea el extremo y desde dónde se accede a él. |
PscConnection
| Representación JSON |
|---|
{ "pscConnectionId": string, "address": string, "forwardingRule": string, "projectId": string, "network": string, "serviceAttachment": string, "pscConnectionStatus": enum ( |
| Campos | |
|---|---|
pscConnectionId |
Obligatorio. Es el ID de conexión de PSC de la regla de reenvío conectada al adjunto de servicio. |
address |
Obligatorio. Es la IP asignada en la red del consumidor para la regla de reenvío de PSC. |
forwardingRule |
Obligatorio. Es el URI de la regla de reenvío del lado del consumidor. Ejemplo: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. |
projectId |
Es opcional. Es el ID del proyecto del consumidor en el que se crea la regla de reenvío. |
network |
Obligatorio. Es la red del consumidor en la que reside la dirección IP, con el formato projects/{project_id}/global/networks/{network_id}. |
serviceAttachment |
Obligatorio. Es el adjunto de servicio que es el destino de la conexión de PSC, con el formato projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id}. |
pscConnectionStatus |
Solo salida. Es el estado de la conexión de PSC. Ten en cuenta que este valor se actualiza periódicamente. Para obtener el estado más reciente de una conexión de PSC, consulta https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. |
connectionType |
Solo salida. Es el tipo de conexión de PSC. |
Campo de unión ports. Es el número de puerto del extremo de detección expuesto. ports puede ser solo uno de los parámetros siguientes: |
|
port |
Solo salida. El puerto solo se establecerá para el extremo principal o de lectura, o de descubrimiento. |
StateInfo
| Representación JSON |
|---|
{ // Union field |
| Campos | |
|---|---|
Campo de unión
|
|
updateInfo |
Describe la actualización en curso del clúster cuando el estado del clúster es UPDATING. |
UpdateInfo
| Representación JSON |
|---|
{ // Union field |
| Campos | |
|---|---|
Campo de unión
|
|
targetShardCount |
Cantidad objetivo de fragmentos para el clúster de Redis |
Campo de unión
|
|
targetReplicaCount |
Es la cantidad objetivo de nodos de réplica por fragmento. |
Campo de unión
|
|
targetNodeType |
Es el tipo de nodo de destino para el clúster de Redis. |
ClusterPersistenceConfig
| Representación JSON |
|---|
{ "mode": enum ( |
| Campos | |
|---|---|
mode |
Es opcional. Es el modo de persistencia. |
rdbConfig |
Es opcional. Es la configuración de la RDB. Este campo se ignorará si el modo no es RDB. |
aofConfig |
Es opcional. Configuración de AOF Este campo se ignorará si el modo no es AOF. |
RDBConfig
| Representación JSON |
|---|
{
"rdbSnapshotPeriod": enum ( |
| Campos | |
|---|---|
rdbSnapshotPeriod |
Es opcional. Es el período entre las instantáneas de RDB. |
rdbSnapshotStartTime |
Es opcional. Es la fecha y hora en que se intentó o se intentará tomar la primera instantánea, y con la que se alinearán las instantáneas futuras. Si no se proporciona, se usará la hora actual. Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: |
AOFConfig
| Representación JSON |
|---|
{
"appendFsync": enum ( |
| Campos | |
|---|---|
appendFsync |
Opcional. Es la configuración de fsync. |
RedisConfigsEntry
| Representación JSON |
|---|
{ "key": string, "value": string } |
| Campos | |
|---|---|
key |
|
value |
|
ZoneDistributionConfig
| Representación JSON |
|---|
{
"mode": enum ( |
| Campos | |
|---|---|
mode |
Es opcional. Es el modo de distribución de zonas. El valor predeterminado es MULTI_ZONE cuando no se especifica. |
zone |
Es opcional. Cuando se selecciona la distribución de ZONA ÚNICA, el campo de zona se usa para asignar todos los recursos en esa zona. Esto no se aplica a MULTI_ZONE y se ignorará para los clústeres de MULTI_ZONE. |
CrossClusterReplicationConfig
| Representación JSON |
|---|
{ "clusterRole": enum ( |
| Campos | |
|---|---|
clusterRole |
Solo salida. Es el rol del clúster en la replicación entre clústeres. |
primaryCluster |
Son los detalles del clúster principal que se usa como fuente de replicación para este clúster secundario. Este campo solo se establece para un clúster secundario. |
secondaryClusters[] |
Es la lista de clústeres secundarios que se replican desde este clúster principal. Este campo solo se establece para un clúster principal. |
updateTime |
Solo salida. Es la última vez que se actualizó la configuración de la replicación entre clústeres. Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: |
membership |
Solo salida. Es una vista de solo salida de todos los clústeres miembros que participan en la replicación entre clústeres. Cada clúster miembro proporcionará esta vista, independientemente de su rol de clúster(principal o secundario). Un clúster principal puede proporcionar información sobre todos los clústeres secundarios que se replican desde él. Sin embargo, un clúster secundario solo conoce el clúster principal desde el que se replica. Sin embargo, en situaciones en las que el clúster principal no está disponible(p.ej., una interrupción regional), se puede enviar una solicitud GetCluster a cualquier otro clúster miembro, y este campo mostrará todos los clústeres miembros que participan en la replicación entre clústeres. |
RemoteCluster
| Representación JSON |
|---|
{ "cluster": string, "uid": string } |
| Campos | |
|---|---|
cluster |
Solo salida. Ruta de acceso completa del recurso del clúster remoto con el siguiente formato: projects/ |
uid |
Solo salida. Es el identificador único del clúster remoto. |
Membresía
| Representación JSON |
|---|
{ "primaryCluster": { object ( |
| Campos | |
|---|---|
primaryCluster |
Solo salida. Es el clúster principal que actúa como fuente de replicación para los clústeres secundarios. |
secondaryClusters[] |
Solo salida. Es la lista de clústeres secundarios que se replican desde el clúster principal. |
ClusterMaintenancePolicy
| Representación JSON |
|---|
{
"createTime": string,
"updateTime": string,
"weeklyMaintenanceWindow": [
{
object ( |
| Campos | |
|---|---|
createTime |
Solo salida. Es la fecha y hora en que se creó la política, es decir, se asignó el período de mantenimiento o el período de rechazo. Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: |
updateTime |
Solo salida. Es la fecha y hora en que se actualizó la política, es decir, el período de mantenimiento o el período de denegación. Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: |
weeklyMaintenanceWindow[] |
Es opcional. Es el período de mantenimiento que se aplica a los recursos cubiertos por esta política. El mínimo es 1. Para la versión actual, se espera que la cantidad máxima de weekly_maintenance_window sea uno. |
ClusterWeeklyMaintenanceWindow
| Representación JSON |
|---|
{ "day": enum ( |
| Campos | |
|---|---|
day |
Es opcional. Permite definir una programación que se ejecute en un día específico de la semana. |
startTime |
Es opcional. Hora de inicio del período en UTC. |
TimeOfDay
| Representación JSON |
|---|
{ "hours": integer, "minutes": integer, "seconds": integer, "nanos": integer } |
| Campos | |
|---|---|
hours |
Horas de un día en formato de 24 horas. Debe ser mayor o igual que 0 y, por lo general, debe ser menor o igual que 23. Una API puede permitir el valor “24:00:00” para casos como el horario de cierre de empresas. |
minutes |
Minutos de una hora. Debe ser mayor o igual que 0 y menor o igual que 59. |
seconds |
Segundos de un minuto. Debe ser mayor o igual que 0 y, por lo general, debe ser menor o igual que 59. Una API puede permitir el valor 60 si permite segundos bisiestos. |
nanos |
Fracciones de segundos, en nanosegundos. Debe ser mayor o igual que 0 y menor o igual que 999,999,999. |
ClusterMaintenanceSchedule
| Representación JSON |
|---|
{ "startTime": string, "endTime": string } |
| Campos | |
|---|---|
startTime |
Solo salida. Es la hora de inicio de cualquier mantenimiento programado próximo para esta instancia. Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: |
endTime |
Solo salida. Es la hora de finalización de cualquier mantenimiento programado próximo para esta instancia. Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: |
PscServiceAttachment
| Representación JSON |
|---|
{
"serviceAttachment": string,
"connectionType": enum ( |
| Campos | |
|---|---|
serviceAttachment |
Solo salida. Es el URI del adjunto de servicio que tu PscConnection creado por ti mismo debe usar como destino. |
connectionType |
Solo salida. Es el tipo de conexión de PSC que segmenta este adjunto de servicio. |
ClusterEndpoint
| Representación JSON |
|---|
{
"connections": [
{
object ( |
| Campos | |
|---|---|
connections[] |
Obligatorio. Es un grupo de conexiones de PSC. Se crean en la misma red de VPC, una para cada adjunto de servicio del clúster. |
ConnectionDetail
| Representación JSON |
|---|
{ // Union field |
| Campos | |
|---|---|
Campo de unión connection. Se puede crear una conexión de PSC a un clúster a través de la automatización de la conectividad del servicio (conexión registrada automáticamente) durante la creación del clúster, o bien el cliente puede crearla por su cuenta (conexión registrada por el usuario). connection puede ser solo uno de los parámetros siguientes: |
|
pscAutoConnection |
Es la información detallada de una conexión de PSC que se crea a través de la automatización de la conectividad del servicio. |
pscConnection |
Es la información detallada de una conexión de PSC creada por el cliente propietario del clúster. |
PscAutoConnection
| Representación JSON |
|---|
{ "pscConnectionId": string, "address": string, "forwardingRule": string, "projectId": string, "network": string, "serviceAttachment": string, "pscConnectionStatus": enum ( |
| Campos | |
|---|---|
pscConnectionId |
Solo salida. Es el ID de conexión de PSC de la regla de reenvío conectada al adjunto de servicio. |
address |
Solo salida. Es la IP asignada en la red del consumidor para la regla de reenvío de PSC. |
forwardingRule |
Solo salida. Es el URI de la regla de reenvío del lado del consumidor. Ejemplo: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. |
projectId |
Obligatorio. Es el ID del proyecto de consumidor desde el que se crea la regla de reenvío. |
network |
Obligatorio. Es la red del consumidor en la que reside la dirección IP, con el formato projects/{project_id}/global/networks/{network_id}. |
serviceAttachment |
Solo salida. Es el adjunto de servicio que es el destino de la conexión de PSC, con el formato projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id}. |
pscConnectionStatus |
Solo salida. Es el estado de la conexión de PSC. Ten en cuenta que este valor se actualiza periódicamente. Usa las APIs de Private Service Connect para conocer el estado más reciente. |
connectionType |
Solo salida. Es el tipo de conexión de PSC. |
AutomatedBackupConfig
| Representación JSON |
|---|
{ "automatedBackupMode": enum ( |
| Campos | |
|---|---|
automatedBackupMode |
Es opcional. Es el modo de copia de seguridad automática. Si el modo está inhabilitado, se ignorarán los demás campos. |
Campo de unión schedule. Es el programa de copias de seguridad automáticas. schedule puede ser solo uno de los parámetros siguientes: |
|
fixedFrequencySchedule |
Es opcional. Activa copias de seguridad automáticas con una frecuencia fija. |
Campo de unión
|
|
retention |
Es opcional. Es el tiempo durante el que se conservan las copias de seguridad automáticas antes de que se borren. El valor debe estar entre 1 y 365 días. Si no se especifica, el valor predeterminado es 35 días. Una duración en segundos con hasta nueve dígitos decimales, que terminan en “ |
FixedFrequencySchedule
| Representación JSON |
|---|
{ // Union field |
| Campos | |
|---|---|
Campo de unión
|
|
startTime |
Obligatorio. Es la hora de inicio de cada copia de seguridad automática en UTC. Debe establecerse al inicio de una hora. Este campo es obligatorio. |
Duración
| Representación JSON |
|---|
{ "seconds": string, "nanos": integer } |
| Campos | |
|---|---|
seconds |
Son los segundos firmados del período. Debe estar entre -315,576,000,000 y +315,576,000,000, inclusive. Nota: Estos límites se calculan de la siguiente manera: 60 s/min * 60 min/h * 24 h/día * 365.25 días/año * 10,000 años |
nanos |
Fracciones firmadas de un segundo con una resolución de nanosegundos del período. Las duraciones inferiores a un segundo se representan con un campo |
EncryptionInfo
| Representación JSON |
|---|
{ "encryptionType": enum ( |
| Campos | |
|---|---|
encryptionType |
Solo salida. Tipo de encriptación. |
kmsKeyVersions[] |
Solo salida. Son las versiones de clave de KMS que se usan para proteger los datos en reposo. |
kmsKeyPrimaryState |
Solo salida. Es el estado de la versión principal de la clave de KMS que percibe el sistema. Este campo no se completa en las copias de seguridad. |
lastUpdateTime |
Solo salida. Es la fecha y hora más reciente en la que se actualizó la información de encriptación. Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: |
LabelsEntry
| Representación JSON |
|---|
{ "key": string, "value": string } |
| Campos | |
|---|---|
key |
|
value |
|
Esquema de salida
Este recurso representa una operación de larga duración que es el resultado de una llamada a la API de la red.
Operación
| Representación JSON |
|---|
{ "name": string, "metadata": { "@type": string, field1: ..., ... }, "done": boolean, // Union field |
| Campos | |
|---|---|
name |
El nombre asignado por el servidor, que solo es único dentro del mismo servicio que lo muestra en un principio. Si usas la asignación HTTP predeterminada, el |
metadata |
{
} Un objeto que contiene campos de un tipo arbitrario. Un campo adicional |
done |
Si el valor es |
Campo de unión result. El resultado de la operación, que puede ser un error o una response válida. Si done == false, no se establecen error ni response. Si done == true, se puede establecer error o response. Es posible que algunos servicios no proporcionen el resultado. result puede ser solo uno de los siguientes: |
|
error |
El resultado de error de la operación en caso de falla o cancelación. |
response |
Es la respuesta normal y correcta de la operación. Si el método original no devuelve datos en caso de éxito, como Un objeto que contiene campos de un tipo arbitrario. Un campo adicional |
Cualquiera
| Representación JSON |
|---|
{ "typeUrl": string, "value": string } |
| Campos | |
|---|---|
typeUrl |
Identifica el tipo del mensaje serializado de Protobuf con una referencia de URI que consta de un prefijo que termina en una barra y el nombre de tipo completo. Ejemplo: type.googleapis.com/google.protobuf.StringValue Esta cadena debe contener al menos un carácter El prefijo es arbitrario, y se espera que las implementaciones de Protobuf simplemente quiten todo hasta el último Todas las cadenas de URL de tipo deben ser referencias URI legales con la restricción adicional (para el formato de texto) de que el contenido de la referencia solo debe constar de caracteres alfanuméricos, escapes codificados como porcentaje y caracteres del siguiente conjunto (sin incluir las comillas invertidas externas): En el diseño original de |
value |
Contiene una serialización de Protobuf del tipo que describe type_url. Es una cadena codificada en Base64. |
Estado
| Representación JSON |
|---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
| Campos | |
|---|---|
code |
El código de estado, que debe ser un valor enum de |
message |
Un mensaje de error dirigido al desarrollador, que debe estar en inglés. Cualquier mensaje de error dirigido al usuario debe localizarse y enviarse al campo |
details[] |
Una lista de mensajes que contienen los detalles del error. Hay un conjunto común de tipos de mensajes para que usen las API. Un objeto que contiene campos de un tipo arbitrario. Un campo adicional |
Anotaciones de herramientas
Sugerencia destructiva: ❌ | Sugerencia idempotente: ❌ | Sugerencia de solo lectura: ❌ | Sugerencia de mundo abierto: ❌