/
A&AI: External System Operation API Definition In ESR

A&AI: External System Operation API Definition In ESR

Nov 20, 2018

VIM

VIM registration

Interface Definition

Description

URI

/api/aai-esr-server/v1/vims

Operation Type

POST

Request Body:

Attribute

Qualifier

Default

Content

Description

cloudOwner

M

 

String

cloud owner name, can be customized, e.g. att-aic

cloudRegionId

M

 

String

cloud region info based on deployment, e.g. RegionOne

cloudType

M

 

String

type of the cloud, decides which multicloud plugin to use, openstack or vio

cloudRegionVersion

M

 

String

cloud version, ocata, mitaka or other

ownerDefinedType

O

 

String

Cloud-owner defined type indicator (e.g., dcp, lcp)

cloudZone

O

 

String

Zone where the cloud is homed.

complexName

O

 

String

complex name for cloud-region instance.

cloudExtraInfo

O

 

String

extra info for Cloud

vimAuthInfos

M

1

[Obj]

Auth information of Cloud

authInfoItem:

Attribute

Qualifier

Default

Content

Description

Attribute

Qualifier

Default

Content

Description

cloudDomain

M

 

String

domain info for keystone v3

userName

M

 

String

User name

password

M

 

String

Password

authUrl

M

 

String

authentication url of the cloud, e.g. keystone url

sslCacert

O

 

String

ca file content if enabled ssl on auth-url

sslInsecure

O

 

Boolean

Whether to verify VIM's certificate

Request Sample:
/api/aai-esr-server/v1/vims

Body:

{
"cloudOwner": "ZTE",
"cloudRegionId": "region-one",
"cloudType": "openstack",
"cloudRegionVersion": "v1.0",
"ownerDefinedType": "owner-defined-type",
"cloudZone": "cloud zone",
"complexName": "complex name",
"cloudExtraInfo": "cloud-extra-info",
"vimAuthInfos":
[{
"userName": "admin",
"password": "admin",
"authUrl": "http://10.74.151.13:5000/v2.0",
"sslCacert": "ssl-cacert",
"sslInsecure": true,
"cloudDomain": "cloud-domain"
}]
}

 

Response:

Success Code: 200

body:

{
"cloudOwner": "ZTE",
"cloudRegionId": "region-one"
}

Errorcode: 500 Internal Server Error

Update VIM info

Interface Definition

Description

URI

/api/aai-esr-server/v1/vims/{cloudOwner}/{cloudRegionId}

Operation Type

PUT

Request Body:

   

Attribute

Qualifier

Default

Content

Description

cloudType

M

 

String

type of the cloud, decides which multicloud plugin to use, openstack or vio

cloudRegionVersion

M

 

String

cloud version, ocata, mitaka or other

ownerDefinedType

O

 

String

Cloud-owner defined type indicator (e.g., dcp, lcp)

cloudZone

O

 

String

Zone where the cloud is homed.

complexName

O

 

String

complex name for cloud-region instance.

cloudExtraInfo

O

 

String

extra info for Cloud

vimAuthInfos

M

 

[Obj]

Auth information of Cloud

authInfoItem:

Attribute

Qualifier

Default

Content

Description

Attribute

Qualifier

Default

Content

Description

cloudDomain

M

 

String

domain info for keystone v3

userName

M

 

String

User name

password

M

 

String

Password

authUrl

M

 

String

authentication url of the cloud, e.g. keystone url

sslCacert

O

 

String

ca file content if enabled ssl on auth-url

sslInsecure

O

 

Boolean

Whether to verify VIM's certificate


Request Sample:
/api/aai-esr-server/v1/vims/ZTE/region-one

{
"cloudOwner": "ZTE",
"cloudRegionId": "region-one",
"cloudType": "openstack",
"cloudRegionVersion": "v1.0",
"ownerDefinedType": "owner-defined-type",
"cloudZone": "cloud zone",
"complexName": "complex name",
"cloudExtraInfo": "cloud-extra-info",
"vimAuthInfos":
[{
"userName": "admin",
"password": "admin",
"authUrl": "http://10.74.151.13:5000/v2.0",
"sslCacert": "ssl-cacert",
"sslInsecure": true,
"cloudDomain": "cloud-domain"
}]
}

Get VIM

Interface Definition

Description

URI

/api/aai-esr-server/v1/vims/{cloudOwner}/{cloudRegionId}

Operation Type

GET

Request Parameters:

Attribute

Qualifier

Cardinality

Content

Description

cloudOwner

M

1

String

Cloud owner

cloudRegionId

M

1

String

Cloud region

Request Sample:
/api/aai-esr-server/v1/vims/ZTE/region-one

Response Parameters:

VIM

Get all VIM

Interface Definition

Description

URI

/api/aai-esr-server/v1/vims

Operation Type

GET

Request Parameters:
N/A

Request Sample:
/api/aai-esr-server/v1/vims

Response Parameters:
List<VIM>

Delete VIM

Interface Definition

Description

URI

/api/aai-esr-server/v1/vims/{cloudOwner}/{cloudRegionId}

Operation Type

DELETE

Request Parameters:

Attribute

Qualifier

Cardinality

Content

Description

vimId

M

1

String

VIM identifier

Request Sample:
/api/aai-esr-server/v1/vims/owner/region-one

Response:

Success Code: 204

Errorcode: 500 Internal Server Error

VNFM

VNFM registration

Interface Definition

Description

URI

/api/aai-esr-server/v1/vnfms

Operation Type

POST

Request Parameters:

Attribute

Qualifier

Cardinality

Content

Description

name

M

1

String

VNFM name

type

M

1

String

VNFM type

vimId

O

0..1

String

Related VIM

vendor

M

1

String

VNFM vendor

version

M

1

String

VNFM version

certificateUrl

O

0..1

String

certificate url

Comments