Skip to content

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/page

Request Method:

text
POST

Content-Type:

text
application/json

Header Parameters:

ParameterTypeRequiredDescription
X-Access-KeystringYesAPI access key ID. See API Rules for authentication
X-SignaturestringYesSignature value, Base64-encoded HMAC-SHA256 result
X-TimestampstringYesMillisecond-level Unix timestamp (13 digits)
X-NoncestringYesRandom string, 10~32 lowercase letters and digits

Body Parameters:

ParameterTypeRequiredDescription
pageNointegerNoPage number, starting from 1. Defaults to 1
pageSizeintegerNoPage size. Defaults to 10, max 1000
resourceTypeintegerYesResource type: 1 cloud phone, 4 proxy IP, 6 cloud disk

Request Example:

json
{
  "pageNo": 1,
  "pageSize": 10,
  "resourceType": 1
}

Response Parameters:

ParameterTypeDescription
codeintegerError code. See Error Codes
dataobjectReturn data
├─ listarray[object]Data list
├─├─ resourceUidstringResource 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
├─├─ resourceTypeintegerResource type: 1 cloud phone, 4 proxy IP, 6 cloud disk
├─├─ resourceExpireTimestringResource expiry time, Unix timestamp in milliseconds
├─├─ enabledintegerAuto-renewal switch: 0 disabled, 1 enabled
├─├─ skuNamestringSKU name, translated according to Accept-Language
├─├─ packageNamestringPackage name, translated according to Accept-Language
├─├─ currencystringCurrency code
├─├─ currencySymbolstringCurrency symbol, e.g. $ for USD
├─├─ namestringCloud phone remark (ctrRemark) or proxy name, varies by resource type
├─├─ ctrAliasstringCloud phone alias (cloud phone only)
├─├─ regionstringProxy IP region (IP only)
├─├─ regionCnstringProxy IP region in Chinese (IP only)
├─├─ egressIpstringProxy egress IP (IP only)
├─ totalintegerTotal count
msgstringError 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 ctrAlias of a cloud phone in place of resourceUid; each cloud disk purchase record has its own policy.
  • Some fields may be null when resource information is missing.

OpenAPI Docs