取消暂停开发者

您正在查看 Apigee Edge 文档。
转到 Apigee X 文档
info

通过创收功能,您可以使用一组 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 产品的所有开发者

如需取消暂停因 API 产品而被暂停的所有开发者,请向以下资源发出 POST 请求 : /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 已达到最终交易量范围的配置限制。