サーバーレス・インスタンスの詳細の取得

インスタンスの詳細から、インスタンスID(またはGUID)や IBM Analytics Engineサーバーレス・インスタンスのプロビジョニング状態などの情報を取得できます。 SparkアプリケーションREST APIおよびLivyバッチAPIを使用するには、インスタンスIDが必要です。

以下の方法で詳細を取得できます:

IBM Cloud CLI の使用
IBM Cloud REST API の使用

IBM CloudCLIを使用したインスタンス詳細へのアクセス

インスタンスの詳細を取得するには、以下のようにします:

作成されたサーバーレス・インスタンスをすべてリストします:
```
$ ibmcloud resource service-instances --service-name ibmanalyticsengine
```
この呼び出しは、アカウントのすべてのロケーションにあるすべてのリソース・グループ内のタイプservice_instanceのインスタンスを取得します。

応答の例:
```
Name                  Location   State    Type               Resource Group ID
serverless-instance   us-south   active   service_instance   65xxxxxxxxxxxxxxxa3fd
```
インスタンスのサーバー・インスタンス名を指定して以下のコマンドを入力し、インスタンスの詳細を表示します:
```
$ ibmcloud resource service-instance "Analytics Engine-xyz"
```
これにより、アカウントのリソース・グループからインスタンスが取得されます。

応答の例:
```
Name:                  Analytics Engine-xyz
ID:
crn:v1:staging:public:ibmanalyticsengine:us-south:a/XXXXX:XXXXX::
GUID:                  XXXXX
Location:              us-south
Service Name:          ibmanalyticsengine
Service Plan Name:     standard-serverless-spark
Resource Group Name:   Default
State:                 active
Type:                  service_instance
Sub Type:
Created at:            2021-01-06T07:49:12Z
Created by:            XXXXX
Updated at:            2021-01-06T07:51:01Z
Last Operation:
                       status    create succeeded
                       Message   Started create instance operation
```
応答には、インスタンスのGUIDとプロビジョニング状態が含まれます。

返された状態create succeededは、プロビジョン要求が正常に受け入れられたことを示していることに注意してください。ただし、アプリケーションを実行するには、インスタンスが active状態に移行する必要があります。インスタンスに対して操作を実行する前に、インスタンスの作動可能状況を追跡します。インスタンスの作動可能状況の追跡を参照してください。

IBM CloudREST APIを使用したインスタンス詳細へのアクセス

例えば、インスタンスのGUIDやプロビジョニング状態などのインスタンスの詳細を取得するには、IBM Analytics Engineサーバーレス・インスタンスのIDが必要です。

インスタンスの詳細を取得するには、以下のようにします:

アカウントのリソース・グループ内に作成されたサーバーレス・インスタンスをすべてリストします:

GET <resource-controller-url>/v2/resource_instances

要求の例:

curl -X GET https://resource-controller.cloud.ibm.com/v2/resource_instances? resource_plan_id=8afxxxx-xxxx-xxxx-xxxx-946d843xxxx -H "Authorization: Bearer <>" \

応答の例:

{
	"rows_count": 1,
	"next_url": null,
	"resources": [{
		"id": "crn:v1:staging:public:ibmanalyticsengine:us-south:a/d628eae2ccxxxx3bb0c9dxxxx:da82xxxx-xxxx-xxxx-xxxx-d0faf90exxxx::",
		"guid": "da82xxxx-xxxx-xxxx-xxxx-d0faf90exxxx",
		"url": "/v2/resource_instances/da82xxxx-xxxx-xxxx-xxxx-d0faf90exxxx",
		"created_at": "2021-08-05T11:05:51.545526066Z",
		"updated_at": "2021-11-04T05:11:30.966202521Z",
		"deleted_at": null,
		"created_by": "IBMid-661002042N",
		"updated_by": "",
		"deleted_by": "",
		"scheduled_reclaim_at": null,
		"restored_at": null,
		"scheduled_reclaim_by": "",
		"restored_by": "",
		"name": "serverless-instance",
		"region_id": "us-south",
		"account_id": "d628eae2ccxxxx3bb0c9dxxxx",
		"reseller_channel_id": "",
		"resource_plan_id": "8afxxxx-xxxx-xxxx-xxxx-946d843xxxx",
		"resource_group_id": "65828fxxxx594594816exxx",
		"resource_group_crn": "crn:v1:staging:public:resource-controller::a/d628eae2ccxxxx3bb0c9dxxxx::resource-group:65828fxxxx594594816exxx",
		"target_crn": "crn:v1:staging:public:globalcatalog::::deployment:8afxxxx-xxxx-xxxx-xxxx-946d843xxxx%3Aus-south",
		"parameters": {
			"default_config": {
				"spark.driver.cores": "1",
				"spark.driver.memory": "512m",
				"spark.executor.cores": "1",
				"spark.executor.instances": "1"
			},
			"default_runtime": {
				"additional_packages": ["parquet-modular-encryption"],
				"spark_version": "3.0.0"
			},
			"instance_home": {
				"endpoint": "s3.direct.us-south.cloud-object-storage.appdomain.cloud",
				"guid": "902xxxx-xxxx-xxxx-xxxx-4127da8xxxx",
				"hmac_access_key": "xxxxxxxxx",
				"hmac_secret_key": "xxxxxxxx",
				"provider": "ibm-cos",
				"region": "us-south",
				"type": "objectstore"
			},
			"service-endpoints": "public"
		},
		"allow_cleanup": false,
		"crn": "crn:v1:staging:public:ibmanalyticsengine:us-south:a/d628eae2ccxxxx3bb0c9dxxxx:da82xxxx-xxxx-xxxx-xxxx-d0faf90exxxx::",
		"state": "active",
		"type": "service_instance",
		"resource_id": "18dexxxx-xxxx-xxxx-xxxx-0ed2f9xxxx",
		"dashboard_url": null,
		"last_operation": {
			"type": "delete",
			"state": "failed",
			"async": false,
			"description": "[500, Internal Server Error] The request could not be processed. Try again later."
		},
		"resource_aliases_url": "/v2/resource_instances/da82xxxx-xxxx-xxxx-xxxx-d0faf90exxxx/resource_aliases",
		"resource_bindings_url": "/v2/resource_instances/da82xxxx-xxxx-xxxx-xxxx-d0faf90exxxx/resource_bindings",
		"resource_keys_url": "/v2/resource_instances/da82xxxx-xxxx-xxxx-xxxx-d0faf90exxxx/resource_keys",
		"plan_history": [{
			"resource_plan_id": "8afxxxx-xxxx-xxxx-xxxx-946d843xxxx",
			"start_date": "2021-08-05T11:05:51.545526066Z",
			"requestor_id": "IBMid-661002042N"
		}],
		"migrated": false,
		"controlled_by": "",
		"locked": false
	}]}

許可ベアラー・アクセス・トークンの取得方法については、 IAMアクセス・トークンの取得を参照してください。

応答内の"resources"配列でインスタンス名を検索します。その時、"name"パラメーターを確認します。応答には、インスタンスのGUIDとプロビジョニング状態が含まれます。 APIの応答について詳しくは、すべてのリソース・インスタンスのリストの取得を参照してください。

返された状態create succeededは、プロビジョン要求が正常に受け入れられたことを示していることに注意してください。ただし、アプリケーションを実行するには、インスタンスが active状態に移行する必要があります。インスタンスに対して操作を実行する前に、インスタンスの作動可能性を追跡します。インスタンスの作動可能状況の追跡を参照してください。