URI of Request
A request URI consists of the following parts: {URI-scheme}://{Endpoint}/{resource-path}?{query-string}
Parameter | Description | Required or not |
URI-scheme | Protocol used to transmit requests. All current APIs use HTTPS. | Yes |
Endpoint | Current resource pool or universal domain name | Yes |
resource-path | Access path of an API for performing a specific operation. Obtain the path from the URI of an API. For example, the resource-path of the API used to obtain resources of user 1 is "/users/1". | Yes |
query-string
| Query parameter, which is optional. Ensure that a question mark (?) is included before each query parameter that is in the format of Parameter name=Parameter value. For example, "?userID=1" indicates that the data for user with an ID of 1 will be displayed. | Yes |
Request Methods
Methods | Description |
GET | Request the server to return specific resources. |
PUT | Request the server to update specific resources. |
POST | Request the server to add resources or perform special operations. |
DELETE | Request the server to delete specific resources, for example, an object. |
HEAD | Requests the server to return the header. |
PATCH | Requests the server to update partial content of a specific resource. If the resource does not exist, a new resource may be created by PATCH. |
Request Header
It is an additional request header field and is a public field for authentication.
Parameter | Value (description) |
Content-Type | application/json |
ctyun-eop-request-id | User request id, generated by uuid, in the form of 33dfa732-b27b-464f-b15a-21ed6845afd5 |
Eop-Authorization | Generated by eSurfing Cloud official accessKey and securityKey after signature, for details about the signature logic, see the following description |
Eop-Date | Request time, in the form of yyyyMMdd'T'HHmmss'Z', for example 20211109T104641Z |
Request Code Example
Bash:
Curl https://{Endpoint}/API address
-H "Content-Type:application/json;charset=UTF-8" -H "eop-authorization:xxxxxxxxxxxxxxxxxx" -H "Eop-date:20211014T163109Z" -H "ctyun-eop-request-id:e5d0d445-29a5-4bfc-a4e8-a5b70f889cc3"
Request Body (Optional)
It is in the JSON format. For details, see the description of APIs.