Se usó la API de Cloud Translation para traducir esta página.

Crea y administra instancias

En esta página, se muestra cómo crear y administrar instancias de IA de AML, y se puede usar como guía de referencia rápida.

Antes de comenzar

Para obtener los permisos que necesitas para crear y administrar instancias, pídele a tu administrador que te otorgue el rol de IAM de administrador de servicios financieros (financialservices.admin) en tu proyecto. Para obtener más información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.

También puedes obtener los permisos necesarios mediante roles personalizados o cualquier otro rol predefinido.
Crea una clave de encriptación y otórgale acceso

Crea una instancia

Algunos métodos de la API muestran una operación de larga duración (LRO). Estos métodos son asíncronos y muestran un objeto Operation. Para obtener más información, consulta la Referencia de REST. Es posible que la operación no se complete cuando el método muestra una respuesta. En el caso de estos métodos, envía la solicitud y, luego, verifica el resultado. En general, todas las operaciones POST, PUT, UPDATE y DELETE son de larga duración.

Envía la solicitud

Para crear una instancia, usa el método projects.locations.instances.create.

Permisos necesarios para esta tarea

Para realizar esta tarea, debes tener los siguientes permisos:

Permisos

financialservices.v1instances.create

Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:

PROJECT_ID: Es tu ID de tu proyecto de Google Cloud que aparece en Configuración de IAM.
LOCATION: La ubicación del llavero de claves y la instancia. Usa una de las regiones compatibles.
Cómo mostrar ubicaciones
- us-central1
- us-east1
- asia-south1
- europe-west1
- europe-west2
- europe-west4
- northamerica-northeast1
- southamerica-east1
- australia-southeast1
INSTANCE_ID: Es un identificador definido por el usuario para la instancia.
KMS_PROJECT_ID: El ID del proyecto de Google Cloud del proyecto que contiene el llavero
KEY_RING_ID: Es el identificador definido por el usuario para el llavero.
KEY_ID: El identificador definido por el usuario para la clave
Nota: No puedes cambiar a una clave CMEK diferente después de que se creó la instancia.

Cuerpo JSON de la solicitud:

{
  "kmsKey": "projects/KMS_PROJECT_ID/locations/LOCATION/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID"
}

Para enviar tu solicitud, elige una de estas opciones:

curl

Nota: Con el siguiente comando, se supone que accediste a la CLI de gcloud con tu cuenta de usuario a través de la ejecución de gcloud init o gcloud auth login, o a través del uso de Cloud Shell, que accede de forma automática a la CLI de gcloud. Para comprobar la cuenta activa actual, ejecuta gcloud auth list.

Guarda el cuerpo de la solicitud en un archivo llamado request.json. Ejecuta el comando siguiente en la terminal para crear o reemplazar este archivo en el directorio actual:

cat > request.json << 'EOF'
{
  "kmsKey": "projects/KMS_PROJECT_ID/locations/LOCATION/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID"
}
EOF

Luego, ejecuta el siguiente comando para enviar tu solicitud de REST:

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/instances?instance_id=INSTANCE_ID"

PowerShell

Nota: En el siguiente comando, se supone que accediste a la CLI de gcloud con tu cuenta de usuario a través de la ejecución de gcloud init o gcloud auth login . Para comprobar la cuenta activa actual, ejecuta gcloud auth list.

Guarda el cuerpo de la solicitud en un archivo llamado request.json. Ejecuta el comando siguiente en la terminal para crear o reemplazar este archivo en el directorio actual:

@'
{
  "kmsKey": "projects/KMS_PROJECT_ID/locations/LOCATION/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID"
}
'@  | Out-File -FilePath request.json -Encoding utf8

Luego, ejecuta el siguiente comando para enviar tu solicitud de REST:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/instances?instance_id=INSTANCE_ID" | Select-Object -Expand Content

Deberías recibir una respuesta JSON similar a la que se muestra a continuación:

