Skip to content

Batch Get Instance Status ​

Batch get cloud phone running status.

Interface Address:

text
/papi/container/operate/batch/getInstanceStatus

Request Method:

text
POST

Content-Type:

text
application/json

Header Parameters:

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

Body Parameters:

ParameterTypeRequiredDescription
ctrIdListarray[string]YesList of container IDs

Request Example:

json
{
  "ctrIdList": [
    "cf5eaa177d75de7f43a0d95c84832560b70118e462dc2eb8da529a936d8c3c6f"
  ]
}

Response Parameters:

ParameterTypeDescription
codeintegerError code. See Error Codes
dataarray[ContainerApiResult]Response data
├─ successbooleanWhether the operation succeeded
├─ taskIdstringTask ID of the operation
├─ dataobjectData
├─├─ life_cycleintegerContainer lifecycle: 1-Powered off, 2-Starting, 3-Restarting, 4-Shutting down, 5-Resetting, 6-Deleting, 7-Running
├─ msgstringOperation message
├─ ctrIdstringContainer CtrId
├─ ctrAliasstringContainer alias
├─ ctrSlotintegerCloud phone slot
msgstringError message

Response Example:

json
{
  "code": 0,
  "data": [
    {
      "success": true,
      "taskId": "",
      "data": {
        "life_cycle": 7
      },
      "msg": "",
      "ctrId": "cf5eaa177d75de7f43a0d95c84832560b70118e462dc2eb8da529a936d8c3c6f",
      "ctrAlias": "",
      "ctrSlot": 0
    }
  ],
  "msg": ""
}

OpenAPI Docs