組織から収益化データを削除する

Apigee Edge のドキュメントを表示しています。
Apigee X のドキュメントに移動します。 情報

はじめに

次のような場合は、組織の収益化データを削除することをおすすめします。

  • 再利用するテスト組織から収益化データを削除します。この場合は、収益化データを削除した後に Apigee Edge データを同期する必要があります。
  • 組織を削除します。この場合、組織を削除する前に収益化データを削除する必要があります。

組織から収益化データを削除すると、次のデータが完全に削除されます。

  • API パッケージ
  • 料金プラン
  • デベロッパーが料金プランを承諾した
  • 収益化トランザクション
  • 通知テンプレート
  • サードパーティの支払いプロバイダ（設定されている場合）

以降のセクションでは、上記のシナリオをサポートするために、組織から収益化データを削除するために必要な手順について説明します。

組織の収益化データの削除を有効にする

組織から収益化データを削除するには、組織の 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"
}

非同期削除オペレーションのステータスを表示する

非同期削除オペレーションのステータスを表示するには、/asyncjobs/{id} に GET リクエストを発行します。ここで、{id} はレスポンスで返された削除オペレーションの ID です。

たとえば、次のリクエストは、ID が c6eaa22d-27bd-46cc-be6f-4f77270818cf の非同期削除オペレーションのステータスを表示します。

curl -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/myOrg/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 データを収益化と同期させる必要があります。

組織の削除

組織が不要になった場合は、組織を削除するの説明に従って、収益化データを削除してから組織を削除できます。