Richiamo endpoint del servizio

Gli endpoint di servizio che il cluster espone sono messi a vostra disposizione come chiavi di servizio (note anche come credenziali di servizio).

È possibile recuperare gli endpoint di servizio da:

Gli endpoint di servizio non espongono le credenziali dell'istanza. Per ottenere le credenziali dell'istanza, consultare Richiamare le credenziali del cluster.

Ottenimento degli endpoint di servizio utilizzando la CLI IBM Cloud

È necessario creare un tasto di servizio per l'istanza IBM Analytics Engine serverless per ottenere gli endpoint di servizio.

Per creare una chiave di risorsa di servizio, inserire il seguente comando:

ibmcloud resource service-key-create <your_service_key_name> <role> --instance-name <your_service_instance_name>

I parametri obbligatori includono:

  • <your_service_instance_name>: il nome dell'istanza di servizio specificata quando si crea il cluster. Puoi controllare il tuo elenco di risorse IBM Cloud per trovare i nomi dell'istanza di servizio.
  • <your_service_key_name>: qualsiasi nome che si desidera utilizzare per la chiave. Questo nome viene utilizzato per richiamare le chiavi di servizio.
  • <role>: il ruolo assegnato alla chiave API IAM generata per le credenziali di servizio. Sarà possibile eseguire solo quelle operazioni consentite per il ruolo scelto. Per ulteriori dettagli sui ruoli richiesti per eseguire un'operazione, fare riferimento alla sezione permessi IAM obbligatori in Concessione dei permessi agli utenti.

Risposta prevista:

Creating service key of service instance <service_instance_name> under account <your account name> as <your user name>...
OK
Service key <service key crn> was created.
Name:          service-key-name
ID:            crn:v1:staging:public:ibmanalyticsengine:us-south:a/d628eae2cxxxxx229f2xxxx:1671b660-xxxx-448f-xxx-e1633a2b97c7:resource-key:4f1b043c-xxxx-xxxx-xxxx-cbf90f6155d0
Created At:    Mon Nov 29 11:47:32 UTC 2021
State:         active
Credentials:
               apikey:                   xxxxxx
               endpoints:
                                         applications_api:   https://api-staging.us-south.ae.cloud.ibm.com/v3/analytics_engines/xxxx660-7f2x-4xxf-9xx4-exxxxxxxxxc7/spark_applications
                                         instance_api:       https://api-staging.us-south.ae.cloud.ibm.com/v3/analytics_engines/xxxx660-7f2x-4xxf-9xx4-exxxxxxxxxc7
					 history_server_ui:  https://spark-console.us-south.ae.cloud.ibm.com/v3/analytics_engines/xxxx660-7f2x-4xxf-9xx4-exxxxxxxxxc7/spark_history_ui
					 history_server_api: https://spark-console.us-south.ae.cloud.ibm.com/v3/analytics_engines/xxxx660-7f2x-4xxf-9xx4-exxxxxxxxxc7/spark_history_api/v1

               iam_apikey_description:   Auto-generated for key 4f1xxx3c-7517-xxx-cbfxxxxxx5d0
               iam_apikey_name:          service-key-name
               iam_role_crn:             crn:v1:bluemix:public:iam::::serviceRole:Writer
               iam_serviceid_crn:        crn:v1:staging:public:iam-identity::a/xxxx::serviceid:ServiceId-3543db7f-xxxx-454a-xxxx-1b20333ebeaa

Per visualizzare il tasto della risorsa di servizio, inserire il seguente comando:

ibmcloud resource service-key <service_key_name>

Parametro obbligatorio:

  • <service key name>: il nome della chiave di servizio immessa quando si crea la chiave.

Risposta del campione: Orso in mente che le credenziali del cluster non vengono restituite nella risposta.

{
  "apikey": "xxxxx",
  "endpoints": {
    "applications_api": "https://api.us-south.ae.cloud.ibm.com/v3/analytics_engines/xxxx-3bxxxbc-4xxx1-axx6-8xxdxx0xxd/spark_applications",
    "instance_api": "https://api.us-south.ae.cloud.ibm.com/v3/analytics_engines/xxxx-3bxxxbc-4xxx1-axx6-8xxdxx0xxd",
    "history_server_ui": "https://spark-console.us-south.ae.cloud.ibm.com/v3/analytics_engines/xxxx-3bxxxbc-4xxx1-axx6-8xxdxx0xxd/spark_history_ui",
    "history_server_api":"https://spark-console.us-south.ae.cloud.ibm.com/v3/analytics_engines/xxxx-3bxxxbc-4xxx1-axx6-8xxdxx0xxd/spark_history_api/v1"
  },
  "iam_apikey_description": "Auto-generated for key cabde209-xxxx",
  "iam_apikey_name": "Service credentials-1",
  "iam_role_crn": "crn:v1:bluemix:public:iam::::serviceRole:Reader",
  "iam_serviceid_crn": "crn:v1:bluemix:public:iam-identity::a/xxxxx::serviceid:ServiceId-2fec11aa-xxxx-4918-xxxx-aa3650f99050"
}

Nella risposta del campione, le proprietà sotto endpoints specificano gli endpoint di servizio. La proprietà iam_apikey_name contiene una chiave API IAM che può essere utilizzata per generare token di IAM bearer. È necessario fornire un token di battente IAM per l'autorizzazione quando si richiama le API REST per IBM Analytics Engine istanze serverless.

Ottenimento degli endpoint di servizio utilizzando l'API REST di IBM Cloud

