vCloud Director API для NSX. Инструкция для программистов.

Про vCloud Director API для NSX

vCloud Director
 API для NSX.

API-интерфейс vCloud Director для NSX - это прокси-API, который позволяет клиентам API vCloud делать запросы к NSX API.Используйте этот документ в качестве дополнения к API NSX vSphere API (NSX версии 6.2 или новее). В этом документе перечисляется подмножество запросов NSX API, поддерживаемых API-интерфейсом vCloud Director для NSX, и предоставляется информация о различиях между этими запросами, как они описаны в документации NSX API, и о том, как вы должны их использовать при использовании API-интерфейса vCloud Director для NSX.

Связь с API NSX
API-интерфейс vCloud Director для NSX поддерживает подмножество операций и объектов, определенных в NSX vSphere API Guide (NSX 6.2). API поддерживает NSX 6.2 и 6.3. Вы можете загрузить руководство NSX vSphere API от (NSX 6.2) или (NSX 6.3). Запросы, перечисленные в этом документе, а также связанные с ними примеры, описанные в NSX vSphere API Guide, могут использоваться вызывающими API-интерфейсом vCloud Director для NSX с несколькими изменениями и некоторыми дополнительными ограничениями.

Поддержка нескольких арендаторов (Multi-tenant)
NSX API предназначен для решения задач NSX в глобальной области, такой как центр обработки данных VMware® vCenter ™. NSX Proxy API предназначен для решения задач NSX в рамках организации-арендатора vCloud Director.
 
Если API NSX использует внутренние edge идентификаторы, такие как edge-1 (как правило, указано как edgeId в NSX vSphere API Guide) для идентификации края, API-интерфейс vCloud Director для NSX использует идентификатор, который vCloud Director назначает edge. Это уникальный идентификатор в виде UUID, как определено RFC 4122. Использование этого идентификатора позволяет API ограничивать доступ к ребер членам организации, которым принадлежит край. Доступ членов организации к краю также регулируется их ролью в организации и правами, связанными с этой ролью. API-интерфейс vCloud Director для NSX использует этот UUID этого края только для определения края, определения менеджера NSX, ответственного за край, и получения его внутреннего идентификатора края NSX, который он использует в последующих операциях NSX API на краю.
 
Операции над другими объектами NSX, такие как сертификаты и объекты группировки, как правило, требуют, чтобы в запросе была разрешена организация vCloud Director или VUU UUID, чтобы ограничить доступ к арендаторам с правами объекта vCloud Director.
 
Системные администраторы vCloud Director могут просматривать или обновлять все edge в системе.

Безопасность
HTTP-связь между клиентом и сервером API vCloud обеспечивается SSL. API клиенты также должны заполнить запрос на вход, чтобы получить токен авторизации, который должен быть включен во все последующие запросы.

Заголовки запросов
Следующие заголовки HTTP обычно включаются в запросы:



Accept                                                

Все запросы должны включать заголовок HTTP Accept, который обозначает API-интерфейс vCloud Director для версии NSX, который использует клиент.
 
Accept: application/*+xml;version=api-version

Например, следующий заголовок указывает, что запрос выполняется из API-интерфейса vCloud Director для клиента NSX версии 29.0.

Accept: application/*+xml;version=29.0

Accept-Encoding
По умолчанию система возвращает содержимое ответа как несжатый XML. Сжатие ответа может повысить производительность, особенно когда ответ большой, а пропускная способность сети - фактор. (Запросы не могут быть сжаты.) Чтобы запросить ответ, который будет возвращен как сжатый XML, включите следующий заголовок: 

Accept-Encoding: gzip

Ответ кодируется с использованием gzip-кодирования, как описано в RFC 1952, и включает в себя следующий заголовок:

Content-Encoding: gzip

В конфигурации по умолчанию ответы менее 64 КБ никогда не сжимаются.

 Accept-Language 
Строки сообщений в ответах ErrorType локализованы. Чтобы указать желаемый язык в ответах, используйте заголовок запроса Accept-Language. Чтобы запросить ответ со строками сообщений, локализованными на французском языке, используйте следующий заголовок:

Accept-Language: fr


 Authorization
Все запросы на создание vCloud API сессии должны включать заголовок формы авторизации, предписанной поставщиком идентификации, используемым вашей организацией. См. Руководство по программированию API vCloud для сервис провайдеров.
 Content-Type
Запросы, которые включают тело, должны включать следующий заголовок HTTP Content-Type.

Content-type: application/xml


 x-vcloud-authorization
Этот заголовок, который возвращается с ответом сеанса после успешного входа в систему, должен быть включен во все последующие запросы от клиентов, которые аутентифицируются для интегрированного поставщика удостоверений или поставщика идентификации SAML. См. Руководство по программированию API vCloud для сервис провайдеров.

 X-VMWARE-VCLOUD-CLIENT-REQUEST-ID
Значение этого заголовка используется для построения идентификатора запроса, возвращаемого в значение заголовка X-VMWARE-VCLOUD-REQUEST-ID. Значение этого заголовка не может содержать более 128 символов, взятых из набора букв, цифр и дефиса (-). Значения с недопустимыми символами игнорируются. Значения с более чем 128 символами обрезаются.

Каждый NSX Edge Gateway обеспечивает защиту сети и шлюз для изоляции виртуализованной сети.


NSX сервисы распределенного firewall
Распределенный NSX firewall может обеспечивать функциональность брандмауэра непосредственно в виртуальной машине vNIC и поддерживает модель безопасности микросегментации, в которой East-West трафик может быть проверен при обработке с близкой скоростью - https://code.vmware.com/doc/preview?id=5705#/doc/GUID-442E3FDF-47AC-44F2-906B-B37666795970.html

Запросы, описанные в этом разделе, управляют глобальными объектами NSX, такими как сертификаты и группирующие объекты.

 

Вы уже работаете с сервисами Cloud4Y?

Перейти на вебсайт

Попробовать бесплатно

  • 79 Пользователи нашли это полезным
Помог ли вам данный ответ?

Связанные статьи

Как получить доступ к VMware Cloud Director через vCloud API

Обзор Для выполнения некоторых задач в среде CLOUD4Y вам может потребоваться доступ к VMware...

Изменение параметров EDGE c помощью vCloud API

Введение В данном руководстве показано, как получать, изменять и отправлять блоки XML, которые...

Изменение параметров Advanced Edge через API с помощью PowerShell 7

В данной статье мы рассмотрим, какие действия с Advanced Edge Gateway доступны тенанту (клиенту)...

vCloud API инструкция по программированию для сервис провайдеров

В этом выпуске руководства по программированию API vCloud для сервис провайдеров предоставляется...