Auto-Renewal Policy Page
Query auto-renewal policies with pagination by resource type. For cloud phones and proxy IPs, only the caller's own policies are returned; for cloud disks, policies are queried by the current team. Expired resources are not returned.
Interface Address:
text
/papi/wallet/auto-renew/pageRequest Method:
text
POSTContent-Type:
text
application/jsonHeader Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Access-Key | string | Yes | API access key ID. See API Rules for authentication |
| X-Signature | string | Yes | Signature value, Base64-encoded HMAC-SHA256 result |
| X-Timestamp | string | Yes | Millisecond-level Unix timestamp (13 digits) |
| X-Nonce | string | Yes | Random string, 10~32 lowercase letters and digits |
Body Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| pageNo | integer | No | Page number, starting from 1. Defaults to 1 |
| pageSize | integer | No | Page size. Defaults to 10, max 1000 |
| resourceType | integer | Yes | Resource type: 1 cloud phone, 4 proxy IP, 6 cloud disk |
Request Example:
json
{
"pageNo": 1,
"pageSize": 10,
"resourceType": 1
}Response Parameters:
| Parameter | Type | Description |
|---|---|---|
| code | integer | Error code. See Error Codes |
| data | object | Return data |
| ├─ list | array[object] | Data list |
| ├─├─ resourceUid | string | Resource identifier used by the update API; cloud phone uses ctrId, IP uses the proxy IP uid, cloud disk uses the ID string of the purchase record |
| ├─├─ resourceType | integer | Resource type: 1 cloud phone, 4 proxy IP, 6 cloud disk |
| ├─├─ resourceExpireTime | string | Resource expiry time, Unix timestamp in milliseconds |
| ├─├─ enabled | integer | Auto-renewal switch: 0 disabled, 1 enabled |
| ├─├─ skuName | string | SKU name, translated according to Accept-Language |
| ├─├─ packageName | string | Package name, translated according to Accept-Language |
| ├─├─ currency | string | Currency code |
| ├─├─ currencySymbol | string | Currency symbol, e.g. $ for USD |
| ├─├─ name | string | Cloud phone remark (ctrRemark) or proxy name, varies by resource type |
| ├─├─ ctrAlias | string | Cloud phone alias (cloud phone only) |
| ├─├─ region | string | Proxy IP region (IP only) |
| ├─├─ regionCn | string | Proxy IP region in Chinese (IP only) |
| ├─├─ egressIp | string | Proxy egress IP (IP only) |
| ├─ total | integer | Total count |
| msg | string | Error message |
Response Example:
json
{
"code": 0,
"data": {
"list": [
{
"resourceUid": "",
"resourceType": 1,
"resourceExpireTime": "",
"enabled": 1,
"skuName": "",
"packageName": "",
"currency": "USD",
"currencySymbol": "$",
"name": "",
"ctrAlias": "",
"region": null,
"regionCn": null,
"egressIp": null
}
],
"total": 0
},
"msg": ""
}Notes:
- Only static residential IPs and static datacenter IPs support auto-renewal; dynamic IPs do not.
- Do not use the display-only
ctrAliasof a cloud phone in place ofresourceUid; each cloud disk purchase record has its own policy. - Some fields may be null when resource information is missing.
