您正在查看 Apigee Edge 說明文件。
查看 Apigee X 說明文件。 資訊
「營利」機制提供一組 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}
。按照使用 API 查看所有停權開發人員和使用 API 查看已停權的開發人員時,查看全部或特定遭停權的開發人員時,系統會傳回這個值。prodId
舉例來說,以下 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}
。當您按照檢視所有遭到停權的開發人員和使用 API 查看已停權的開發人員時,系統會傳回這個值,devId
會傳回此值。
您也可以選擇傳送下列查詢參數:
查詢參數 | 說明 |
---|---|
suspendedProduct_id |
API 產品的 ID,格式如下:{org_id}@@@{product_id} 。當您按照檢視所有遭到停權的開發人員和使用 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 |
已達最終音量頻帶的設定上限。 |