取消暂停开发者

您正在查看 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 的 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 已达到最终音量段的配置上限。