取消暂停开发者

您正在查看的是 Apigee Edge 文档。
转到 Apigee X 文档
信息

创收功能提供了一组 API,可用于解除之前被暂停的开发者的暂停状态,如以下部分所述。如果达到配置的限制,开发者可能会被暂停。例如,交易数量已达到上限,或者预付款帐号的余额已用尽。如需查看原因代码的完整列表,请参阅暂停开发者的原因代码摘要

使用 API 查看所有已暂停的开发者

向以下资源发出 GET 请求,以查看组织中所有已暂停的开发者:/organizations/{org_name}/suspended-developers

其中:

  • {org_name} 指定组织的名称。

例如,以下 c网址 调用列出了 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。如需查看开发者列表,请参阅列出开发者

例如,以下 c网址 调用列出了已暂停的开发者 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 产品

向以下资源发出 POST 请求,从而解除暂停因 API 产品而被暂停的所有开发者:/organizations/{org_name}/suspended-developers/unsuspend-by-product/{suspendedProduct_id}

其中:

例如,以下 c网址 调用会取消暂停 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} 的格式。当您查看所有或特定的已暂停开发者时,此值将以 prodId 的形式返回,如使用 API 查看所有已暂停的开发者使用 API 查看已暂停的开发者中所述。

例如,以下 c网址 调用会为 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 已达到最终的音量带的上限。