Common Parameters
Last update：2023-03-03 13:52:49
The common parameters will be used for user identification and API authentication. These parameters will not be introduced and described in each API documentation. But when using API, the requests should always carrying all these common parameters to ensure a success request.
Common Parameters in Request
The request should carry below parameters in headers for authentication when calling API.
| Parameter | Type | Required | Description |
|---|---|---|---|
| X-WS-AccessKey | string | Yes | Your AccessKey ID. You can check it under Security Settings > Access Control > User Information Management > AccessKey Management on console. |
| X-WS-Timestamp | string | Yes | Current UNIX timestamp, unit second, for example: 1677822256. |
| Authorization | int | Yes | Authorization information.Visit Authentication V3 for more details. |
| content-Type | string | Yes | The type of data actually sent to the server. |
| host | string | Yes | Cloud VoD API domain, fixed at api.cloudv.haplat.net. |
Response Parameter
| Parameter | Type | Description |
|---|---|---|
| X-WS-RequestId | string | The unique identifier of the request carried in response header, which you can use for a further troubleshooting. |
For example
Response Headers
X-WS-RequestId: 3728d44912a711e4348190e221012d52
Is the content of this document helpful to you?
Yes
I have suggestion