Prerequisito: Hai bisogno di un token IAM bearer. Per ulteriori informazioni, consultare Richiamo token di accesso IAM.

L'endpoint API che gestisce le chiavi di servizio delle API è https://resource-controller.cloud.ibm.com/v1/resource_keys.

Per creare una chiave di risorsa di servizio, inserire:

curl -X POST \
  https://resource-controller.cloud.ibm.com/v1/resource_keys \
  -H 'accept: application/json' \
  -H "authorization: Bearer <IAM bearer token>" \
  -H 'content-type: application/json' \
  -d '{"name":"<key name>","source_crn":"<service instance crn>", "parameters":{"role_crn":"<crn of access role>"} }'

Risposta del campione:

{
	"id": "crn:v1:staging:public:ibmanalyticsengine:us-south:a/d628eae2cxxxxx229f2xxxx:79c757e9-xxxx-xxxx-xxxx-dff7f01xxxx:resource-key:2278xxxx-xxxx-xxxx-xxxx-59a6da6xxxxe",
	"guid": "2278xxxx-xxxx-xxxx-xxxx-59a6da68xxxx",
	"url": "/v1/resource_keys/crn%3Av1%3Astaging%3Apublic%3Aibmanalyticsengine%3Aus-south%3Aa%2Fd628eae2cxxxxx229f2xxxx%3A79c757e9-xxxx-xxxx-xxxx-dff7f01xxxx%3Aresource-key%3A2278xxxx-xxxx-xxxx-xxxx-59a6da6xxxxe",
	"created_at": "2021-11-30T08:48:47.909145179Z",
	"updated_at": "2021-11-30T08:48:47.909145179Z",
	"deleted_at": null,
	"created_by": "",
	"updated_by": "",
	"deleted_by": "",
	"source_crn": "crn:v1:staging:public:ibmanalyticsengine:us-south:a/d628eae2cxxxxx229f2xxxx:79c757e9-xxxx-xxxx-xxxx-dff7f01xxxx::",
	"name": "service_key_02",
	"role": "crn:v1:bluemix:public:iam::::serviceRole:Writer",
	"crn": "crn:v1:staging:public:ibmanalyticsengine:us-south:a/d628eae2cxxxxx229f2xxxx:79c757e9-xxxx-xxxx-xxxx-dff7f01xxxx:resource-key:2278xxxx-xxxx-xxxx-xxxx-59a6da6xxxxe",
	"state": "active",
	"account_id": "d628eae2cxxxxx229f2xxxx",
	"resource_group_id": "65828fxxxx594594816e872xxxx",
	"resource_id": "18dexxxx-xxxx-xxxx-xxxx-0ed2f93fxxxx",
	"credentials": {
		"apikey": "xxxxx",
		"endpoints": {
			"applications_api": "https://api-staging.us-south.ae.cloud.ibm.com/v3/analytics_engines/79c757e9-xxxx-xxxx-xxxx-dff7f01xxxx/spark_applications",
			"instance_api": "https://api-staging.us-south.ae.cloud.ibm.com/v3/analytics_engines/79c757e9-xxxx-xxxx-xxxx-dff7f01xxxx",
			"history_server_ui": "https://spark-console.us-south.ae.cloud.ibm.com/v3/analytics_engines/79c757e9-xxxx-xxxx-xxxx-dff7f01xxxx/spark_history_ui",
			"history_server_api":"https://spark-console.us-south.ae.cloud.ibm.com/v3/analytics_engines/79c757e9-xxxx-xxxx-xxxx-dff7f01xxxx/spark_history_api/v1"
		},
		"iam_apikey_description": "Auto-generated for key 2278e09d-b815-4c4b-b824-xxxx",
		"iam_apikey_name": "service_key_02",
		"iam_role_crn": "crn:v1:bluemix:public:iam::::serviceRole:Writer",
		"iam_serviceid_crn": "crn:v1:staging:public:iam-identity::a/d628eae2cxxxxx229f2xxxx::serviceid:ServiceId-209exxxx-xxxx-xxxx-xxxx-4ab9ce16xxxx"
	},
	"iam_compatible": true,
	"migrated": false,
	"resource_instance_url": "/v1/resource_instances/crn%3Av1%3Astaging%3Apublic%3Aibmanalyticsengine%3Aus-south%3Aa%2Fd628eae2cxxxxx229f2xxxx%3A79c757e9-xxxx-xxxx-xxxx-dff7f01xxxx%3A%3A",
	"resource_alias_url": null
}

Ottenimento degli endpoint di servizio dalla console IBM Cloud

Seguendo le istruzioni riportate in questa sezione per ottenere gli endpoint di servizio utilizzando la console IBM Cloud, si viene indirizzati alla pagina delle credenziali di servizio per l'istanza di servizio in cui ci si aspetta di vedere endpoint di servizio e chiave API.

Per creare un tasto di servizio dalla console IBM Cloud:

  1. Vai al tuo elenco risorse, fare clic su Servizi e software e selezionare l'istanza serverless provisioned.
  2. Fare clic su credenziali di servizio nella barra laterale sinistra.
  3. Quindi fare clic su Nuova credenziale per creare nuove credenziali di servizio.
  4. Inserire un nome, selezionare un ruolo e fare clic su Aggiungi.
  5. Copiare le credenziali negli appunti.

Consultare la documentazione API per le operazioni che sono disponibili sugli endpoint di gestione dell'istanza e della gestione delle applicazioni. Per i dettagli sulle autorizzazioni necessarie per richiamare le operazioni su quegli endpoint, consultare Concessione dei permessi agli utenti.