為開發人員解除停權狀態

您目前查看的是 Apigee Edge 說明文件。
前往 Apigee X 說明文件。 info

如要使用 Monetization API 取消先前遭停權開發人員的停權處分，請參閱下列章節。如果達到設定的上限，開發人員可能會遭到停權。例如，交易次數已達上限，或是預付帳戶餘額不足。如需完整的原因代碼清單，請參閱「遭停權開發人員的原因代碼摘要」。

使用 API 查看所有遭到停權的開發人員

如要查看機構中所有遭停權的開發人員，請對下列資源發出 GET 要求：/organizations/{org_name}/suspended-developers。

其中：

  • {org_name} 指定機構名稱。

舉例來說，下列 cURL 呼叫會列出 myorg 的所有遭停權開發人員：

curl -H "Content-Type: application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/suspended-developers" \
-u email:password

以下提供回應範例：

[
  {
    "creationDate": 1464388723633,
    "devId": "myorg@@@6Vro7VnjUhpGVn3p",
    "id": "myorg-myorg@@@6Vro7VnjUhpGVn3p-myorg@@@myproduct-null-RATE_PLAN_RATE_BAND_EXCEEDED",
    "message": "mint.productHasBeenSuspended for myorg@@@6Vro7VnjUhpGVn3p myorg@@@myproduct due to RATE_PLAN_RATE_BAND_EXCEEDED",
    "orgId": "myorg",
    "prodId": "myorg@@@myproduct",
    "reasonCode": "RATE_PLAN_RATE_BAND_EXCEEDED"
  },
  {
    "creationDate": 1464022846293,
    "devId": "myorg@@@vXh7LXxtUy9COVdy",
    "id": "myorg-myorg@@@vXh7LXxtUy9COVdy-myorg@@@myproduct-null-NO_CURRENT_PUBLISHABLE_ENTITY",
    "message": "mint.productHasBeenSuspended for myorg@@@vXh7LXxtUy9COVdy myorg@@@myproduct due to mint.noCurrentPublishableEntity",
    "orgId": "myorg",
    "prodId": "myorg@@@myproduct",
    "reasonCode": "NO_CURRENT_PUBLISHABLE_ENTITY"
  }
]

使用 API 查看遭停權的開發人員

如要查看機構遭停權的開發人員，請對下列資源發出 GET 要求：/organizations/{org_name}/suspended-developers/{developer_email_or_id}。

其中：

  • {org_name} 指定機構名稱。
  • {developer_email_or_id} 指定開發人員 ID。如要查看開發人員清單，請參閱「列出開發人員」。

舉例來說，下列 cURL 呼叫會列出遭停權開發人員 joe@example.com 的詳細資料：

curl -H "Content-Type: application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/suspended-developers/joe@example.com" \
-u email:password

以下提供回應範例：

[
  {
    "creationDate": 1464388723633,
    "devId": "myorg@@@6Vro7VnjUhpGVn3p",
    "id": "myorg-myorg@@@6Vro7VnjUhpGVn3p-myorg@@@myproduct-null-RATE_PLAN_RATE_BAND_EXCEEDED",
    "message": "mint.productHasBeenSuspended for myorg@@@6Vro7VnjUhpGVn3p myorg@@@myproduct due to RATE_PLAN_RATE_BAND_EXCEEDED",
    "orgId": "myorg",
    "prodId": "myorg@@@myproduct",
    "reasonCode": "RATE_PLAN_RATE_BAND_EXCEEDED"
  }
]

使用 API 為 API 產品解除所有開發人員的停權狀態

如要解除所有因 API 產品遭停權的開發人員，請對下列資源發出 POST 要求： /organizations/{org_name}/suspended-developers/unsuspend-by-product/{suspendedProduct_id}。

其中：

舉例來說，下列 cURL 呼叫會取消暫停 API 產品 myorg@@@myproduct 的所有開發人員：

curl -H "Content-Type: application/json" -X POST \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/suspended-developers/unsuspend-by-product/myorg@@@myproduct" \
-u email:password

使用 API 取消開發人員停權處分

如要解除特定開發人員的停權處分，請對下列資源發出 DELETE 要求：/organizations/{org_name}/suspended-developers/{suspendedDev_id}。

其中：

您可以選擇傳遞下列查詢參數：

查詢參數 說明
suspendedProduct_id API 產品的 ID，格式類似於： {org_id}@@@{product_id}。如「使用 API 查看所有遭停權的開發人員」和「使用 API 查看遭停權的開發人員」所述，當您查看所有或特定遭停權的開發人員時，系統會將這個值傳回為 prodId。

舉例來說，下列 cURL 呼叫會取消暫停 API 產品 myorg@@@myproduct 的開發人員 (ID 為 myorg@@@6Vro7VnjUhpGVn3p)：

curl -H "Content-Type: application/json" -X DELETE \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/suspended-developers/myorg@@@6Vro7VnjUhpGVn3p?productId=myorg@@@myproduct" \
-u email:password

遭停權開發人員的原因代碼摘要

下表列出開發人員遭停權的原因代碼。

原因代碼 說明
INSUFFICIENT_FUNDS 開發人員帳戶的餘額已用盡。
LIMIT_VIOLATED 開發人員帳戶已達設定上限。
NO_CURRENT_PUBLISHABLE_ENTITY 開發人員尚未接受 (訂閱) 費率方案。
RATE_PLAN_RATE_BAND_EXCEEDED 已達最終音量範圍的設定上限。