List the details of all NFV images with the given family name
Since Product Version: 3.1
Resource Information
Rate Limiting? |
Yes |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Read |
HTTP Methods |
GET |
DevNet Discussions
Resource URL
/webacs/api/v3/op/image/list/family UnmodifiedThis resource has not been modified since the previous API version.
Request Parameters
Attribute | Source | Description |
---|---|---|
familyName String |
query |
Optional |
Response Parameters
Attribute | Description |
---|---|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://localhost/webacs/api/v3/op/image/list/family
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v3/op/image/list/family" rootUrl="https://localhost/webacs/api/v3/op">
<imageListDTO>
<imageList>
<image>
<applicationType>String value</applicationType>
<family>String value</family>
<imageId>2</imageId>
<imageLocation>String value</imageLocation>
<imageType>String value</imageType>
<lastModified>String value</lastModified>
<name>String value</name>
<ovaProfiles>
<ovaProfile>
<description>String value</description>
<memory>1</memory>
<profileName>String value</profileName>
<shares>1</shares>
<vcpu>1</vcpu>
</ovaProfile>
<ovaProfile>
<description>String value</description>
<memory>1</memory>
<profileName>String value</profileName>
<shares>1</shares>
<vcpu>1</vcpu>
</ovaProfile>
</ovaProfiles>
<size>String value</size>
<userInputInfo>
<maxCPU>3.0</maxCPU>
<maxMemory>3.0</maxMemory>
<maxStorage>3.0</maxStorage>
<minCPU>3.0</minCPU>
<minMemory>3.0</minMemory>
<minStorage>3.0</minStorage>
</userInputInfo>
<version>String value</version>
</image>
<image>
<applicationType>String value</applicationType>
<family>String value</family>
<imageId>2</imageId>
<imageLocation>String value</imageLocation>
<imageType>String value</imageType>
<lastModified>String value</lastModified>
<name>String value</name>
<ovaProfiles>
<ovaProfile>
<description>String value</description>
<memory>1</memory>
<profileName>String value</profileName>
<shares>1</shares>
<vcpu>1</vcpu>
</ovaProfile>
</ovaProfiles>
<size>String value</size>
<userInputInfo>
<maxCPU>3.0</maxCPU>
<maxMemory>3.0</maxMemory>
<maxStorage>3.0</maxStorage>
<minCPU>3.0</minCPU>
<minMemory>3.0</minMemory>
<minStorage>3.0</minStorage>
</userInputInfo>
<version>String value</version>
</image>
</imageList>
</imageListDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v3/op/image/list/family.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v3/op/image/list/family",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v3/op",
"imageListDTO" : [ {
"imageList" : {
"image" : [ {
"applicationType" : "String value",
"family" : "String value",
"imageId" : 2,
"imageLocation" : "String value",
"imageType" : "String value",
"lastModified" : "String value",
"name" : "String value",
"ovaProfiles" : {
"ovaProfile" : [ {
"description" : "String value",
"memory" : 1,
"profileName" : "String value",
"shares" : 1,
"vcpu" : 1
}, {
"description" : "String value",
"memory" : 1,
"profileName" : "String value",
"shares" : 1,
"vcpu" : 1
} ]
},
"size" : "String value",
"userInputInfo" : {
"maxCPU" : 3.0,
"maxMemory" : 3.0,
"maxStorage" : 3.0,
"minCPU" : 3.0,
"minMemory" : 3.0,
"minStorage" : 3.0
},
"version" : "String value"
}, {
"applicationType" : "String value",
"family" : "String value",
"imageId" : 2,
"imageLocation" : "String value",
"imageType" : "String value",
"lastModified" : "String value",
"name" : "String value",
"ovaProfiles" : {
"ovaProfile" : [ {
"description" : "String value",
"memory" : 1,
"profileName" : "String value",
"shares" : 1,
"vcpu" : 1
} ]
},
"size" : "String value",
"userInputInfo" : {
"maxCPU" : 3.0,
"maxMemory" : 3.0,
"maxStorage" : 3.0,
"minCPU" : 3.0,
"minMemory" : 3.0,
"minStorage" : 3.0
},
"version" : "String value"
} ]
}
} ]
}
}