Get started
  • English
  • 简体中文
Official Site
Get started
  • English
  • 简体中文
Official Site
  • Get started
  • Concepts
  • Guides
  • Device capabilities & events
  • API reference
    • Public conventions
    • Development specification
    • accessToken: Get administrator token
    • API request example
    • Return codes
    • Interface call limits
    • Account docking
    • Device APIs
    • Device live broadcast
    • Push configuration
    • Cloud storage service
    • Resource pool quota
      • createResourcePool: Create a resource pool
      • getResourcePool: Get resource pool details
      • listResourcePoolByPage: List resource pools
      • modifyResourcePool: Modify a resource pool
      • removeResourcePool: Remove a resource pool
      • bindSubAccountToResourcePool: Bind sub-account to pool
      • bindDeviceToResourcePool: Bind device channel to pool
      • unbindSubAccountFromResourcePool: Unbind sub-account from pool
      • unbindDeviceFromResourcePool: Unbind device channel from pool
      • listSubAccountResourcePoolConfigByPage: List sub-accounts in pools
      • listDeviceResourcePoolConfigByPage: List device channels in pools
      • getSubAccountResourcePoolConfig: Get pools for sub-account
      • getDeviceResourcePoolConfig: Get pools for device channel
      • queryOauthUserQuota: Query OAuth user flow quota
      • saveOauthUserQuota: Set OAuth user flow quota
    • Legacy APIs (deprecated)
  • SDK and tools
  • Solutions
  • Platform and support
On this page
Function details
Request address
Request format
Incoming parameter description
Sample input
Return data field description
Sample output
Error codes
Notes
Related

createResourcePool: Create a resource pool

createResourcePool: Create a resource pool

Function details

Creates a flow quota pool and returns resourcePoolKey.

Requires a developer administrator accessToken (At_ prefix). Sub-account tokens cannot call this method.

Request address

https://openapi-[DataCenter].easy4ip.com/openapi/createResourcePool

Request format

HTTP POST. JSON body layout: Request conventions. Sign with Signature.

Incoming parameter description

Parameter nameParameter typeRequired or notDefault valueLegal valueParameter description
tokenStringYesAdministrator accessToken
resourceTypeStringYesflowPool type; only flow (traffic) is supported
quotaLongYes≥0Cap in MB
periodStringYesday / month / alwaysday: daily cap; month: calendar month; always: total cap until exhausted

Sample input

{
    "system": {
        "ver": "1.0",
        "appId": "lcdxxxxxxxxx",
        "sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
        "time": 1603350473,
        "nonce": "a4d59add-0f04-4b7e-9355-d1fb4e9dc22b"
    },
    "id": "d82a7fa7-655f-4bb8-ab75-72bb3dfa3a94",
    "params": {
		"token": "At_12345678901234567890123456789012",
		"resourceType": "flow",
		"quota": 10240,
		"period": "month"
    }
}

Return data field description

FieldTypeDescription
resourcePoolKeyStringResource pool unique ID

Sample output

{
    "id": "123456",
    "result": {
        "data": {
            "resourcePoolKey": "rp_abc123"
        },
        "code": "0",
        "msg": "The operation was successful."
    }
}

Error codes

This method may return the codes below. See Return codes.

Gateway and auth (SN / TK / OP)

CodeMeaningNext step
SN1001Signature errorCheck sign per Development specification
TK1002Token invalid or expiredRefresh accessToken
OP1002Missing required parameterAdd required fields
OP1003Invalid parameterMatch this page’s parameter table
OP1009Permission deniedCheck token and device bind/share grants
OP1013Total call limit exceededReduce call rate
OP1014Daily per-interface limit exceededSee Interface call limits
DV1007Device offlineWait until the device is online

See Return codes · OP/SN/TK for the full catalog.

Sub-accounts (SUB)

CodeMeaningNext step
SUB1001–SUB1002Sub-account lacks API permissionUpdate policy via addPolicy
SUB1005Sub-account token expiredRefresh subAccountToken
SUB1006No device grant for sub-accountCheck Resource and device serial
SUB1008Sub-account not bound to appCreate and bind the sub-account first

See Return codes · SUB.

Device (DV10)

CodeMeaningNext step
DV1007Device offline or timeoutWait for the device to come online
DV1009Device busyRetry later
DV1012Insufficient share/grant permissionCheck sub-account Permission / Resource
DV1019Capability not supportedConfirm model and capability list
DV1020Channel offlineCheck channel status
DV1026Function not supportedUse another API or upgrade firmware
DV1028Not bound or channel missingVerify deviceId / channelId

See Return codes · DV.

Notes

Combined usage of all sub-accounts and channels in the pool must not exceed the pool cap. Changes take effect within about 5 minutes.

Related

  • Development specification
  • API conventions
  • Module index
queryCloudRecordByToken
getResourcePool: Get resource pool details