Создание кластера Redis при помощи OpenAPI

Чтобы работать с сервисами облака MWS при помощи API, у вас должны быть созданы:

1. Учетная запись в облаке MWS. Как зарегистрироваться…
2. Платежный аккаунт. Подробнее…

Для подключения того или иного сервиса облака на балансе вашего платежного аккаунта должны присутствовать средства в соответствующем объеме. Также вы можете использовать гранты.

Для создания кластера Redis (сервис DBaaS for Redis) потребуются:

1. Авторизационный токен — $TOKEN.

   Все API запросы выполняются от имени пользователя. Токен генерируется для пользователя при выполнении запроса на авторизацию. Также можно использовать токен, созданный для сервисного аккаунта. Подробнее…

   Пример авторизационного токена

   1
   eyJhbGciOiJSUzUxMiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIwMmVmY2U2My01Y2YzLTQxOWEtOTllYi1kYzNiNWVkNGM3NzYiLCJleHAiOjE2ODUwMjYxNzcsImlhdCI6MTY4NTAxMTc4OCwidiI6MiwicCI6Im1uKlRyQEx6cDIvU20oSGQpS3p4OXU5WFx1MDAzZUBXNGdCRzJxPXdcdTAwM2V9bmNPeUE2Yz9BUkJBcF4hbmI3XHUwMDNjeGdbJD1xNkFGU0kyLXVCa15IckItMHpqZ2lbOi5dUUIjOU1NUkJve3ZcdTAwMjZieGJ0fUwyNCFVNTpYckRGRlI3QjlzR0wlSF50XnY4UnJVSC86OTNwXWNiLSF9QHUkXVNIVkIkU2JKZ0chP3g6WWhUUDJGIy1zSmJcdTAwM2VrVS5Wb0A5bEN3RElRVVd4L0Eld1NpNlVlRSppY2JPSXVPKXNVMkdyNFVnVCNCXHUwMDNleTJ4d1hNaFQhVXF0RkwzbXNIa312Sl1pdH0_MWVIZmNXc2FpRC9BfUVxWV1uQTYxTjdMISVbKSRGUSMpTFQ9azd0R3pjKzJCPVNlTiRQT0Z6NXpyTkdxYkF6cz8vVTgyZ2NMLVx1MDAzZWNcdTAwM2NyLiNUdEBVMDlkc2l5bnNKOmxZbWFBcTUxMnslbmZZTnMqMFd3R3trKTAvdio_QV5lW14rXHUwMDI2WTZxezp6ckdJaFx1MDAzY083cWFATFx1MDAzY01YW0UrVElFVVBmeSgoanVDS2NQOGNXQUl0XlJpOUcqYk9yIn0.foWauILeaASkOnzCHgaWinGPlj5SNT44xqpQPLFNAY3f-1oUmtWPcmCGeRjMKLYQ2A9ZAOk9ZLaT49oOtjXjVAdY46Ni4MHJOkHtzRksgl9rZHdNwSQbQwTnjbR0sgf2BUaGkdoR3yY3udXYOCGfpbL5nAZKEZoeVyc0fHWtGvy2V9ocjWQiP12hiJhfd2vl1s8gpX4PofP9KaaurpbmTDQ8rfHY1i4u33bU0HtabnkcgmeplU0J_2gFbsBsLpcXszgPeiUAg8ep5JB3A1_PNmz86dcM3m7e223y3KUP3vxlmejDZQFJImvlcL0727JC-_RSRWeUHiyArbjrwyNgowZtbmnsH65ssPTZwoMNhU5X5yVIj_um2EesEd2FIt1R4T56vXeagF2Bln8GRfZLaut06kN2a6i4lWr-JV7xZbeT9n9t58Yyyk6Z7IjwwsDVGOJTPY_jhBP8U4mpFBAo__bjtfi4u6cNgoo6bSrNR0ud9wLTta8aUxqz47bCmjtgmovhTLXWw0pOJmMb7UiBcL3IKNoVSkoiqTJSqArMO72fMquizKXyT4HVghPIt5mgDQOdsxKiZ-2L4dvBW_72U8mkd4VwOAcRwYcM6xfQcko6aPYiaGrAgpvWZ8iRUdFfqaW63V6SSweRcbnU9UwDfUSVZ7i3lZsPqhalLmUEj9c

2. Идентификатор проекта — $PROJECTID.

   Любой сервис в облаке MWS создается в рамках проекта. Вы можете:

• Создать новый проект при помощи API-запроса.
• Использовать уже созданный проект (например, тот, который был создан автоматически при регистрации вашей учетной записи в облаке). Его идентификатор можно узнать на дэшборде в консоли управления (правая верхняя часть экрана).

Идентификатор проекта имеет формат UUID, пример: 09b992c3-1223-41e7-bd81-cfeae5f7fb5c.

