查看 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}
。這個值會以 查看全部或特定停權開發人員時,請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 取消暫停開發人員
向 下列資源:/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 ,則會傳回 prodId 。
依查看使用 API 的所有已停權開發人員和使用 API 查看停權開發人員的說明,查看所有或特定停權的開發人員。 |
舉例來說,下列 cURL 呼叫會為具有 ID 的開發人員解除暫停狀態
API 產品 myorg@@@myproduct
的 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 |
已達最終音量頻帶的設定上限。 |