You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-8Lines changed: 10 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -49,7 +49,7 @@ API Timeweb Cloud позволяет вам управлять ресурсам
49
49
|--- |--- |--- |
50
50
|[entity_name]|object, object[], string[], number[], boolean|Динамическое поле, которое будет меняться в зависимости от запрашиваемого ресурса и будет содержать все атрибуты, необходимые для описания этого ресурса. Например, при запросе списка баз данных будет возвращаться поле `dbs`, а при запросе конкретного облачного сервера `server`. Для некоторых конечных точек в ответе может возвращаться сразу несколько ресурсов.|
51
51
|meta|object|Опционально. Объект, который содержит вспомогательную информацию о ресурсе. Чаще всего будет встречаться при запросе коллекций и содержать поле `total`, которое будет указывать на количество элементов в коллекции.|
52
-
|response_id|string|Опционально. В большинстве случаев в ответе будет содержаться уникальный идентификатор ответа в формате UUIDv4, который однозначно указывает на ваш запрос внутри нашей системы. Если вам потребуется задать вопрос нашей поддержке, приложите к вопросу этот идентификатор — так мы сможем найти ответ на него намного быстрее. Также вы можете использовать этот идентификатор, чтобы убедиться, что это новый ответ на запрос и результат не был получен из кэша.|
52
+
|response_id|string|Опционально. В большинстве случаев в ответе будет содержаться ID ответа в формате UUIDv4, который однозначно указывает на ваш запрос внутри нашей системы. Если вам потребуется задать вопрос нашей поддержке, приложите к вопросу этот ID— так мы сможем найти ответ на него намного быстрее. Также вы можете использовать этот ID, чтобы убедиться, что это новый ответ на запрос и результат не был получен из кэша.|
53
53
54
54
Пример запроса на получение списка SSH-ключей:
55
55
```
@@ -80,7 +80,7 @@ API Timeweb Cloud позволяет вам управлять ресурсам
|error_code|string|Короткий текстовый идентификатор ошибки, который уточняет числовой идентификатор и удобен для программной обработки. Самый простой пример — это код `not_found` для ошибки 404.|
82
82
|message|string, string[]|Опционально. В большинстве случаев в ответе будет содержаться человекочитаемое подробное описание ошибки или ошибок, которые помогут понять, что нужно исправить.|
83
-
|response_id|string|Опционально. В большинстве случае в ответе будет содержаться уникальный идентификатор ответа в формате UUIDv4, который однозначно указывает на ваш запрос внутри нашей системы. Если вам потребуется задать вопрос нашей поддержке, приложите к вопросу этот идентификатор — так мы сможем найти ответ на него намного быстрее.|
83
+
|response_id|string|Опционально. В большинстве случае в ответе будет содержаться ID ответа в формате UUIDv4, который однозначно указывает на ваш запрос внутри нашей системы. Если вам потребуется задать вопрос нашей поддержке, приложите к вопросу этот ID — так мы сможем найти ответ на него намного быстрее.|
84
84
85
85
Пример:
86
86
```
@@ -94,7 +94,7 @@ API Timeweb Cloud позволяет вам управлять ресурсам
94
94
```
95
95
96
96
## Статусы ресурсов
97
-
Важно учесть, что при создании большинства ресурсов внутри платформы вам будет сразу возвращен ответ от сервера со статусом `200 OK` или `201 Created` и идентификатором созданного ресурса в теле ответа, но при этом этот ресурс может быть ещё в *состоянии запуска*.
97
+
Важно учесть, что при создании большинства ресурсов внутри платформы вам будет сразу возвращен ответ от сервера со статусом `200 OK` или `201 Created` и ID созданного ресурса в теле ответа, но при этом этот ресурс может быть ещё в *состоянии запуска*.
98
98
99
99
Для того чтобы понять, в каком состоянии сейчас находится ваш ресурс, мы добавили поле `status` в ответ на получение информации о ресурсе.
100
100
@@ -139,7 +139,7 @@ TIMEWEB_CLOUD_TOKEN=\"token\"
139
139
140
140
После этого токен будет автоматически подставляться в ваши запросы.
141
141
142
-
Обратите внимание, что все значения в этой документации являются примерами. Не полагайтесь на идентификаторы операционных систем, тарифов и т.д., используемые в примерах. Используйте соответствующую конечную точку для получения значений перед созданием ресурсов.
142
+
Обратите внимание, что все значения в этой документации являются примерами. Не полагайтесь на IDы операционных систем, тарифов и т.д., используемые в примерах. Используйте соответствующую конечную точку для получения значений перед созданием ресурсов.
*DomainsApi* | [**update_domain_dns_record**](docs/DomainsApi.md#update_domain_dns_record) | **PATCH** /api/v1/domains/{fqdn}/dns-records/{record_id} | Обновить информацию о DNS-записи домена или поддомена
*ProjectsApi* | [**get_account_servers**](docs/ProjectsApi.md#get_account_servers) | **GET** /api/v1/projects/resources/servers | Получение списка всех серверов на аккаунте
436
436
*ProjectsApi* | [**get_account_storages**](docs/ProjectsApi.md#get_account_storages) | **GET** /api/v1/projects/resources/buckets | Получение списка всех хранилищ на аккаунте
437
437
*ProjectsApi* | [**get_all_project_resources**](docs/ProjectsApi.md#get_all_project_resources) | **GET** /api/v1/projects/{project_id}/resources | Получение всех ресурсов проекта
438
-
*ProjectsApi* | [**get_project**](docs/ProjectsApi.md#get_project) | **GET** /api/v1/projects/{project_id} | Получение проекта по идентификатору
438
+
*ProjectsApi* | [**get_project**](docs/ProjectsApi.md#get_project) | **GET** /api/v1/projects/{project_id} | Получение проекта по ID
*ServersApi* | [**update_server_nat**](docs/ServersApi.md#update_server_nat) | **PATCH** /api/v1/servers/{server_id}/local-networks/nat-mode | Изменение правил маршрутизации трафика сервера (NAT)
511
511
*ServersApi* | [**update_server_os_boot_mode**](docs/ServersApi.md#update_server_os_boot_mode) | **POST** /api/v1/servers/{server_id}/boot-mode | Выбор типа загрузки операционной системы сервера
512
512
*VPCApi* | [**create_vpc**](docs/VPCApi.md#create_vpc) | **POST** /api/v2/vpcs | Создание VPC
513
-
*VPCApi* | [**delete_vpc**](docs/VPCApi.md#delete_vpc) | **DELETE** /api/v1/vpcs/{vpc_id} | Удаление VPC по идентификатору сети
513
+
*VPCApi* | [**delete_vpc**](docs/VPCApi.md#delete_vpc) | **DELETE** /api/v1/vpcs/{vpc_id} | Удаление VPC по ID сети
**created_at** | **object** | Значение времени, указанное в комбинированном формате даты и времени ISO8601, которое представляет, когда был создан токен. |
10
10
**name** | **object** | Имя токена. |
11
11
**expired_at** | **object** | Значение времени, указанное в комбинированном формате даты и времени ISO8601, которое представляет, когда истекает токен. |
0 commit comments