3. Идентификатор сети — network_id и идентификатор подсети — subnetwork_id, а также (опционально) **IP-адрес ** — публичный IP-адрес.

   Для работы кластера Redis нужна выделенная виртуальная сеть и подсеть (а также IP-адрес — опционально). Если у вас уже есть созданные сеть/подсеть/IP-адрес, используйте их. Также вы можете создать новые при помощи API-запросов.

   Идентификаторы сети/подсети/IP-адреса имеют формат UUID.

Последовательность шагов для создания сервиса Redis в облаке MWS через API — следующая:

1. Авторизуйтесь (опционально; можете использовать токен сервисного аккаунта, если он создан).
2. Создайте проект (опционально; можете использовать существующий).
3. Создайте виртуальную сеть (опционально; можете использовать существующую, если она уже создана).
4. Создайте виртуальную подсеть (опционально; можете использовать существующую, если она уже создана).
5. Создайте IP-адрес (опционально; нужен только для доступа к кластеру извне облака).
6. Создайте кластер Redis.

• Если у вас есть токен сервисного аккаунта — пропустите этот шаг.

• Если у вас нет токена сервисного аккаунта:

  • Авторизуйтесь при помощи запроса POST /iam/v2/tokens — в ответе будет возвращен токен. Используйте его в дальнейших запросах.

• Если вы хотите использовать уже созданный проект — пропустите этот шаг.
• Для создания нового проекта выполните запрос POST /apis/projects/public/v4/projects.

Пример запроса:

1
curl --location --request POST 'https://gateway.cloud.mts.ru/apis/projects/public/v4/projects' \
2
--header "Idempotency-Key: $IDEMPOTENCYKEY" \
3
--header 'Content-Type: application/json' \
4
--header "Authorization: Bearer $TOKEN" \
5
--data '{
6
  "name": "Test OpenAPI",
7
  "description": "Проект для тестирования OpenAPI"
8
}'

• Если вы хотите использовать уже созданную виртуальную сеть — пропустите этот шаг.
• Для создания новой сети выполните запрос POST /ocs/v1/services.

Пример запроса:

1
curl --location --request POST 'https://gateway.cloud.mts.ru/ocs/v1/services' \
2
--header "Idempotency-Key: $IDEMPOTENCYKEY" \
3
--header 'Content-Type: application/json' \
4
--header "Authorization: Bearer $TOKEN" \
5
--data '{
6
  "platform": {
7
    "productCode": "network",
8
    "regionCode": "msk"
9
  },
10
  "kind": "network",
11
  "metadata": {
12
    "description": "test OpenAPI network",
13
    "title": "openapi-network"
14
  },
15
  "projectId": "'$PROJECTID'",
16
  "spec": {
17
    "mts.extensions.network": {
18
        "bandwidth_mbps": 100,
19
        "default_gfw_rule_action": "allow"
20
    }
21
  },
22
  "zoneCode": "msk-avntg"
23
}
24
'

• Если вы хотите использовать уже созданную подсеть — пропустите этот шаг.
• Для создания новой подсети выполните запрос POST /ocs/v1/services.

Пример запроса:

1
curl --location --request POST 'https://gateway.cloud.mts.ru/ocs/v1/services' \
2
--header "Idempotency-Key: $IDEMPOTENCYKEY" \
3
--header 'Content-Type: application/json' \
4
--header "Authorization: Bearer $TOKEN" \
5
--data '{
6
    "platform": {
7
        "productCode": "network",
8
        "regionCode": "msk"
9
    },
10
    "kind": "subnet",
11
    "metadata": {
12
        "description": "test OpenAPI subnetwork",
13
        "title": "openapi-subnetwork"
14
    },
15
    "parentBinding": {
16
        "targetId": "8d114c29-d579-41b3-a4d9-7fd0ac20a0d3"
17
    },
18
    "projectId": "'$PROJECTID'",
19
    "spec": {
20
        "mts.extensions.subnet": {
21
            "cidr": "10.100.15.0/24"
22
        }
23
    },
24
    "zoneCode": "msk-avntg"
25
}'

В примере выше:

• в параметре "targetId": "8d114c29-d579-41b3-a4d9-7fd0ac20a0d3" указывается ID сети, в которой создается подсеть.

• Если вы хотите использовать уже созданный IP-адрес — пропустите этот шаг.
• Для создания нового IP-адреса выполните запрос POST /ocs/v1/services.

Пример запроса:

1
curl --location --request POST 'https://gateway.cloud.mts.ru/ocs/v1/services' \
2
--header "Idempotency-Key: $IDEMPOTENCYKEY" \
3
--header 'Content-Type: application/json' \
4
--header "Authorization: Bearer $TOKEN" \
5
--data '{
6
    "platform": {
7
        "productCode": "network",
8
        "regionCode": "msk"
9
    },
10
    "kind": "ip",
11
    "metadata": {
12
        "description": "test OpenAPI ip",
13
        "title": "openapi-ip-address"
14
    },
