Richiamo di un elenco di chiavi root o standard

Per una vista di alto livello, puoi sfogliare le tue chiavi root o le chiavi standard gestite nella tua istanza di cui è stato eseguito il provisioning di Hyper Protect Crypto Services effettuando una chiamata GET al seguente endpoint.

https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/keys

1. Richiama le tue credenziali del servizio e di autenticazione per utilizzare le chiavi nel servizio.

2. Visualizza le caratteristiche generali delle tue chiavi immettendo il seguente comando cURL.

   curl -X GET \
   "https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/keys" \
   -H 'accept: application/vnd.ibm.collection+json' \
   -H 'authorization: Bearer <IAM_token>' \
   -H 'bluemix-instance: <instance_ID>' \
   -H 'x-kms-key-ring: <key_ring_ID>' \
   -H 'correlation-id: <correlation_ID>' \
   

   Sostituisci le variabili nella richiesta di esempio in base alla seguente tabella.

   Tabella 2. Descrive le variabili necessarie per visualizzare le chiavi con l'API

   Variabile	Descrizione
   region	L'abbreviazione della regione, come us-south o au-syd, che rappresenta l'area geografica in cui si trova la tua istanza del servizio Hyper Protect Crypto Services. Per ulteriori informazioni, vedi Endpoint del servizio regionali.
   port	Obbligatorio. Il numero di porta dell'endpoint API.
   IAM_token	Il tuo token di accesso IBM Cloud. Includi il contenuto completo del token IAM, incluso il valore Bearer, nella richiesta cURL. Per ulteriori informazioni, vedi Richiamo di un token di accesso.
   instance_ID	L'identificativo univoco che viene assegnato alla tua istanza del servizio Hyper Protect Crypto Services. Per ulteriori informazioni, vedi Richiamo di un ID istanza.
   key_ring_ID	Facoltativo. L'identificativo univoco del keyring a cui appartiene la chiave. Se non specificato, Hyper Protect Crypto Services ricercherà la chiave in ogni key ring associato all'istanza specificata. Pertanto, si consiglia di specificare l'ID key ring per una richiesta più ottimizzata. Nota: l'ID key ring delle chiavi create senza un'intestazione x-kms-key-ring è: default. Per ulteriori informazioni, consultare Gestione dei file di chiavi.
   correlation_ID	Facoltativo. L'identificativo univoco utilizzato per tracciare e correlare le transazioni.

   Una richiesta GET /v2/keys riuscita restituisce una raccolta di chiavi disponibili nella tua istanza Hyper Protect Crypto Services.

   {
     "metadata": {
       "collectionType": "application/vnd.ibm.kms.key+json",
       "collectionTotal": 2
     },
     "resources": [
       {
         "id": "02fd6835-6001-4482-a892-13bd2085f75d",
         "type": "application/vnd.ibm.kms.key+json",
         "name": "Root-key",
         "state": 1,
         "crn": "crn:v1:bluemix:public:hs-crypto:us-south:a/f047b55a3362ac06afad8a3f2f5586ea:12e8c9c2-a162-472d-b7d6-8b9a86b815a6:key:02fd6835-6001-4482-a892-13bd2085f75d",
         "createdBy": "...",
         "creationDate": "2020-03-11T16:30:06Z",
         "lastUpdateDate": "2020-03-11T16:30:06Z",
         "algorithmMetadata": {
           "bitLength": "256",
           "mode": "CBC_PAD"
         },
         "extractable": false,
         "imported": true,
         "algorithmMode": "CBC_PAD",
         "algorithmBitSize": 256,
         "dualAuthDelete": {
           "enabled": false
         }
       },
       {
         "id": "2291e4ae-a14c-4af9-88f0-27c0cb2739e2",
         "type": "application/vnd.ibm.kms.key+json",
         "name": "Standard-key",
         "state": 1,
         "crn": "crn:v1:bluemix:public:hs-crypto:us-south:a/f047b55a3362ac06afad8a3f2f5586ea:30372f20-d9f1-40b3-b486-a709e1932c9c:key:2291e4ae-a14c-4af9-88f0-27c0cb2739e2",
         "createdBy": "...",
         "creationDate": "2020-03-12T03:50:12Z",
         "lastUpdateDate": "2020-03-12T03:50:12Z",
         "algorithmMetadata": {
           "bitLength": "256",
           "mode": "CBC_PAD"
         },
         "extractable": true,
         "imported": false,
         "algorithmMode": "CBC_PAD",
         "algorithmBitSize": 256,
         "dualAuthDelete": {
           "enabled": false
         }
       }
     ]
   }
   

   Per impostazione predefinita, GET api/v2/keys restituisce le prime 200 chiavi ma puoi regolare questo limite utilizzando il parametro limit al momento della query. Per ulteriori informazioni sui parametri limit e offset, vedi Richiamo di un sottoinsieme di chiavi.

   Non vedi l'elenco completo di chiavi? Potrebbe essere necessario utilizzare limit e offset o verificare con l'amministratore per assicurarsi che sia stato assegnato l'accesso di livello corretto alle chiavi nella propria istanza. Per ulteriori informazioni, vedi Impossibile visualizzare o elencare le chiavi.

Richiamo di un sottoinsieme di chiavi

Specificando i parametri limit e offset nel momento della query, puoi richiamare un sottoinsieme delle tue chiavi, a partire dal valore di offset che specifichi.

Ad esempio, potresti avere 3000 chiavi totali memorizzate nella tua istanza del servizio Hyper Protect Crypto Services, ma vuoi richiamare le chiavi da 200 a 300 quando effettui una richiesta GET /keys.

Puoi utilizzare la seguente richiesta di esempio per richiamare una diverso insieme di chiavi.

curl -X GET \
  'https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/keys?offset=<offset>&limit=<limit>' \
  -H 'accept: application/vnd.ibm.collection+json' \
  -H 'authorization: Bearer <IAM_token>' \
  -H 'bluemix-instance: <instance_ID>'

Sostituisci le variabili limit e offset nella tua richiesta in base alla seguente tabella.

Per le note di utilizzo, consulta i seguenti esempi per l'impostazione dei parametri di query limit e offset.

L'offset è la posizione di una determinata chiave in un dataset. Il valore di offset è a base zero, il che significa che la decima chiave di crittografia in un dataset è all'offset 9.

Richiamo delle chiavi per stato

Specificando il parametro state al momento della query, è possibile recuperare le chiavi che si trovano negli stati specificati.

Ad esempio, potresti avere delle chiavi nella tua istanza del servizio che si trovano nello stato attivo, sospeso e distrutto, ma vuoi richiamare le chiavi nello stato attivo solo quando effettui una richiesta GET /keys.

Il parametro della query di stato accetta un elenco di numeri interi da 0 a 5 delimitati da virgole senza spazi o virgole finali. Gli stati validi sono basati su NIST SP 800-57. Per ulteriori informazioni sugli stati chiave, vedi Stati chiave e transizioni.

Puoi utilizzare la seguente richiesta di esempio per richiamare una diverso insieme di chiavi.

curl -X GET \
  'https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/keys?state=<state_integers>' \
  -H 'accept: application/vnd.ibm.collection+json' \
  -H 'authorization: Bearer <IAM_token>' \
  -H 'bluemix-instance: <instance_ID>'

Sostituisci la variabile state nella tua richiesta in base alla tabella seguente.

Per le note sull'utilizzo, consulta i seguenti esempi per l'impostazione del tuo parametro di query state.