<ph type="x-smartling-placeholder"></ph>
您正在查看 Apigee Edge 文档。
转到
Apigee X 文档。 信息
Monetization 提供了一组 API,您可以使用这些 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}
。
其中:
{org_name}
指定组织的名称。{suspendedProduct_id}
使用某种格式指定 API 产品的 ID 类似于{org_id}@@@{product_id}
。该值将作为prodId
(如 查看所有已暂停使用该 API 的开发者和查看已暂停使用该 API 的开发者。
例如,以下 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 取消暂停开发者
通过向 以下资源:/organizations/{org_name}/suspended-developers/{suspendedDev_id}。
其中:
{org_name}
指定组织的名称。{suspendedDev_id}
使用格式指定已暂停开发者的 ID 类似于{org_id}@@@{dev_id}
。该值将作为devId
当您查看所有或特定已暂停的开发者时,如查看所有已暂停的开发者使用 API 和查看已暂停的开发者中所述。
您可以选择传递以下查询参数:
查询参数 | 说明 |
---|---|
suspendedProduct_id |
API 产品的 ID,格式类似于:
{org_id}@@@{product_id} 。当发生以下情况时,系统会将此值作为 prodId 返回:
您可以查看所有或特定已暂停的开发者,具体说明请参见查看所有已暂停使用该 API 的开发者和查看使用该 API 的已暂停开发者。 |
例如,以下 c网址 调用可解除 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 |
已达到配置后的最终音量频段限制。 |