15
    "parentBinding": {
16
        "targetId": "8d114c29-d579-41b3-a4d9-7fd0ac20a0d3"
17
    },
18
    "projectId": "'$PROJECTID'",
19
    "spec": {},
20
    "zoneCode": "msk-avntg"
21
}'

В примере выше:

• в параметре "targetId": "8d114c29-d579-41b3-a4d9-7fd0ac20a0d3" указывается ID сети, в которой создается IP-адрес.

Выполняется запросом POST /ocs/v1/services, в котором необходимо передать:

• prodjectId, network_id, subnetwork_id — их можно взять из ответов предыдущих API-запросов;
• параметры создаваемого кластера.

  Параметры кластера

  Scenario

  Scenario	Description
  standalone	Однохостовый сетап
  sentinel	Redis Sentinel

  Disk Type

  Disk Type	Min IOPS
  ssd.basic	200
  ssd.fast	500
  ssd.ultra	1000
  ssd.ultra-plus	5000

  Redis version

  Redis version
  7.0.5
  6.2.7

Пример запроса:

1
curl --location --request POST 'https://gateway.cloud.mts.ru/ocs/v1/services' \
2
    --header 'Content-Type: application/json' \
3
    --header 'Accept: application/json' \
4
    --header "Idempotency-Key: $IDEMPOTENCYKEY" \
5
    --header "Authorization: Bearer $TOKEN" \
6
    --data-raw '{
7
"platform": {
8
      "productCode": "mts-redis",
9
      "regionCode": "msk"
10
},
11
    "kind": "storage",
12
    "metadata": {
13
        "description": "redis-openapi",
14
        "title": "redis-openapi-test"
15
    },
16
    "projectId": "'$PROJECTID'",
17
    "spec": {
18
      "mts.extensions.dbaas_create_appliance": {
19
        "name": "redis-cluster-cur6w",
20
        "instance_count": 1,
21
        "network_id": "e7339beb-33d7-49da-8e24-3fda23638aad",
22
        "subnetwork_id": "5b5008d0-ca17-417a-91ba-c77fee74e860",
23
        "persistence": true,
24
        "scenario": "standalone",
25
        "disk_type": "ssd.basic",
26
        "disk_size": {
27
          "unit": "GiB",
28
          "value": 30
29
        },
30
        "user_password": "$3cr3t",
31
        "user_name": "deadbeef",
32
        "total_cpu": 1,
33
        "total_ram": {
34
        "unit": "GiB",
35
        "value": 4
36
      },
37
      "description": "some descr from api",
38
      "appliance_version_id": "7.0.5"
39
    },
40
    "occi.storage.size": 100
41
  },
42
  "zoneCode": "msk-avntg"
43
}'

В примере запроса выше:

• при помощи параметра "network_id" и subnetwork_id указываются ID созданных сети/подсети.

Если вам требуется в дальнейшем подключаться к созданному кластеру Redis извне MWS, то помимо параметров кластера в примере выше, дополнительно укажите публичный IP-адрес для подключения к кластеру:
"white_host": "<IPv4 адрес в формате a.b.c.d>"

1
curl --location --request POST 'https://gateway.cloud.mts.ru/ocs/v1/services' \
2
    --header 'Content-Type: application/json' \
3
    --header 'Accept: application/json' \
4
    --header "Idempotency-Key: $IDEMPOTENCYKEY" \
5
    --header "Authorization: Bearer $TOKEN" \
6
    --data-raw '{
7
"platform": {
8
      "productCode": "mts-redis",
9
      "regionCode": "msk"
10
},
11
    "kind": "storage",
12
    "metadata": {
13
        "description": "redis-openapi",
14
        "title": "redis-openapi-test"
15
    },
16
    "projectId": "'$PROJECTID'",
17
    "spec": {
18
      "mts.extensions.dbaas_create_appliance": {
19
        "name": "redis-cluster-cur6w",
20
        "instance_count": 1,
21
        "network_id": "e7339beb-33d7-49da-8e24-3fda23638aad",
22
        "subnetwork_id": "5b5008d0-ca17-417a-91ba-c77fee74e860",
23
        "public_ip":"10.21.196.33",
24
        "persistence": true,
25
        "scenario": "standalone",
26
        "disk_type": "ssd.basic",
27
        "disk_size": {
28
          "unit": "GiB",
29
          "value": 30
30
        },
31
        "user_password": "$3cr3t",
32
        "user_name": "deadbeef",
33
        "total_cpu": 1,
34
        "total_ram": {
35
        "unit": "GiB",
36
        "value": 4
37
      },
38
      "description": "some descr from api",
39
      "appliance_version_id": "7.0.5"
40
    },
41
    "occi.storage.size": 100
42
  },
43
  "zoneCode": "msk-avntg"
44
}'

Процесс подключения к созданному кластеру описан в данном разделе документации.