Gestión de destinos COS
Puedes gestionar los objetivos de « IBM Cloud Object Storage » (COS) de tu cuenta mediante la CLI de IBM Cloud Activity Tracker Event Routing, la API REST de IBM Cloud Activity Tracker Event Routing y los scripts de Terraform. Un destino es un recurso en el que se pueden recopilar sucesos de auditoría.
Para obtener más información sobre los destinos de IBM Cloud Activity Tracker Event Routing, consulte Destinos.
Acerca de los destinos de COS
Si utilizas un destino de « IBM Cloud Object Storage » (COS), puedes utilizar el mismo depósito COS para recopilar eventos de auditoría en tu cuenta en varias regiones. En ese caso de ejemplo, los sucesos se reenvían a la región de destino antes de escribirse en el grupo de COS. Puede considerar definir un grupo en cada región para mejorar el rendimiento y reducir la latencia de red.
Cuando defina un destino en IBM Cloud Object Storage (COS), tenga en cuenta la información siguiente:
-
Puede crear el grupo en cualquier ubicación. Para obtener más información, consulte Gestión de grupos de IBM Cloud Object Storage (COS).
-
Solo se puede configurar un depósito por destino.
-
Si tiene requisitos de regulación y conformidad, compruebe las ubicaciones en las que se puede crear un grupo. A continuación, si el rendimiento es crítico, considere la posibilidad de crear el grupo de COS en la misma región en la que se generan los sucesos de auditoría.
Acceso de IAM
Debe otorgar a los usuarios permisos de IAM para gestionar destinos. Para obtener más información, consulte Asignar acceso a recursos.
Al definir una política, puede indicar el ámbito de los permisos. Puede elegir entre otorgar permisos para una región específica o para toda la cuenta.
Si tiene permiso de IAM para crear políticas y autorizaciones, puede conceder sólo el nivel de acceso que tenga como usuario del servicio de destino. Por ejemplo, si tienes acceso de «visor» al servicio de destino, solo puedes asignar el rol de «visor» para la autorización. Si intenta asignar un permiso superior, como el de administrador, puede parecer que se concede el permiso, sin embargo, sólo se asignará el permiso de nivel más alto que tenga para el servicio de destino, es decir, el de espectador.
Los usuarios con ámbito regional solo podrán acceder a los destinos de su región autorizada.
| ACCIÓN DE IAM | Ámbito de política de IAM | Roles de IAM | Descripción |
|---|---|---|---|
atracker.target.read |
Región | AdministratorEditorViewerOperator |
Leer (ver) información sobre un destino |
atracker.target.create |
Región | AdministratorEditor |
Crear un destino |
atracker.target.update |
Región | AdministratorEditor |
Actualizar un destino |
atracker.target.delete |
Región | AdministratorEditor |
Suprimir un destino |
atracker.target.list |
Cuenta | AdministratorEditorViewerOperator |
Listar todos los destinos |
Opciones de autenticación
Al escribir en un destino COS, puede utilizar las opciones siguientes para autenticarse en un grupo de IBM Cloud Object Storage (COS).
- Configurando la autorización «serviconfigre-to-service» ( S2S ) (recomendado).
- Proporcionando una clave de API al configurar el destino.
Puede configurar la autorización de servicio a servicio en el grupo de COS para que no necesite pasar una clave de API al escribir los datos cifrados en el grupo de COS.
Requisitos previos de la CLI
Antes de utilizar la CLI para gestionar destinos, lleve a cabo los pasos siguientes:
-
Inicie sesión en IBM Cloud. Ejecute el siguiente mandato: ibmcloud login
Obteniendo la clave de API de grupo de COS
Para obtener información sobre cómo obtener la clave de API de grupo de COS, consulte generación de una clave de API para acceder a un grupo.
Configuración de la autorización de « S2S » mediante la interfaz de usuario con la misma cuenta
Realice lo siguiente para configurar una autorización de servicio a servicio utilizando la interfaz de usuario de IBM Cloud.
-
Inicie sesión en la cuenta de IBM Cloud como propietario de la cuenta que va a configurar los destinos de IBM Cloud Activity Tracker Event Routing.
Después de iniciar sesión con su ID de usuario y su contraseña, se abre el panel de control de IBM Cloud.
-
Haz clic en «Gestionar» > Acceso (IAM). Aparece la pantalla « Gestionar acceso y usuarios ».
-
Pulse Autorizaciones.
-
Pulse Crear.
-
En « Servicio de origen », selecciona Activity Tracker y, en «¿Cómo desea delimitar el acceso?», seleccione «Todos los recursos ».
-
Para Servicio de destino, seleccione Cloud Object Storage y para ¿Cómo desea ampliar el acceso? seleccione Recursos basados en atributos seleccionados.
-
Seleccione Instancia de servicio y serie igual a el nombre de la Instancia de COS.
-
Para Acceso de servicio, seleccione Escritor de objetos.
-
Pulse Autorizar. La nueva autorización de servicio a servicio se especificará en la vista Gestionar autorizaciones.
Sólo podrá autorizar a la instancia de IBM Cloud Object Storage utilizando la interfaz de usuario. Si desea limitar la autorización a un grupo de IBM Cloud Object Storage específico, debe configurar la autorización utilizando la API.
Configuración de la autorización de « S2S » mediante la CLI
Realice lo siguiente para configurar una autorización de servicio a servicio utilizando la CLI de IBM Cloud.
-
[Inicie la sesión en la cuenta de IBM Cloud] (/docs/cli?topic=cli-ibmcloud_cli#ibmcloud_login) como el propietario de la cuenta que va a configurar la autorización de IBM Cloud Activity Tracker Event Routing.
-
Cree una política de autorización que defina la autorización de servicio a servicio.
ibmcloud iam authorization-policy-create atracker cloud-object-storage "Object Writer" [--target-service-instance-id <COS_SERVICE_INSTANCE>Donde:
COS_SERVICE_INSTANCEes el CRN de instancia de grupo de la instancia de COS que se debe autorizar.
Configuración de la autorización de « S2S » mediante la API
Realice lo siguiente para configurar una autorización de servicio a servicio utilizando la API de IBM Cloud.
-
Inicie la sesión en la cuenta de IBM Cloud como propietario de la cuenta que va a configurar la autorización de IAM de IBM Cloud Activity Tracker Event Routing.
-
Cree un archivo
authorization_policy_resource.jsonque defina la autorización de servicio a servicio.{ "type": "authorization", "subjects": [ { "attributes": [ { "name": "accountId", "value": "CUSTOMER_ACCOUNT_ID" }, { "name": "serviceName", "value": "atracker" } ] } ], "roles": [ { "role_id": "crn:v1:bluemix:public:iam::::serviceRole:ObjectWriter" } ], "resources": [ { "attributes": [ { "name": "accountId", "value": "CUSTOMER_ACCOUNT_ID" }, { "name": "serviceName", "value": "cloud-object-storage" }, { "name": "serviceInstance", "value": "COS_SERVICE_INSTANCE" } ] } ] }Donde:
CUSTOMER_ACCOUNT_IDes el GUID de cuenta para la cuenta que va a configurar destinos. Esto se puede encontrar utilizando el mandatoibmcloud account list.COS_SERVICE_INSTANCEes el CRN de instancia de grupo de la instancia de COS que se debe autorizar. -
Obtenga una señal de acceso IAM. Para obtener más información, consulte Recuperación de señales de acceso de IAM.
-
Ejecute el mandato siguiente para configurar la autorización de servicio a servicio:
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header "Authorization: $ACCESS_TOKEN" -d @authorization_policy_resource.json "https://iam.cloud.ibm.com/v1/policies"
Creación de un destino de COS utilizando la CLI
Utilice este mandato para crear un destino de IBM Cloud Object Storage que se utilizará para configurar un destino para sucesos de actividad.
ibmcloud atracker target create --name TARGET_NAME --type TARGET_TYPE ( [--file COS_ENDPOINT_DEFINITION_JSON_FILE] | ( [--endpoint COS_ENDPOINT] [--bucket COS_BUCKET] [--target-crn COS_TARGET_CRN] ( [--api-key ( COS_API_KEY | @COS_API_KEY_FILE )] | [--service-to-service-enabled ( TRUE | FALSE )] ) ) ) [--region REGION] [--output FORMAT]
Opciones de comando
--region REGION|-r REGION-
Nombre de la región, por ejemplo,
us-southoeu-gb. Si no se especifica, se utilizará la región en la que se ha iniciado sesión o la de destino. --name TARGET_NAME-
El nombre que debe darse al destino.
No incluya información de identificación personal en ningún nombre de recurso.
--type TARGET_TYPE-
Establezca
TARGET_TYPEencloud_object_storagepara un destino de COS. --file @COS_ENDPOINT_DEFINITION_JSON_FILE-
Un archivo que contiene una definición de punto final en el formato siguiente:
{ "endpoint": "aaaaa", "target_crn": "yyyyy", "bucket": "zzzzzz", "api_key": "xxxxxx" } --endpoint COS_ENDPOINT-
El punto final de IBM Cloud Object Storage que se va a asociar con el grupo de IBM Cloud Object Storage.
--bucket BUCKET-
El nombre del grupo de IBM Cloud Object Storage que se va a asociar con el destino.
--target-crn COS_TARGET_CRN-
El CRN de la instancia de IBM Cloud Object Storage.
--api-key COS_API_KEY|@COS_API_KEY_FILE-
El valor de la clave de API o una referencia al archivo de claves de API utilizado para obtener acceso. Por ejemplo,
ibmcloud login --apikey $KEYFILE --service-to-service-enabled-
Indica si autorización de servicio a servicio se ha habilitado para el grupo. Especifique
TRUEsi la autorización de servicio a servicio está habilitada yFALSEsi la autorización de servicio a servicio no está habilitada. De forma predeterminada,service_to_service_enabledesFALSE. --output FORMAT-
El formato soportado actualmente es JSON. Si se especifica, la salida se devolverá en formato JSON. Si no se ha especificado
JSON, la salida se devolverá en un formato tabular. help|--help|-h-
Listar las opciones disponibles para el mandato.
Ejemplo
A continuación se muestra un ejemplo utilizando el mandato ibmcloud atracker target create --name my-target --type cloud_object_storage --endpoint s3.us-west.cloud-object-storage.appdomain.cloud --bucket cloud-object-storage-my-cos --target-crn crn:v1:staging:public:cloud-object-storage:global:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx:: --api-key yyyyyyyyyyyyyyyyyyyyyyyyyyyyy.
En este ejemplo muestra una creación de destino satisfactoria.
Target
Name: my-target
ID: 000000000-00000000-0000-0000-00000000
CRN: crn:v1:staging:public:atracker:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx
Type: cloud_object_storage
COS Endpoint: s3.us-west.cloud-object-storage.appdomain.cloud
COS Target CRN: crn:v1:staging:public:cloud-object-storage:global:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx:
COS Bucket: cloud-object-my-target
Service to Service Enabled: true
Write Status: success
Created: 2021-07-21T16:04:15.174Z
Updated: 2021-07-21T16:04:15.174Z
Actualización de un destino de COS utilizando la CLI
Utilice este mandato para actualizar un destino COS para una región de IBM Cloud Activity Tracker Event Routing. Cualquier valor especificado que sea distinto de cuando se creó originalmente el destino se actualizará al valor especificado en el mandato.
ibmcloud atracker target update --target TARGET [--name TARGET_NAME] [ [--file COS_ENDPOINT_DEFINITION_JSON_FILE] | ( [--endpoint COS_ENDPOINT] [--bucket COS_BUCKET] [--target-crn COS_TARGET_CRN] ( [--api-key ( COS_API_KEY | @COS_API_KEY_FILE )] | [--service-to-service-enabled ( TRUE | FALSE )]))] [--output FORMAT]
Opciones de comando
--target TARGET-
El ID o el nombre del destino actual.
--region REGION|-r REGION-
Nombre de la región, por ejemplo,
us-southoeu-gb. Si no se especifica, se utilizará la región en la que se ha iniciado sesión o la de destino. --name TARGET_NAME-
El nombre que debe darse al destino.
No incluya información de identificación personal en ningún nombre de recurso.
--file @COS_ENDPOINT_DEFINITION_JSON_FILE-
Un archivo que contiene una definición de punto final en el formato siguiente:
{ "endpoint": "aaaaa", "target_crn": "yyyyy", "bucket": "zzzzzz", "api_key": "xxxxxx" }o para un escenario en el que la autenticación de servicio a servicio esté habilitada:
{ "endpoint": "aaaaa", "target_crn": "yyyyy", "bucket": "zzzzzz", "service_to_service_enabled": true } --endpoint COS_ENDPOINT-
El punto final de IBM Cloud Object Storage que se va a asociar con el grupo de IBM Cloud Object Storage.
--bucket COS_BUCKET-
El nombre del grupo de IBM Cloud Object Storage que se va a asociar con el destino.
--target-crn COS_TARGET_CRN-
El CRN de la instancia de IBM Cloud Object Storage.
--api-key COS_API_KEY|@COS_API_KEY_FILE-
El valor de la clave de API o una referencia al archivo de claves de API utilizado para obtener acceso. Por ejemplo,
ibmcloud login --apikey $KEYFILE --service-to-service-enabled (TRUE | FALSE)-
Indica si autorización de servicio a servicio se ha habilitado para el grupo. Especifique
TRUEsi la autorización de servicio a servicio está habilitada yFALSEsi la autorización de servicio a servicio no está habilitada. De forma predeterminada, la autorización de servicio a servicio esFALSE. --output FORMAT-
El formato soportado actualmente es JSON. Si se especifica, la salida se devolverá en formato JSON. Si no se ha especificado
JSON, la salida se devolverá en un formato tabular. help|--help|-h-
Listar las opciones disponibles para el mandato.
Ejemplo
A continuación se muestra un ejemplo utilizando el mandato ibmcloud atracker target update --target my-target --name new-target-name.
Target
Name: new-target-name
ID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
CRN: crn:v1:staging:public:atracker:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx
Type: cloud_object_storage
COS Endpoint: s3.us-west.cloud-object-storage.appdomain.cloud
COS Target CRN: crn:v1:staging:public:cloud-object-storage:global:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx:
COS Bucket: cloud-object-my-target
Service to Service Enabled: true
Write Status: success
Created: 2021-07-21T16:04:15.174Z
Updated: 2021-07-21T17:49:56.452Z
Supresión de un destino utilizando la CLI
Utilice este mandato para suprimir un destino.
ibmcloud atracker target rm --target TARGET [--force]
Opciones de comando
--target TARGET- El ID o el nombre del destino.
--force|-f- Suprimirá el destino sin proporcionar al usuario ningún mensaje adicional.
help|--help|-h- Listar las opciones disponibles para el mandato.
Ejemplo
A continuación se muestra un ejemplo utilizando el mandato ibmcloud atracker target rm --target xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.
Are you sure you want to remove the target with target ID xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx? [y/N]>y
OK
Target with target ID xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx was successfully removed.
A continuación se muestra un ejemplo utilizando el mandato ibmcloud atracker target rm --target xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -force.
Este ejemplo muestra un mandato fallido en el que no se ha podido encontrar el destino especificado.
Are you sure you want to remove the Target bearing Target ID 33333333-3333-3333-3333-333333333333? [y/N]> y
FAILED
Something went wrong. Error:
Status Code: 404
Incident ID: 67a33257-d5a4-46ec-94d9-14eb70e94f3d
Code: not_found
Message: The target id specified in `target_id` field is not found.
Validación de un destino utilizando la CLI
Utilice este mandato para validar que un destino se ha configurado correctamente para una región de IBM Cloud Activity Tracker Event Routing.
ibmcloud atracker target validate --target TARGET [--region REGION] [--output FORMAT]
Opciones de comando
--target TARGET- El ID o el nombre del destino.
--region REGION|-r REGION- Nombre de la región, por ejemplo,
us-southoeu-gb. Si no se especifica, se utilizará la región en la que se ha iniciado sesión o la de destino. --output FORMAT- El formato soportado actualmente es JSON. Si se especifica, la salida se devolverá en formato JSON. Si no se ha especificado
JSON, la salida se devolverá en un formato tabular. help|--help|-h- Listar las opciones disponibles para el mandato.
Ejemplo
A continuación se muestra un ejemplo utilizando el mandato ibmcloud atracker target validate --target new-target-name.
Este ejemplo muestra un destino de COS validado correctamente.
Target
Name: new-target-name
ID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
CRN: crn:v1:staging:public:atracker:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx
Type: cloud_object_storage
COS Endpoint: s3.us-west.cloud-object-storage.appdomain.cloud
COS Target CRN: crn:v1:staging:public:cloud-object-storage:global:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx:
COS Bucket: cloud-object-my-target
Service to Service Enabled: true
Write Status: success
Created: 2021-07-21T16:04:15.174Z
Updated: 2021-07-21T17:49:56.452Z
Obtención de información sobre un destino utilizando la CLI
Utilice este mandato para obtener información sobre un destino para una región de IBM Cloud Activity Tracker Event Routing.
ibmcloud atracker target get --target TARGET [--output FORMAT]
Opciones de comando
--target TARGET- El ID o el nombre del destino.
--output FORMAT- El formato soportado actualmente es JSON. Si se especifica, la salida se devolverá en formato JSON. Si no se ha especificado
JSON, la salida se devolverá en un formato tabular. help|--help|-h- Listar las opciones disponibles para el mandato.
Ejemplo
A continuación se muestra un ejemplo utilizando el mandato ibmcloud atracker target get --target new-target-name que muestra un destino de COS.
Target
Name: new-target-name
ID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
CRN: crn:v1:staging:public:atracker:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx
Type: cloud_object_storage
COS Endpoint: s3.us-west.cloud-object-storage.appdomain.cloud
COS Target CRN: crn:v1:staging:public:cloud-object-storage:global:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx:
COS Bucket: cloud-object-my-target
Service to Service Enabled: true
Write Status: success
Created: 2021-07-21T16:04:15.174Z
Updated: 2021-07-21T17:49:56.452Z
Listado de todos los destinos de una región
Utilice este mandato para generar una lista de los destinos configurados para una región de IBM Cloud Activity Tracker Event Routing.
ibmcloud atracker target ls [--output FORMAT]
Opciones de comando
--output FORMAT- El formato soportado actualmente es JSON. Si se especifica, la salida se devolverá en formato JSON. Si no se ha especificado
JSON, la salida se devolverá en un formato tabular. help|--help|-h- Listar las opciones disponibles para el mandato.
Ejemplo
A continuación se muestra un ejemplo utilizando el mandato ibmcloud atracker target ls.
Name ID Region Type Service to Service Enabled Created
target-01 xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx us-south cloud_object_storage true 2020-11-18T03:52:08.603Z
target-02 yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy us-south cloud_object_storage true 2020-11-18T03:52:01.592Z
target-02-backup zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz us-east cloud_object_storage false 2021-02-26T06:53:13.466Z
Destinos y acciones de la API
En la tabla siguiente se listan las acciones que puede ejecutar para gestionar destinos:
| Acción | Método de API REST | API_URL |
|---|---|---|
| Crear un destino | POST |
<ENDPOINT>/api/v2/targets |
| Actualizar un destino | PUT |
<ENDPOINT>/api/v2/targets/<TARGET_ID> |
| Suprimir un destino | DELETE |
<ENDPOINT>/api/v2/targets/<TARGET_ID> |
| Leer un destino | GET |
<ENDPOINT>/api/v2/targets/<TARGET_ID> |
| Listar todos los destinos | GET |
<ENDPOINT>/api/v2/targets |
| Validar un destino | POST |
<ENDPOINT>/api/v2/targets/{id}/validate |
Puede utilizar puntos finales públicos y privados para gestionar destinos. Para obtener más información sobre la lista de ENDPOINTS que están disponibles, consulte Puntos finales.
-
Puede gestionar destinos desde la red privada utilizando un punto final de API con el formato siguiente:
https://private.REGION.atracker.cloud.ibm.com -
Puede gestionar destinos desde la red pública utilizando un punto final de API con el formato siguiente:
https://REGION.atracker.cloud.ibm.com -
Puede inhabilitar los puntos finales públicos actualizando los valores de la cuenta. Para obtener más información, consulte Configuración de los valores de destino y región.
Para obtener más información sobre la API REST, consulte Destinos.
Requisitos previos de la API
Para realizar llamadas de API para gestionar destinos, complete los pasos siguientes:
- Obtenga una señal de acceso IAM. Para obtener más información, consulte Recuperación de señales de acceso de IAM.
- Identifique el punto final de API en la región en la que tiene previsto configurar o gestionar un destino. Para obtener más información, consulte Puntos finales.
Creación de un destino de COS utilizando la API
Puede utilizar el siguiente mandato cURL para crear un destino de IBM Cloud Object Storage (COS):
curl -X POST <ENDPOINT>/api/v2/targets -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json" -d '{
"name": "TARGET_NAME",
"target_type": "cloud_object_storage",
"cos_endpoint": {
"endpoint": "PRIVATE_COS_ENDPOINT",
"target_crn": "COS_CRN",
"bucket": "BUCKET_NAME",
"api_key": "API_KEY",
"service_to_service_enabled": SERVICE_TO_SERVICE
}
}'
Donde
-
<ENDPOINT>es el punto final de la API en la región donde tiene previsto configurar o gestionar un destino. Para obtener más información, consulte Puntos finales. -
TARGET_NAMEes el nombre del destino. La longitud máxima del nombre es de 256 caracteres.No incluya información de identificación personal en ningún nombre de recurso.
-
TARGET_TYPEes el tipo del destino. El tipo válido escloud_object_storage. -
cos_endpointincluye información sobre el destino. Para obtener más información sobre cómo obtener detalles de los grupos, consulte Obtención de los detalles de configuración de grupo.
PRIVATE_COS_ENDPOINT indica el punto final de IBM Cloud Activity Tracker Event Routing para buscar este grupo. Utilizar punto final privado.
COS_CRN indica el CRN de la instancia de COS donde ha suministrado el grupo.
BUCKET_NAMEIndica el nombre del grupo.
API_KEYContiene la clave de API que tiene permisos para cargar objetos en el grupo. Este valor se ignora si service_to_service_enabled es true.
SERVICE_TO_SERVICE indica si autorización de servicio a servicio se ha habilitado para el grupo. Especifique true si
la autorización de servicio a servicio está habilitada y false si la autorización de servicio a servicio no está habilitada. De forma predeterminada, la autorización de servicio a servicio es false.
Por ejemplo, puede utilizar la siguiente solicitud de cURL para crear un destino en Dallas:
curl -X POST https://private.us-south.atracker.cloud.ibm.com/api/v2/targets -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json" -d '{
"name": "My COS target",
"target_type": "cloud_object_storage",
"cos_endpoint": {
"endpoint": "s3.private.us-south.cloud-object-storage.appdomain.cloud",
"target_crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/<account-id>:<instance-id>::",
"bucket": "my-activity-tracking-bucket",
"api_key": "xxxxxxxxxxxxxxxxxx",
"service_to_service_enabled": false
}
}'
En la respuesta, obtiene información sobre el destino como, por ejemplo, el id, que indica el GUID del destino y el crn, que indica el CRN del destino.
Actualización de un destino de COS utilizando la API
Al actualizar un destino de IBM Cloud Object Storage (COS), debe incluir la información de destino en la sección de datos de la solicitud.
- Debe pasar todos los campos.
- Actualice los campos que deben cambiarse.
- No puede cambiar el
target_typede un destino una vez creado.
Puede utilizar el siguiente mandato cURL para actualizar un destino:
curl -X PUT <ENDPOINT>/api/v2/targets/TARGET_ID -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json" -d '{
"name": "TARGET_NAME",
"target_type": "TARGET_TYPE",
"cos_endpoint": {
"endpoint": "PRIVATE_COS_ENDPOINT",
"target_crn": "COS_CRN",
"bucket": "BUCKET_NAME",
"api_key": "API_KEY",
"service_to_service_enabled": SERVICE_TO_SERVICE
}
}'
Donde
-
<ENDPOINT>es el punto final de la API en la región donde tiene previsto configurar o gestionar un destino. Para obtener más información, consulte Puntos finales. -
TARGET_IDes el ID del destino. -
TARGET_NAMEes el nombre del destino. La longitud máxima del nombre es de 256 caracteres.No incluya información de identificación personal en ningún nombre de recurso.
-
TARGET_TYPEes el tipo del destino. Establezca el valor encloud_object_storagepara un destino de COS. -
cos_endpointincluye información sobre el destino. Para obtener más información sobre cómo obtener detalles de los grupos, consulte Obtención de los detalles de configuración de grupo.
PRIVATE_COS_ENDPOINT indica el punto final de IBM Cloud Activity Tracker Event Routing para buscar este grupo. Utilizar punto final privado.
COS_CRN indica el CRN de la instancia de COS donde ha suministrado el grupo.
BUCKET_NAMEIndica el nombre del grupo.
API_KEYContiene la clave de API que tiene permisos para cargar objetos en el grupo. Este valor se ignora si service_to_service_enabled es true.
SERVICE_TO_SERVICE indica si autorización de servicio a servicio se ha habilitado para el grupo. Especifique true si
la autorización de servicio a servicio está habilitada y false si la autorización de servicio a servicio no está habilitada. De forma predeterminada, la autorización de servicio a servicio es false.
Por ejemplo, puede utilizar la siguiente solicitud de cURL para crear un destino en Dallas:
curl -X PUT https://private.us-south.atracker.cloud.ibm.com/api/v2/targets -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json" -d '{
"name": "My COS target",
"target_type": "cloud_object_storage",
"cos_endpoint": {
"endpoint": "s3.private.us-south.cloud-object-storage.appdomain.cloud",
"target_crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/<account-id>:<instance-id>::",
"bucket": "my-activity-tracking-bucket",
"service_to_service_enabled": true
}
}'
Supresión de un destino utilizando la API
Puede utilizar el siguiente mandato de cURL para suprimir un destino:
curl -X DELETE <ENDPOINT>/api/v2/targets/<TARGET_ID> -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"
Donde
<ENDPOINT>es el punto final de la API en la región donde tiene previsto configurar o gestionar un destino. Para obtener más información, consulte Puntos finales.<TARGET_ID>es el ID del destino.
Por ejemplo, puede utilizar la siguiente solicitud de cURL para suprimir un destino en EE.UU. sur con el ID 00000000-0000-0000-0000-000000000000:
curl -X DELETE https://private.us-south.atracker.cloud.ibm.com/api/v2/targets/00000000-0000-0000-0000-000000000000 -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"
En la respuesta, obtendrá un resultado vacío si la supresión se ha realizado correctamente:
{}
Validación de un destino utilizando la API
Puede utilizar el mandato cURL siguiente para validar un destino comprobando las credenciales para escribir en el destino.
curl -X POST <ENDPOINT>/api/v2/targets/<TARGET_ID>/validate -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"
Donde
<ENDPOINT>es el punto final de la API en la región donde tiene previsto configurar o gestionar un destino. Para obtener más información, consulte Puntos finales.<TARGET_ID>es el ID del destino.
Por ejemplo, puede utilizar la siguiente solicitud cURL para validar un destino en EE.UU. sur con el ID 00000000-0000-0000-0000-000000000000:
curl -X POST https://private.us-south.atracker.cloud.ibm.com/api/v2/targets/<TARGETID>/validate -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"
En la respuesta, obtendrá información en la sección cos_write_status, por ejemplo:
"write_status": {
"status": "success"
},
Visualización de un destino utilizando la API
Puede utilizar el siguiente mandato de cURL para ver los detalles de configuración de 1 destino:
curl -X GET <ENDPOINT>/api/v2/targets/<TARGET_ID> -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"
Donde
<ENDPOINT>es el punto final de la API en la región donde tiene previsto configurar o gestionar un destino. Para obtener más información, consulte Puntos finales.<TARGET_ID>es el ID del destino.
Por ejemplo, puede ejecutar la siguiente solicitud cURL para obtener información sobre un destino con el ID 00000000-0000-0000-0000-000000000000:
curl -X GET https://private.us-south.atracker.cloud.ibm.com/api/v2/targets/00000000-0000-0000-0000-000000000000 -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"
Los resultados mostrarán si el objetivo es COS ("target_type": "cloud_object_storage").
Listar todos los destinos utilizando la API
Puede utilizar el siguiente mandato cURL para ver todos los destinos:
curl -X GET <ENDPOINT>/api/v2/targets -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"
Donde
<ENDPOINT>es el punto final de la API en la región donde tiene previsto configurar o gestionar un destino. Para obtener más información, consulte Puntos finales.
Por ejemplo, puede ejecutar la siguiente solicitud cURL para obtener información sobre los destinos definidos en Dallas:
curl -X GET https://private.us-south.atracker.cloud.ibm.com/api/v2/targets -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"
Los resultados mostrarán si el objetivo es un objetivo COS ("target_type": "cloud_object_storage").
Códigos de respuesta de HTTP
Cuando se utiliza la API REST de IBM Cloud Activity Tracker Event Routing, es posible obtener códigos de respuesta HTTP estándar para indicar si un método se ha completado satisfactoriamente.
- Una respuesta de 200 siempre indica éxito.
- Una respuesta 4xx indica una anomalía.
- Una respuesta 5xx normalmente indica un error interno del sistema.
Consulte la tabla siguiente para ver algunos códigos de respuesta HTTP:
| Código de estado | Estado | Descripción |
|---|---|---|
200 |
OK | La solicitud se ha realizado correctamente. |
201 |
OK | La solicitud se ha realizado correctamente. Se crea un recurso. |
400 |
Solicitud errónea | La solicitud no ha sido satisfactoria. Es posible que falte un parámetro que sea necesario. |
401 |
No autorizado | La señal de IAM que se utiliza en la solicitud de API no es válida o ha caducado. |
403 |
Prohibido | La operación está prohibida debido a permisos insuficientes. |
404 |
No encontrado | El recurso solicitado no existe o ya se ha suprimido. |
429 |
Demasiadas solicitudes | Demasiadas solicitudes han llegado a la API demasiado rápido. |
500 |
Error de servidor interno | Algo ha fallado en el proceso de IBM Cloud Activity Tracker Event Routing. |
Creación de un destino de IBM Cloud Object Storage utilizando la interfaz de usuario
Sólo se listan y se pueden seleccionar los recursos de su cuenta. Para especificar un recurso en una cuenta diferente, seleccione Especificar CRN en Seleccionar destino.
- Inicie sesión en su cuenta de IBM Cloud.
- Haz clic en el icono de menú
> Observabilidad.
- Selecciona « Seguimiento de actividad ».
- Pulse Crear para abrir el panel de creación.
- Elegir tipo: pulse Object Storage.
- Se requiere autorización de servicio: la autorización de servicio es necesaria para permitir que IBM Cloud Activity Tracker Event Routing se comunique con IBM Cloud Object Storage. Pulse Autorizar ahora para crear la política automáticamente o pulse Otorgar acceso en IAM.
- Elegir destino: seleccione Buscar por instancia o Especificar CRN
- Buscar por instancia: Seleccione una instancia de IBM Cloud Object Storage en la tabla o pulse Crear para crear una nueva instancia de IBM Cloud Object Storage. Después de seleccionar una instancia, seleccione un grupo IBM Cloud Object Storage.
- Especificar CRN: especifique el nombre de recurso de nube (CRN) del grupo IBM Cloud Object Storage. Esto le permite especificar un CRN desde una cuenta diferente.
- Punto final de grupo: utilice el punto final de grupo predeterminado o cámbielo.
- Nombre de destino: especifique un nombre significativo para el destino.
- Región de destino: seleccione la región que procesará los datos de suceso.
- Conmute Establecer como destino predeterminado para establecer automáticamente el nuevo destino como destino predeterminado en los valores de IBM Cloud Activity Tracker Event Routing. Consulte la documentación de destinos predeterminados para obtener más detalles.
- Pulse Crear destino.
Actualización de un destino de IBM Cloud Object Storage utilizando la interfaz de usuario
Sólo se listan y se pueden seleccionar los recursos de su cuenta. Para especificar un recurso en una cuenta diferente, seleccione Especificar CRN en Seleccionar destino.
- Inicie sesión en su cuenta de IBM Cloud.
- Haz clic en el icono de menú
> Observabilidad.
- Selecciona « Seguimiento de actividad ».
- Selecciona el elemento que deseas actualizar y haz clic en el
.
- Pulse No establecer como valor predeterminado para eliminar el destino como destino predeterminado en los valores de IBM Cloud Activity Tracker Event Routing. Consulte la documentación de destinos predeterminados para obtener más detalles.
- Pulse Editar para abrir el panel de actualización.
- Detalles: Pulse Editar para actualizar el nombre o la región del destino. También puede conmutar Destino predeterminado para añadir o eliminar el destino como destino predeterminado en los valores de IBM Cloud Activity Tracker Event Routing.
- Pulse Guardar para actualizar el destino.
- Destino: pulse Editar para cambiar la instancia o grupos IBM Cloud Object Storage asociados con el destino.
- Pulse Guardar para actualizar el destino.
Cómo eliminar un destino mediante la interfaz de usuario
No se puede eliminar un destino de « IBM Cloud Activity Tracker Event Routing » si se utiliza en una ruta o como configuración de destino por defecto.
- Inicie sesión en su cuenta de IBM Cloud.
- Haz clic en el icono de menú
> Observabilidad.
- Selecciona « Seguimiento de actividad ».
- Determine qué destino desea suprimir y pulse el
.
- Pulse Suprimir y, a continuación, pulse Suprimir en el panel de confirmación.
Mostrar todos los objetivos de una región mediante la interfaz de usuario
- Inicie sesión en su cuenta de IBM Cloud.
- Haz clic en el icono de menú
> Observabilidad.
- Selecciona « Seguimiento de actividad ».
En la tabla se detallan los datos de los destinatarios:
- Tipo de destino
- Nombre de destino
- Región de destino
- Rutas: si se utiliza en alguna ruta
- Estado del objetivo:
- Activo: el destino funciona según lo esperado
- Error: el destino está mal configurado y los sucesos no se direccionarán al destino. Actualice los detalles de destino o el destino para arreglar la configuración de destino o suprima el destino si ya no es necesario