您正在查看 Apigee Edge 說明文件。
前往 Apigee X 說明文件。info
營利功能提供一組 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 產品解除所有開發人員的停權
向下列資源發出 POST 要求，藉此解除停用 API 產品的所有開發人員：/organizations/{org_name}/suspended-developers/unsuspend-by-product/{suspendedProduct_id}。
在此情況下：
{org_name}會指定機構名稱。{suspendedProduct_id}會使用類似以下格式指定 API 產品的 ID：{org_id}@@@{product_id}。查看所有或特定已停權的開發人員時，系統會將這個值傳回為prodId，如查看使用 API 的所有已停權開發人員和使用 API 查看已停權的開發人員。
舉例來說，下列 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}。
在此情況下：
{org_name}可指定機構名稱。{suspendedDev_id}會指定已停權開發人員的 ID，格式如下：{org_id}@@@{dev_id}。查看所有或特定已停權的開發人員時，系統會將這個值傳回為devId，如「查看使用 API 的所有已停權開發人員」和「使用 API 查看已停權的開發人員」。
您可以選擇傳遞下列查詢參數：
| 查詢參數 | 說明 |
|---|---|
suspendedProduct_id |
API 產品 ID，格式類似下列格式：{org_id}@@@{product_id}。查看所有或特定已停權的開發人員時，系統會將這個值傳回為 prodId，如「查看使用 API 的所有已停權開發人員」和「使用 API 查看已停權的開發人員」。 |
舉例來說，下列 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 |
已達最終音量頻帶的設定限制。 |