サービス・エンドポイントの取得
クラスターが公開するサービス・エンドポイントは、サービス・キー(サービス資格情報とも呼ばれます)として使用可能になります。
以下のいずれかの方法でサービス・エンドポイントを取り出すことができます。
サービス・エンドポイントは、インスタンス資格情報を公開しません。 インスタンス資格情報を取得するには、クラスター資格情報の取得を参照してください。
IBM CloudCLIを使用したサービス・エンドポイントの取得
サービス・エンドポイントを取得するには、IBM Analytics Engineサーバーレス・インスタンスのサービス・キーを作成する必要があります。
サービス・リソース・キーを作成するには、次のコマンドを入力します:
ibmcloud resource service-key-create <your_service_key_name> <role> --instance-name <your_service_instance_name>
必須パラメーターは以下のとおりです:
<your_service_instance_name>:クラスターの作成時に指定したサービス・インスタンスの名前。 IBM Cloudリソース・リストを確認して、サービス・インスタンス名を見つけることができます。<your_service_key_name>:鍵に使用したい任意の名前。 この名前は、サービス・キーを取得するために使用されます。<role>:サービス資格情報用に生成されたIAM APIキーに割り当てられた役割。 選択された役割に対して許可されている操作のみを実行できます。 操作を実行するために必要な役割について詳しくは、ユーザーへの許可の付与セクション必要なIAM権限を参照してください。
予期される応答:
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
サービス・リソース・キーを表示するには、次のコマンドを入力します:
ibmcloud resource service-key <service_key_name>
必須パラメーター:
<service key name>:鍵の作成時に入力したサービス・キーの名前。
応答例: クラスター資格情報は応答で返されないことに注意してください。
{
"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"
}
サンプル応答では、endpointsの下のプロパティーでサービス・エンドポイントを指定します。 プロパティー iam_apikey_nameには、IAMベアラー・トークンの生成に使用できるIAM APIキーが含まれています。 IBM Analytics Engineサーバーレス・インスタンス用のREST APIを呼び出すときには、許可のためにIAMベアラー・トークンを提供する必要があります。
IBM CloudREST APIを使用したサービス・エンドポイントの取得
前提条件: IAM ベアラー・トークンが必要です。 詳しくは、IAM アクセス・トークンの取得を参照してください。
API サービス・キーを処理する API エンドポイントは、https://resource-controller.cloud.ibm.com/v1/resource_keys です。
サービス・リソース・キーを作成するには、次のように入力します:
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>"} }'
応答例:
{
"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
}
IBM Cloudコンソールからのサービス・エンドポイントの取得
このセクションの手順に従って、IBM Cloudコンソールを使用してサービス・エンドポイントを取得すると、サービス・インスタンスのサービス資格情報ページが表示されます。このページで、サービス・エンドポイントとAPIキーを確認できます。
IBM Cloudコンソールからサービス・キーを作成するには、以下のようにします:
- リソース・リストに移動し、サービスおよびソフトウェアをクリックして、プロビジョンされたサーバーレス・インスタンスを選択します。
- 左側のバーで**「サービス資格情報」**をクリックします。
- 次に、新規資格情報をクリックして、新しいサービス資格情報を作成します。
- 名前を入力し、役割を選択して、追加をクリックします。
- 資格情報をクリップボードにコピーします。
インスタンス管理エンドポイントおよびアプリケーション管理エンドポイントで使用可能な操作については、API資料 を参照してください。 これらのエンドポイントで操作を呼び出すために必要な許可について詳しくは、ユーザーへの許可の付与を参照してください。