Terraform манифестін тестілеуге арналған APIBeta
Төменде Terraform манифестін орналастыру жүйесімен тестілеуге арналған API әдістері сипатталған.
Сұрау Terraform манифестін орналастыру жүйесіне жүктейді.
plans/<ЖОСПАР_АТЫ>/deployment/deploy.tf манифестін жүктеу сұрауының параметрлері:
Параметр | Мәні |
|---|---|
Сұрау әдісі |
|
Сұрау жолы |
Мұнда:
|
Сұрау денесі ( |
Егер тестілеу үшін провайдерлердің қосымша ресурстары қажет болса, оларды сұрау денесіне қосу керек |
|
|
Сұрау мысалы:
curl -v -X POST https://cloud.vk.ru/marketplace/api/infra-api/api/v1-public/hoe/config/test_1.0 \-H 'x-auth-token: <ҚАТЫНАУ_ТОКЕНІ>' \--data-binary "@deploy.tf"
Жауаптың HTTP-кодтары:
Код | Сипаттамасы |
|---|---|
201 | Манифест жүктелді немесе жаңартылды |
400, 500 | Сұрауды орындау қатесі |
401 | Авторизация қатесі |
Орналастыру жүйесінде бұрыннан бар манифест атауымен сұрау жіберілгенде, осы манифесттің конфигурациясы жаңартылады. Манифесттің бұрын жүктелген барлық конфигурациялары Terraform-ның дұрыс жұмыс істеуін қамтамасыз ету үшін орналастыру жүйесінде сақталады.
Сұрау сұрауда көрсетілген Terraform манифестінің ағымдағы конфигурациясын қайтарады.
Сұрау параметрлері:
Параметр | Мәні |
|---|---|
Сұрау әдісі |
|
Сұрау жолы |
Мұнда:
|
|
|
Сұрау мысалы:
curl https://cloud.vk.ru/marketplace/api/infra-api/api/v1-public/hoe/config/test_1.0 \-H 'x-auth-token: <ҚАТЫНАУ_ТОКЕНІ>'
Жауаптың HTTP-кодтары:
Код | Сипаттамасы |
|---|---|
200 | Сұрау орындалды. Сұрауға жауап көрсетілген Terraform манифестінің ағымдағы конфигурациясын қамтиды |
401 | Авторизация қатесі |
404 | Манифест табылмады |
500 | Сұрауды орындау қатесі |
Сұрау Terraform манифестінің ағымдағы конфигурациясына сәйкес ресурстарды жасайды.
Сервис инстансын жасау сұрауының параметрлері:
Параметр | Мәні |
|---|---|
Сұрау әдісі |
|
Сұрау жолы |
Мұнда |
|
|
Сұрау денесі ( | Келесі параметрлер көрсетілуі тиіс:
|
|
|
Сұрау мысалы:
curl -v -X POST https://cloud.vk.ru/marketplace/api/infra-api/api/v1-public/hoe/object \-H "Content-Type: application/json" \-H 'x-auth-token: <ҚАТЫНАУ_ТОКЕНІ>' \--data '{"uuid": "675f6f08-XXXX-f02311f795d7","config": "test_1.0","vars": {"sub_network": "a793470c-XXXX-67af6c178c8e","image_uuid": "163ff752-XXXX-b0001e3e65d3","volume_type": "ceph-ssd","flavor_uuid": "6e61564f-XXXX-08df5fd84514"}}'
Мұнда:
sub_network— ішкі желінің ID-сы.image_uuid— сервис образының ID-сы.volume_type— диск түрі.flavor_uuid— ВМ конфигурациясының шаблонының ID-сы.
Жауаптың HTTP-кодтары:
Код | Сипаттамасы |
|---|---|
201 | Сервис инстансы жасалды |
400, 500 | Сұрауды орындау қатесі |
401 | Авторизация қатесі |
Сұрау Terraform манифестінің орындалуы нәтижесінде жасалған сервис инстансын жояды
Сұрау параметрлері:
Параметр | Мәні |
|---|---|
Сұрау әдісі |
|
Сұрау жолы |
Мұнда:
|
|
|
Сұрау мысалы:
curl -v -X DELETE https://cloud.vk.ru/marketplace/api/infra-api/api/v1-public/hoe/object/675f6f08-XXXX-f02311f795d7 \-H 'x-auth-token: <ҚАТЫНАУ_ТОКЕНІ>'
Жауаптың HTTP-кодтары:
Код | Сипаттамасы |
|---|---|
201 | Сервис инстансы жойылды |
400, 500 | Сұрауды орындау қатесі |
401 | Авторизация қатесі |
404 | Манифест табылмады |
Сұрау сервис инстансының статусын қайтарады.
Параметр | Мәні |
|---|---|
Сұрау әдісі |
|
Сұрау жолы |
Мұнда:
|
|
|
Сұрау мысалы:
curl https://cloud.vk.ru/marketplace/api/infra-api/api/v1-public/hoe/object/675f6f08-XXXX-f02311f795d7 \-H 'x-auth-token: <ҚАТЫНАУ_ТОКЕНІ>'
Жауаптың HTTP-кодтары:
Код | Сипаттамасы |
|---|---|
200 | Сұрау орындалды. Сұрауға жауап сервис инстансының статусын қамтиды (
|
401 | Авторизация қатесі |
404 | Сервис инстансының идентификаторы табылмады |
500 | Сұрауды орындау қатесі |
Сервис инстансын жойғаннан кейін орындалған сұрауға жауап мысалы:
{"uuid": "675f6f08-XXXX-f02311f795d7","target_status": "deleted","vars": {},"out": "{}","status": "deleted","conf_name": "user@vk.team","conf_hash": "75587baeXXXX","pid": "b66dde3dXXXX","create_at": "2023-04-26T13:57:54.849565Z","update_at": "2023-04-26T14:02:42.667399Z","full_deployed": false,"attempts": 0,"max_attempts": 15}
Мұнда:
uuid— сервис инстансын орналастыру идентификаторы.target_status— сервис инстансының мақсатты статусы (deletedнемесеrunning).vars— манифесттің кіріс айнымалылары.out— манифесттің шығыс параметрлері.status— сервис инстансының ағымдағы статусы.conf_name— сервисді орналастырған пайдаланушының атауы.conf_hash— сервис инстансы конфигурациясының хеші.pid— сервисді орналастырған пайдаланушының жобасының идентификаторы (Project ID).create_at— сервис инстансы жасалған күн мен уақыт.update_at— сервис инстансының орналастыру жүйесімен соңғы жаңартылған күні мен уақыты.full_deployed— сервис инстансы сәтті орналастырылды ма (статусdeletedүшін мәніfalseтең).attempts— сервис инстансын орналастыру кезінде орындалған қайталама әрекеттер саны.max_attempts— қайталама әрекеттердің максималды саны.
Сұрау сервис инстансының логтерін қайтарады.
Сұрау параметрлері:
Параметр | Мәні |
|---|---|
Сұрау әдісі |
|
Сұрау жолы |
Мұнда:
|
|
|
Сұрау мысалы:
curl https://cloud.vk.ru/marketplace/api/infra-api/api/v1-public/logs/instance/675f6f08-XXXX-f02311f795d7 \-H 'x-auth-token: <ҚАТЫНАУ_ТОКЕНІ>'
Жауаптың HTTP-кодтары:
Код | Сипаттамасы |
|---|---|
200 | Сұрау орындалды. Сұрауға жауаптың |
401 | Авторизация қатесі |
404 | Сервис инстансының идентификаторы табылмады |
500 | Сұрауды орындау қатесі |
Жауап мысалы:
[{"message": " Apply complete! Resources: 1 added, 0 changed, 0 destroyed. ","src": "terraform","level": "debug","created_at": "2024-05-30T08:32:24Z","uuid": "675f6f08-XXXX-f02311f795d7","broker_id": ""}]