{
  "name": "projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.financialservices.v1.OperationMetadata",
    "createTime": "2023-03-14T15:52:55.358979323Z",
    "target": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID",
    "verb": "create",
    "requestedCancellation": false,
    "apiVersion": "v1"
  },
  "done": false
}

Verifica el resultado

Usa el método projects.locations.operations.get para verificar si se creó la instancia. Si la respuesta contiene "done": false, repite el comando hasta que la respuesta contenga "done": true. Esta operación puede tardar unos minutos.

Permisos necesarios para esta tarea

Para realizar esta tarea, debes tener los siguientes permisos:

Permisos

financialservices.operations.get

Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:

PROJECT_ID: Es el ID de tu proyecto de Google Cloud que aparece en Configuración de IAM.
LOCATION: Es la ubicación de la instancia. Usa una de las regiones compatibles.
Cómo mostrar ubicaciones
- us-central1
- us-east1
- asia-south1
- europe-west1
- europe-west2
- europe-west4
- northamerica-northeast1
- southamerica-east1
- australia-southeast1
OPERATION_ID: Es el identificador de la operación.

Para enviar tu solicitud, elige una de estas opciones:

curl

Ejecuta el siguiente comando:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID"

PowerShell

Ejecuta el siguiente comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID" | Select-Object -Expand Content

Deberías recibir una respuesta JSON similar a la que se muestra a continuación:

{
  "name": "projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.financialservices.v1.OperationMetadata",
    "createTime": "2023-03-14T15:52:55.358979323Z",
    "endTime": "2023-03-14T16:52:55.358979323Z",
    "target": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID",
    "verb": "create",
    "requestedCancellation": false,
    "apiVersion": "v1"
  },
  "done": true,
  "response": {
    "@type": "type.googleapis.com/google.cloud.financialservices.v1.Instance",
    "name": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID",
    "createTime": CREATE_TIME,
    "updateTime": UPDATE_TIME,
    "state": "ACTIVE",
    "kmsKey": "projects/KMS_PROJECT_ID/locations/LOCATION/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID"
  }
}

Cómo obtener una instancia

Para obtener una instancia, usa el método projects.locations.instances.get.

Permisos necesarios para esta tarea

Para realizar esta tarea, debes tener los siguientes permisos:

Permisos

financialservices.v1instances.get

Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:

PROJECT_ID: Es tu ID de tu proyecto de Google Cloud que aparece en Configuración de IAM.
LOCATION: Es la ubicación de la instancia. Usa una de las regiones compatibles.
Cómo mostrar ubicaciones
- us-central1
- us-east1
- asia-south1
- europe-west1
- europe-west2
- europe-west4
- northamerica-northeast1
- southamerica-east1
- australia-southeast1
INSTANCE_ID: Es el identificador definido por el usuario para la instancia.

Para enviar tu solicitud, elige una de estas opciones:

curl

Ejecuta el siguiente comando:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID"

PowerShell

Ejecuta el siguiente comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID" | Select-Object -Expand Content

Deberías recibir una respuesta JSON similar a la que se muestra a continuación:

{
  "name": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID",
  "createTime": "2023-03-14T15:52:55.358979323Z",
  "updateTime": "2023-03-15T15:52:55.358979323Z",
  "kmsKey": "projects/KMS_PROJECT_ID/locations/LOCATION/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID",
  "state": "ACTIVE"
}

Actualizar una instancia

Para actualizar una instancia, usa el método projects.locations.instances.patch.

No todos los campos de una instancia se pueden actualizar. En el siguiente ejemplo, se actualiza el par clave-valor user labels asociado con la instancia.

Permisos necesarios para esta tarea

Para realizar esta tarea, debes tener los siguientes permisos:

Permisos

financialservices.v1instances.update

Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:

PROJECT_ID: Es tu ID de tu proyecto de Google Cloud que aparece en Configuración de IAM.
LOCATION: Es la ubicación de la instancia. Usa una de las regiones compatibles.
Cómo mostrar ubicaciones
- us-central1
- us-east1
- asia-south1
- europe-west1
- europe-west2
- europe-west4
- northamerica-northeast1
- southamerica-east1
- australia-southeast1
INSTANCE_ID: Es el identificador definido por el usuario para la instancia.
KEY: Es la clave en un par clave-valor que se usa para organizar las instancias. Consulta labels para obtener más información.
VALUE: Es el valor en un par clave-valor que se usa para organizar las instancias. Consulta labels para obtener más información.

Cuerpo JSON de la solicitud:

{
  "labels": {
    "KEY": "VALUE"
  }
}

Para enviar tu solicitud, elige una de estas opciones:

curl

Guarda el cuerpo de la solicitud en un archivo llamado request.json. Ejecuta el comando siguiente en la terminal para crear o reemplazar este archivo en el directorio actual:

cat > request.json << 'EOF'
{
  "labels": {
    "KEY": "VALUE"
  }
}
EOF

Luego, ejecuta el siguiente comando para enviar tu solicitud de REST:

curl -X PATCH \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID?updateMask=labels"

PowerShell

Guarda el cuerpo de la solicitud en un archivo llamado request.json. Ejecuta el comando siguiente en la terminal para crear o reemplazar este archivo en el directorio actual:

@'
{
  "labels": {
    "KEY": "VALUE"
  }
}
'@  | Out-File -FilePath request.json -Encoding utf8

