現在、Apigee Edge のドキュメントを表示しています。
Apigee X のドキュメントをご確認ください。 情報
はじめに
次のような場合は、組織から収益化データを削除することをおすすめします。
- 再利用したいテスト組織の収益化データを削除します。この場合、収益化データを削除した後に Apigee Edge データを同期する必要があります。
- 組織を削除します。この場合、組織を削除する前に収益化データを削除する必要があります。
組織から収益化データを削除すると、次のデータが完全に削除されます。
- API パッケージ
- 料金プラン
- デベロッパー承認の料金プラン
- 収益化トランザクション
- 通知テンプレート
- サードパーティの決済機関(構成されている場合)
以降のセクションでは、上記のシナリオをサポートするために、収益化データを組織から削除するために必要な手順について説明します。
- 組織からの収益化データの削除を有効にする
- 収益化データの削除
- 非同期削除オペレーションのステータスの表示
- Apigee Edge データと収益化の同期(組織を再利用する場合)
- 組織の削除(組織が不要になった場合)
組織からの収益化データの削除を有効にする
組織から収益化データを削除するには、組織の features.isMintOrgDataDeletionAllowed
プロパティを有効にする必要があります。
このプロパティを有効にするには、https://api.enterprise.apigee.com/v1/organizations/org_name
API に対して POST
呼び出しを発行します。org_name
は組織の名前です。
curl -u email:password -X POST -H "Content-type:application/json" https://api.enterprise.apigee.com/v1/organizations/{org_name} -d \ '{ "name" : "{org_name}", "properties" : { "property" : [ { "name" : "features.isMintOrgDataDeletionAllowed", "value" : "true" }, { "name" : "features.topLevelDevelopersAreCompanies", "value" : "false" } ] } }'
収益化データの削除
収益化データを組織から削除するには、/organizations/org_name/asyncjobs/deleteorgdata
に POST リクエストを発行します。ここで、org_name
は組織の名前です。
たとえば、次のリクエストでは、myOrg
組織から収益化データを削除します。
curl -H "Content-Type:application/json" -X POST \ "https://api.enterprise.apigee.com/v1/mint/organizations/myOrg/asyncjobs/deleteorgdata" \ -u email:password
レスポンスは次のようになります。
{ "id": "c6eaa22d-27bd-46cc-be6f-4f77270818cf", "log": "", "orgId": "myOrg", "status": "RUNNING", "type": "DELETE_ORG" }
非同期削除オペレーションのステータスの表示
非同期削除オペレーションのステータスを表示するには、GET
リクエストを /asyncjobs/{id}
に送信します。ここで、{id}
はレスポンスで返された削除オペレーションの ID です。
たとえば、次のリクエストでは、ID が c6eaa22d-27bd-46cc-be6f-4f77270818cf
の非同期削除オペレーションのステータスが表示されます。
curl -X GET \ "https://api.enterprise.apigee.com/v1/mint/asyncjobs/c6eaa22d-27bd-46cc-be6f-4f77270818cf" \ -u email:password
レスポンスは次のようになります。
{ "id": "c6eaa22d-27bd-46cc-be6f-4f77270818cf", "log": "", "orgId": "myOrg", "status": "COMPLETED", "type": "DELETE_ORG" }
Apigee Edge データを収益化と同期させる
組織を再利用する場合は、Apigee Edge データを収益化と同期させるの説明に従って、Apigee Edge データを収益化と同期する必要があります。
組織の削除
組織が不要になった場合は、収益化データを削除した後に、組織の削除の説明に従って組織を削除できます。