Google Cloud アカウントとプロジェクトが作成され、API が有効になっています。これで、組織を作成できる状態になりました。
前提条件
組織を作成するには、次のいずれかの条件を満たしている必要があります。
- 評価アカウントを持っている。評価アカウントは 60 日後に有効期限が切れます。期限を迎えた時点で削除されます。
- 有料アカウントを保有している
どちらにも該当しない場合は、続行する前に Apigee の販売担当者にお問い合わせください。
新しい組織を作成してプロビジョニングするには:
-
次の例のように、コマンドラインで
gcloud認証情報を取得します。TOKEN=$(gcloud auth print-access-token)
トークンにデータが入力されていることを確認するには、次の例のように
echoを使用します。echo $TOKEN
エンコードされた文字列としてトークンが表示されるはずです。
詳細については、gcloud コマンドライン ツールの概要をご覧ください。
- 認証された
POSTリクエストを Create Organizations API に送信します。次の例は、組織を作成するリクエストの構造を示しています。
curl -H "Authorization: Bearer $TOKEN" -X POST -H "content-type:application/json" \ -d '{ "name":"org_name", "displayName":"display_name", "description":"organization_description", "runtimeType":"runtime_type", "analyticsRegion":"analytics_region" }' \ "https://apigee.googleapis.com/v1/organizations?parent=projects/project_ID"各要素の意味は次のとおりです。
- （必須）org_name は、ハイブリッド対応組織に必要なプログラマティック ID です。組織 ID は、ステップ 2: Google Cloud プロジェクトを作成するで作成した Google Cloud プロジェクト ID と一致する必要があります。例:
hybrid-42 - （必須）runtime_typeは、Apigee 組織のランタイム タイプです。ここで、HYBRID はユーザーが管理する Apigee ハイブリッド ランタイムです。
- （必須）analytics_region は、分析データ ストレージのプライマリ リージョンです。次のいずれかを選択します。
asia-northeast1australia-southeast1us-west1us-central1us-east1europe-west1europe-west2このオプションを使用すると、地理的に近いリージョンを選択できます。また、組織に別のストレージ要件がある場合にも、このオプションを使用できます。
- （必須）project_ID は、新しいハイブリッド対応組織にバインドする Google Cloud プロジェクトです。これは、ステップ 2: Google Cloud プロジェクトを作成するで生成された ID です。
- （省略可）display_name は、ユーザーにわかりやすい組織の名前です。この値は一意である必要はなく、スペースと特殊文字の使用が可能です。たとえば、「My Hybrid Organization」とします。
- （省略可）organization_description は、目的のリマインダーとして使用する組織に関する情報です。たとえば、「My first organization」とします。
作成リクエストが成功すると、Organizations API から次のようなメッセージが返されます。
{ "name": "organizations/organization_ID/operations/long_running_operation_ID", "metadata": { "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata", "operationType": "INSERT", "targetResourceName": "organizations/organization_ID", "state": "IN_PROGRESS" } }各要素の意味は次のとおりです。
- long_running_operation_ID は、非同期の長時間実行オペレーションの UUID です。この ID を使用して、組織作成リクエストのステータスを確認できます（後に説明）。
- organization_ID は、現在作成している新しい組織の ID です。
レスポンスの
stateプロパティが示すように、Apigee は新しい組織の作成を開始したので、状態がIN_PROGRESSになっています。この処理には数分かかることがあります。エラーが発生した場合は、組織作成のトラブルシューティングをご覧ください。
- （必須）org_name は、ハイブリッド対応組織に必要なプログラマティック ID です。組織 ID は、ステップ 2: Google Cloud プロジェクトを作成するで作成した Google Cloud プロジェクト ID と一致する必要があります。例:
- Apigee が最初の作成リクエストで返した ID の長時間実行オペレーションのステータスを確認できます。この操作を行うには、次の例のように Operations API を使用します。
curl -H "Authorization: Bearer $TOKEN" \ "https://apigee.googleapis.com/v1/organizations/organization_ID/operations/long_running_operation_ID"
次の例は、このリクエストに対して考えられるレスポンスを示しています。
FINISHED
組織がプロビジョニングされている場合、次の例のように、長時間実行オペレーションの状態は
FINISHEDになります。{ "operations": [ { "name": "organizations/organization_ID/operations/long_running_operation_ID", "metadata": { "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata", "operationType": "INSERT", "targetResourceName": "organizations/organization_ID", "state": "FINISHED" }, "done": true, "response": { "@type": "type.googleapis.com/google.cloud.apigee.v1.Organization", "name": "organization_ID", "createdAt": "1572550611", "lastModifiedAt": "1572550611", "displayName": "display_name" "description": "description" "properties": { "property": [ { "name": "features.hybrid.enabled", "value": "true" } ] }, "analyticsRegion": "us-east1" "runtimeType": "HYBRID", } } ] }説明を入力しなかった場合、このフィールドはレスポンスに表示されません。
これで完了です。新しい組織が作成され、使用できるようになりました。ステップ 5: 環境を追加するに進みます。
IN_PROGRESS
Apigee がまだ組織を作成している場合、次の例のように、Apigee は
IN_PROGRESSのステータスを返します。{ "name": "organizations/organization_ID/operations/long_running_operation_ID", "metadata": { "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata", "operationType": "INSERT", "targetResourceName": "organizations/organization_ID", "state": "IN_PROGRESS" } }少し待ってから、作成プロセスが完了しているかどうか確認します。
組織作成のトラブルシューティング
Create Organizations API で組織を作成するときに、エラー レスポンスが返されることがあります。レスポンスは、次のような形式です。
{
"error": {
"code": HTTP_error_code,
"message": "short_error_message",
"status": "high_level_error_type",
"details": [
{
"@type": "specific_error_type",
"detail": "expanded_error_description"
}
]
}
}
次の例は、組織 ID に無効な文字が含まれている場合に返される一般的なエラー レスポンスを示しています（組織 ID には大文字を使用できません）。
{
"error": {
"code": 400,
"message": "invalid Organization ID \"MY-ORG\": \"MY-ORG\" is an invalid Organization ID",
"status": "INVALID_ARGUMENT",
"details": [
{
"@type": "type.googleapis.com/google.rpc.DebugInfo",
"detail": "[ORIGINAL ERROR] generic::invalid_argument: invalid Organization ID \"MY-ORG\":
\"My-ORG\" is an invalid Organization ID [google.rpc.error_details_ext]
{ message: \"invalid Organization ID \\\"MY-ORG\\\": \\\"MY-ORG\\\" is an invalid
Organization ID\" }"
}
]
}
}
この場合、組織の名前を小文字に変更してリクエストを再送信できます。
次の表に、新しい組織の作成時に表示される可能性のあるエラーとその解決方法を示します。
| HTTP エラーコード | HTTP エラー | 説明 |
|---|---|---|
400 |
Invalid JSON payload received |
リクエスト内のデータ構造に構文エラーがあります。あるいは、エンドポイントのパスが正しくありません。 |
400 |
Invalid organization ID |
リクエストする組織 ID に大文字は使用できません。また、ハイフン以外の特殊文字も使用できません。小文字、数字、ハイフンのみで構成される必要があります。長さは 32 文字以下にする必要があります。 |
400 |
Unsupported analytics region |
リクエストの本文で analyticsRegion の値が指定されていないか、指定された値が有効なオプションではありません。 |
400 |
Does not have an Apigee entitlement |
ステップ 2: Google Cloud プロジェクトを作成するで作成した Google Cloud プロジェクトが、まだハイブリッド対応になっていません。請求に関する問題や、Google Cloud アカウントに関連するその他のエラーが発生している可能性があります。詳しくは、Apigee セールスチームまでお問い合わせください。 |
401 |
Request had invalid authentication credentials |
gcloud 認証トークンが無効か、古くなっています。あるいは、リクエストに含まれていません。新しいトークンを生成し、アドレスを再送信します。 |
403 |
Permission denied on resource project project_ID |
無効なプロジェクト ID またはパスが含まれるリクエストが送信された可能性があります。 |
403 |
Unable to retrieve project information |
組織が作成されていないか、プロビジョニングされていません。Operations API にリクエストを送信すると、長時間実行オペレーションのステータスを確認できます（前述の手順を参照）。 |
409 |
Organization already exists |
Google Cloud プロジェクトに複数の組織を作成しようとしました。1 つのプロジェクトに作成できる組織は 1 つのみです。 |
409 |
Org proposed_organization_ID already exists |
既存の ID と同じ ID で組織を作成しようとしました。組織 ID はすべてのハイブリッド ユーザーの間で一意にする必要があります。提案された新しい組織 ID で再送信します。たとえば、前に試した ID の末尾に数値を追加します。 |
組織情報を取得する
アカウントでアクセスできるすべての組織のリストを取得することも、特定の組織に関する詳細を ID で取得することもできます。これらのアクションを行うには、Organizations API を使用します。
組織を一覧表示する
すべての組織のリストを取得するには:
GET リクエスト（本文なし）を次の List Organizations API エンドポイントに送信します。
https://apigee.googleapis.com/v1/organizations
次に例を示します。
curl -H "Authorization: Bearer $TOKEN" "https://apigee.googleapis.com/v1/organizations"
リクエストのレスポンスでは、アクセス可能なハイブリッド対応組織の配列が JSON 形式で返されます。
次の例は、「my-org-42」という組織を含むレスポンスです。
{
"organizations": [
{
"organization": "my-org-42",
"projectIds": [
"my-project"
]
}
]
}
詳細を取得する
1 つの組織に関する詳細情報を取得するには:
GET リクエスト（本文なし）を次の Get Organizations API エンドポイントに送信します。
https://apigee.googleapis.com/v1/organizations/organization_ID
次の例では、「my-org-42」という組織に関する詳細を取得します。
curl -H "Authorization: Bearer $TOKEN" "https://apigee.googleapis.com/v1/organizations/my-org-42"
リクエストのレスポンスでは、指定した組織に関する詳細情報が JSON 形式で返されます。
次の例は、「my-org-42」という組織に関する詳細を含むレスポンスを示しています。
{
"name": "my-org-42",
"createdAt": "1572550611",
"lastModifiedAt": "1572550611",
"environments": [
"my-environment"
],
"analyticsRegion": "us-east1"
}