Retrieve details on supported software (GET /v1.0/software_support)
Retrieves details on all supported software.
Request headers
X-Auth-Token
Specify the authentication token.
| Data type | Cardinality |
|---|---|
| String | 1..1 |
Request parameters
TenantID
Specify the project ID.
Only the project ID to which the user belongs can be specified (the project ID is included in the authentication token). An error will be returned if a project ID that the user does not belong to is specified.
If omitted, the project ID that the user belongs to will be targeted.
| Data type | Cardinality |
|---|---|
| String | 0..1 |
InstanceID
Specify the instance ID.
If omitted, all instance IDs will be targeted.
| Data type | Cardinality |
|---|---|
| String | 0..1 |
SoftwareID
Specify the software ID.
If omitted, all Software IDs will be targeted.
SoftwareID is required if InstanceID is specified. An error will be returned if SoftwareID is specified but InstanceID is not.
| Data type | Cardinality |
|---|---|
| String | 0..1 |
SupportID
Specify the support ID.
If omitted, all support IDs will be targeted.
SupportID is required if SoftwareID is specified. An error will be returned if SupportID is specified but SoftwareID is not.
| Data type | Cardinality |
|---|---|
| String | 0..1 |
Response headers
Content-Type
Returns "Application/xml".
| Data type | Cardinality |
|---|---|
| String | 1..1 |
Response elements
SupportSoftwares
Details on all supported software (root element)
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| String | 1..1 | None | SupportSoftware |
SupportSoftware
Details on a retrieved supported software
Note: This tag is not displayed if the following condition is met:
If no details exist under the target SupportSoftware
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| String | 0..n | SupportSoftwares | TenantID InstanceID Image ID SoftwareID SupportID UpdateDate |
TenantID
Tenant ID
Note: If the SupportSoftware tag is not displayed, this tag is not displayed either.
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| String | 0..1 | SupportSoftware | None |
InstanceID
Instance ID
Note: If the SupportSoftware tag is not displayed, this tag is not displayed either.
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| String | 0..1 | SupportSoftware | None |
Image ID
Image ID
Note: If the SupportSoftware tag is not displayed, this tag is not displayed either.
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| String | 0..1 | SupportSoftware | None |
SoftwareID
Software ID
Note: If the SupportSoftware tag is not displayed, this tag is not displayed either.
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| String | 0..1 | SupportSoftware | None |
SupportID
Support ID
Note: If the SupportSoftware tag is not displayed, this tag is not displayed either.
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| String | 0..1 | SupportSoftware | None |
UpdateDate
Update date
Note: If the SupportSoftware tag is not displayed, this tag is not displayed either.
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| String | 0..1 | SupportSoftware | None |
Example of request
GET
/v1.0/software_support?TenantID=tenant1&InstanceID=instance1
X-Auth-Token:MIIZuwYJKoZIhvcNAQc . . .
Example of response
When details on supported software exist:
HTTP/1.1 200 OK
Date: Sun,31 Aug 2014 00:00:00 GMT
Content-Length: 5000
Content-Type: application/xml
<?xml version="1.0" encoding="UTF-8"?>
<SupportSoftwares>
<SupportSoftware>
<TenantID>tenant1</TenantID>
<InstanceID>instance1</InstanceID>
<ImageID>image1</ImageID>
<SoftwareID>RHEL</SoftwareID>
<SupportID>nosupport</SupportID>
<UpdateDate>2014.8.31</UpdateDate>
</SupportSoftware>
<SupportSoftware>
<TenantID>tenant1</TenantID>
<InstanceID>instance1</InstanceID>
<ImageID>RHEL</ImageID>
<SoftwareID>sq2012</SoftwareID>
<SupportID>spt_24h</SupportID>
<UpdateDate>2014.8.31</UpdateDate>
</SupportSoftware>
<SupportSoftware>
<TenantID>tenant1</TenantID>
<InstanceID>instance1</InstanceID>
<ImageID>RHEL</ImageID>
<SoftwareID>sq2012</SoftwareID>
<SupportID>spt_daytime</SupportID>
<UpdateDate>2014.8.31</UpdateDate>
</SupportSoftware>
</SupportSoftwares>
When details on supported software do not exist:
HTTP/1.1 200 OK
Date: Sun,31 Aug 2014 00:00:00 GMT
Content-Length: 5000
Content-Type: application/xml
<?xml version="1.0" encoding="UTF-8"?>
<SupportSoftwares/>