このコンテンツは役に立ちましたか?
どうすればこの記事をもっと役立つものにできると思いますか?
The API uses JSON structures, which may include the following data types:
An endpoint is the URL of the entry point for a Lyve Cloud web service.
https://api.lyvecloud.seagate.com/v2
The following methods can be used to Create, Read, Update and Delete Lyve Cloud entities:
Operation | Syntax | Body Structure | Response Structure |
---|---|---|---|
Create an entity | POST /uri | Required | The created entity |
Read an entity | GET /uri/<id> | - | The requested entity |
Read all entities | GET /uri | - | List of entities |
Update an entity | PUT /uri/<id> | Required | The updated entity |
Delete an entity | DELETE /uri/<id> | - | The deleted entity |
The successful status message is 200 (OK); for some API request calls, a successful response contains the JSON format. The details of the JSON format are explained in the respective API request.
When an error occurs, the header information contains the following:
The following sample error response shows the structure of response elements common to all REST error responses.
{ "code": "string", "message": "string" }
The following table explains the REST error response elements.
Name | Description |
---|---|
Code | A string that identifies the error. It is meant to be read and understood by programs that detect and handle errors by type. |
Message | A description of the error condition. Programs may display the message directly to the end user if they meet an error condition. An error message in the body aids in resolving the issue. |