Luego, ejecuta el siguiente comando para enviar tu solicitud de REST:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method PATCH `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID?updateMask=labels" | Select-Object -Expand Content

Deberías recibir una respuesta JSON similar a la que se muestra a continuación:

{
  "name": "projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.financialservices.v1.OperationMetadata",
    "createTime": "2023-03-14T15:52:55.358979323Z",
    "target": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID",
    "verb": "update",
    "requestedCancellation": false,
    "apiVersion": "v1"
  },
  "done": false
}

Para obtener más información sobre cómo obtener el resultado de la operación de larga duración (LRO), consulta Cómo verificar el resultado.

Genera una lista de las instancias

Para enumerar las instancias de una instancia determinada, usa el método projects.locations.instances.list.

Permisos necesarios para esta tarea

Para realizar esta tarea, debes tener los siguientes permisos:

Permisos

financialservices.v1instances.list

Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:

PROJECT_ID: Es tu ID de tu proyecto de Google Cloud que aparece en Configuración de IAM.
LOCATION: Es la ubicación de las instancias. Usa una de las regiones compatibles.
Cómo mostrar ubicaciones
- us-central1
- us-east1
- asia-south1
- europe-west1
- europe-west2
- europe-west4
- northamerica-northeast1
- southamerica-east1
- australia-southeast1

Para enviar tu solicitud, elige una de estas opciones:

curl

Ejecuta el siguiente comando:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/instances"

PowerShell

Ejecuta el siguiente comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/instances" | Select-Object -Expand Content

Deberías recibir una respuesta JSON similar a la que se muestra a continuación:

{
  "instances": [
    {
      "name": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID",
      "createTime": "2023-03-14T15:52:55.358979323Z",
      "updateTime": "2023-03-15T15:52:55.358979323Z",
      "kmsKey": "projects/KMS_PROJECT_ID/locations/LOCATION/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID",
      "state": "ACTIVE"
    }
  ]
}

Importa partes registradas

Para importar partes registradas, primero prepara una tabla de BigQuery para la línea de negocio en la que deseas registrar partes. Para obtener más información, consulta Registra a tus clientes. Usa uno de los siguientes esquemas:

Esquema de partes de venta minorista

Columna	Tipo	Descripción
`party_id`	`STRING`	Es el identificador único de la parte en los conjuntos de datos de la instancia.
`party_size`	`STRING`	Es NULL. Se ignora el contenido para los registros de tiendas minoristas.

Esquema de partes comerciales

Columna Tipo Descripción

party_id STRING Es el identificador único de la parte en los conjuntos de datos de la instancia.

party_size

STRING

Es el tamaño de grupo solicitado. El nivel se basa en la cantidad promedio de transacciones mensuales de la parte durante los 365 días anteriores:

SMALL para partes comerciales pequeñas con menos de 500 transacciones mensuales promedio
LARGE para grandes partes comerciales con más de 500 transacciones mensuales promedio

Todos los valores distinguen mayúsculas de minúsculas.

Para importar partes registradas, usa el método projects.locations.instances.importRegisteredParties.

Permisos necesarios para esta tarea

Para realizar esta tarea, debes tener los siguientes permisos:

Permisos

financialservices.v1instances.importRegisteredParties

Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:

PROJECT_ID: Es tu ID de tu proyecto de Google Cloud que aparece en Configuración de IAM.
LOCATION: Es la ubicación de la instancia. Usa una de las regiones compatibles.
Cómo mostrar ubicaciones
- us-central1
- us-east1
- asia-south1
- europe-west1
- europe-west2
- europe-west4
- northamerica-northeast1
- southamerica-east1
- australia-southeast1
INSTANCE_ID: Es el identificador definido por el usuario para la instancia.
BQ_INPUT_REGISTERED_PARTIES_DATASET_NAME: Es un conjunto de datos de BigQuery que contiene una tabla que describe a las partes registradas.
PARTY_REGISTRATION_TABLE: Es la tabla que enumera las partes registradas.
Nota: Puedes proporcionar varias tablas que enumeren las partes registradas. Usa el formato "bq://{project}.{bqDatasetID}.{bqTableID}" para cada tabla del array partyTables.
UPDATE_MODE: Usa REPLACE para reemplazar las partes que se pueden quitar en la tabla de partes registradas por partes nuevas, o usa APPEND para agregar partes nuevas a la tabla de partes registradas.
LINE_OF_BUSINESS: Este campo debe coincidir con el valor lineOfBusiness en la versión del motor que usa la configuración del motor. Usa COMMERCIAL para clientes de banca comercial (entidades jurídicas y físicas) o RETAIL para clientes de banca minorista.

Cuerpo JSON de la solicitud:

{
  "partyTables": [
     "bq://PROJECT_ID.BQ_INPUT_REGISTERED_PARTIES_DATASET_NAME.PARTY_REGISTRATION_TABLE"
  ],
  "mode": "UPDATE_MODE",
  "lineOfBusiness": "LINE_OF_BUSINESS"
}

Para enviar tu solicitud, elige una de estas opciones:

curl

Guarda el cuerpo de la solicitud en un archivo llamado request.json. Ejecuta el comando siguiente en la terminal para crear o reemplazar este archivo en el directorio actual:

cat > request.json << 'EOF'
{
  "partyTables": [
     "bq://PROJECT_ID.BQ_INPUT_REGISTERED_PARTIES_DATASET_NAME.PARTY_REGISTRATION_TABLE"
  ],
  "mode": "UPDATE_MODE",
  "lineOfBusiness": "LINE_OF_BUSINESS"
}
EOF

Luego, ejecuta el siguiente comando para enviar tu solicitud de REST:

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID:importRegisteredParties"

PowerShell

Guarda el cuerpo de la solicitud en un archivo llamado request.json. Ejecuta el comando siguiente en la terminal para crear o reemplazar este archivo en el directorio actual:

@'
{
  "partyTables": [
     "bq://PROJECT_ID.BQ_INPUT_REGISTERED_PARTIES_DATASET_NAME.PARTY_REGISTRATION_TABLE"
  ],
  "mode": "UPDATE_MODE",
  "lineOfBusiness": "LINE_OF_BUSINESS"
}
'@  | Out-File -FilePath request.json -Encoding utf8

Luego, ejecuta el siguiente comando para enviar tu solicitud de REST:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID:importRegisteredParties" | Select-Object -Expand Content

Deberías recibir una respuesta JSON similar a la que se muestra a continuación:

{
  "name": "projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.financialservices.v1.OperationMetadata",
    "createTime": "2023-03-14T15:52:55.358979323Z",
    "target": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID",
    "verb": "importRegisteredParties",
    "requestedCancellation": false,
    "apiVersion": "v1"
  },
  "done": false
}

Para obtener más información sobre cómo obtener el resultado de la operación de larga duración (LRO), consulta Cómo verificar el resultado.

Cuando se completa la LRO, la respuesta indica la cantidad de partes que la operación agregó, quitó o actualizó.

Campo de respuesta	Tipo	Descripción
`partiesAdded`	`integer`	Cantidad de partes que se agregaron con esta operación
`partiesRemoved`	`integer`	Cantidad de partes que se quitaron con esta operación
`partiesTotal`	`integer`	Cantidad total de partes registradas en esta instancia, después de que se completó la operación de actualización
`partiesUptiered`	`integer`	Cantidad total de partes comerciales que pasaron de ser pequeñas a grandes
`partiesDowntiered`	`integer`	Cantidad total de partes comerciales que pasaron de un nivel superior a uno inferior
`partiesFailedToDowntier`	`integer`	Cantidad total de partes comerciales que no pudieron cambiar de nivel de grande a pequeño
`partiesFailedToRemove`	`integer`	Cantidad de partes que no se pudieron quitar con esta operación

Cómo exportar partes registradas

Para exportar partes registradas, usa el método projects.locations.instances.exportRegisteredParties.

Permisos necesarios para esta tarea

Para realizar esta tarea, debes tener los siguientes permisos:

Permisos

financialservices.v1instances.exportRegisteredParties

Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:

PROJECT_ID: Es tu ID de tu proyecto de Google Cloud que aparece en Configuración de IAM.
LOCATION: Es la ubicación de la instancia. Usa una de las regiones compatibles.
Cómo mostrar ubicaciones
- us-central1
- us-east1
- asia-south1
- europe-west1
- europe-west2
- europe-west4
- northamerica-northeast1
- southamerica-east1
- australia-southeast1
INSTANCE_ID: Es el identificador definido por el usuario para la instancia.
BQ_OUTPUT_DATASET_NAME: Es un conjunto de datos de BigQuery en el que se exporta una tabla que describe a las partes registradas.
PARTY_REGISTRATION_TABLE: Es la tabla a la que se escriben las partes registradas.
WRITE_DISPOSITION: Es la acción que se produce si la tabla de destino ya existe. Usa uno de los siguientes valores:
- WRITE_EMPTY: Solo exportar datos si la tabla de destino está vacía.
- WRITE_TRUNCATE: Borra todos los datos existentes en la tabla de BigQuery antes de escribir en ella.
LINE_OF_BUSINESS: Usa COMMERCIAL para clientes de banca comercial (entidades legales y físicas) o RETAIL para clientes de banca minorista.

Cuerpo JSON de la solicitud:

{
  "dataset": {
    "tableUri": "bq://PROJECT_ID.BQ_OUTPUT_DATASET_NAME.PARTY_REGISTRATION_TABLE",
    "writeDisposition": "WRITE_DISPOSITION"
  },
  "lineOfBusiness": "LINE_OF_BUSINESS"
}

Para enviar tu solicitud, elige una de estas opciones:

curl

Guarda el cuerpo de la solicitud en un archivo llamado request.json. Ejecuta el comando siguiente en la terminal para crear o reemplazar este archivo en el directorio actual:

cat > request.json << 'EOF'
{
  "dataset": {
    "tableUri": "bq://PROJECT_ID.BQ_OUTPUT_DATASET_NAME.PARTY_REGISTRATION_TABLE",
    "writeDisposition": "WRITE_DISPOSITION"
  },
  "lineOfBusiness": "LINE_OF_BUSINESS"
}
EOF

Luego, ejecuta el siguiente comando para enviar tu solicitud de REST:

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID:exportRegisteredParties"

PowerShell

Guarda el cuerpo de la solicitud en un archivo llamado request.json. Ejecuta el comando siguiente en la terminal para crear o reemplazar este archivo en el directorio actual:

@'
{
  "dataset": {
    "tableUri": "bq://PROJECT_ID.BQ_OUTPUT_DATASET_NAME.PARTY_REGISTRATION_TABLE",
    "writeDisposition": "WRITE_DISPOSITION"
  },
  "lineOfBusiness": "LINE_OF_BUSINESS"
}
'@  | Out-File -FilePath request.json -Encoding utf8

Luego, ejecuta el siguiente comando para enviar tu solicitud de REST:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID:exportRegisteredParties" | Select-Object -Expand Content

Deberías recibir una respuesta JSON similar a la que se muestra a continuación:

{
  "name": "projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.financialservices.v1.OperationMetadata",
    "createTime": "2023-03-14T15:52:55.358979323Z",
    "target": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID",
    "verb": "exportRegisteredParties",
    "requestedCancellation": false,
    "apiVersion": "v1"
  },
  "done": false
}

Para obtener más información sobre cómo obtener el resultado de la operación de larga duración (LRO), consulta Cómo verificar el resultado.

Este método genera una tabla de BigQuery con el siguiente esquema:

Columna	Tipo	Descripción
`party_id`	`STRING`	Es el identificador único de la parte en los conjuntos de datos de la instancia.
`party_size`	`STRING`	Especifica el nivel para los clientes comerciales (grandes o pequeños). Este campo no se aplica a los clientes minoristas. `NULL` para todos los clientes minoristas `SMALL` para partes comerciales pequeñas con menos de 500 transacciones mensuales promedio `LARGE` para grandes partes comerciales con más de 500 transacciones mensuales promedio Todos los valores distinguen mayúsculas de minúsculas.
`earliest_remove_time`	`STRING`	La fecha y hora más tempranas en las que se puede quitar la fiesta
`party_with_prediction_intent`	`STRING`	Es el indicador que sugiere si se predijo una fiesta desde el registro.
`registration_or_uptier_time`	`STRING`	La hora en la que se registró el partido o se actualizó el nivel

Para obtener más información, consulta Registra a tus clientes.

Borrar una instancia

Para borrar una instancia, usa el método projects.locations.instances.delete.

Permisos necesarios para esta tarea

Para realizar esta tarea, debes tener los siguientes permisos:

Permisos

financialservices.v1instances.delete

Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:

PROJECT_ID: Es tu ID de tu proyecto de Google Cloud que aparece en Configuración de IAM.
LOCATION: Es la ubicación de la instancia. Usa una de las regiones compatibles.
Cómo mostrar ubicaciones
- us-central1
- us-east1
- asia-south1
- europe-west1
- europe-west2
- europe-west4
- northamerica-northeast1
- southamerica-east1
- australia-southeast1
INSTANCE_ID: Es el identificador definido por el usuario para la instancia.

Para enviar tu solicitud, elige una de estas opciones:

curl

Ejecuta el siguiente comando:

curl -X DELETE \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID"

PowerShell

Ejecuta el siguiente comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method DELETE `
    -Headers $headers `
    -Uri "https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID" | Select-Object -Expand Content

Deberías recibir una respuesta JSON similar a la que se muestra a continuación:

{
  "name": "projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.financialservices.v1.OperationMetadata",
    "createTime": "2023-03-14T15:52:55.358979323Z",
    "target": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID",
    "verb": "delete",
    "requestedCancellation": false,
    "apiVersion": "v1"
  },
  "done": false
}

Para obtener más información sobre cómo obtener el resultado de la operación de larga duración (LRO), consulta Cómo verificar el resultado.