Cloud resource service

更新时间:
复制 MD 格式

The cloud resource service is a basic service for cloud management. You can use this service to obtain a token for IoT cloud resources. This token is then used in subsequent requests to access resources.

Invalidation mechanism

  • The validity period of a cloudToken is returned in the `expireIn` parameter. The default validity period is 7,200,000 ms (2 hours).
  • When a cloudToken is refreshed, the old cloudToken remains active for 5 minutes. This ensures a smooth transition for third-party services.

Cloud resource types

Name Authorization type (grantType) Resource (res)
Project resource project Project ID

Get a cloud resource token

Description

Path Request method Version Description
/cloud/token POST 1.0.0 Gets a cloud resource token. For the same `res` (projectId), call this API only once before the token expires. If you call it again, a new cloudToken is generated, which invalidates the previous one.

Request parameters

Parameter Type Required Description
grantType String Yes The authorization type. The value must be project
res String Yes The resource to authorize. Enter the projectId

Response parameters

Parameter Type Description
cloudToken String The cloud token.
expiresIn long The validity period of the token in ms.

Examples

  • Request example
    {
        "id": "1509086454180",
        "version": "1.0", 
        "request": {
            "apiVer": "1.0.0"
        },
        "params": {
            "grantType": "project",
            "res": "xxxxxx"
        }
    }
  • {
        "id": "1509086454180",
        "code": 200,
        "message": "success",
        "data": {
            "cloudToken" : "cloudToken",
            "expiresIn" : 7200000
        }
    }

Refresh a cloud resource token

Description

path Version Description
/cloud/token/refresh 1.0.0 Refreshes the cloud token.

Request parameters

Parameter Type Required Description
cloudToken String Yes -

Response parameters

Parameter Type Description
cloudToken String The cloud token.
expiresIn long The validity period of the token in ms.

Examples

  • Request example
    {
        "id": "1509086454180",
        "version": "1.0", 
        "request": {
            "apiVer": "1.0.0",
            "cloudToken":"cloudToken"
        },
        "params": {
            "cloudToken": "cloudToken"
        }
    }
  • Successful response example
    {
        "id": "1509086454180",
        "code": 200,
        "message": "success",
        "data": {
            "cloudToken" : "cloudToken",
            "expiresIn" : 7200000
        }
    }