Querying Service Software Resource Information
Function
This interface is used to query resource information about a specified container service software.
Syntax
Operation type: GET
URL: https://device_ip/redfish/v1/Softwares/DockerServices/docker_id
Request header:
X-Auth-Token: auth_value
Request message body: None
Parameters
Parameter |
Description |
Value |
|---|---|---|
device_ip |
IP address for logging in to a device. |
An IPv4 or IPv6 address |
docker_id |
Identifies a container service software resource. |
You can obtain the value from redfish/v1/Softwares/DockerServices. |
auth_value |
Authentication parameter contained in the request. |
You can obtain the value from the session created by using /redfish/v1/SessionService/Sessions. |
Usage Guidelines
None
Example
Request:
GET https://10.10.10.10/redfish/v1/Softwares/DockerServices/1
Request header:
X-Auth-Token: 6599174c38c36838737d9749179e1ee1
Request message body: None
Response:
{
"@odata.context": "/redfish/v1/$metadata#Softwares/UserAgents/$entity",
"@odata.id": "/redfish/v1/Softwares/UserAgents/1",
"Id": "1",
"Name": "UserAgent",
"ServiceDescription": "",
"Version": "1.0.0",
"PackageName": "EdgeInstaller.zip",
"InstallDateTime": "2018-05-22T17:06:19+00:00",
"UpTime": "17:06:19",
"Status": {
"Health": "Ok",
"State": "Enabled"
},
"ResourceQuota": {
"CpuQuota": 0.4,
"MemQuota": 4000,
"StorageQuota": 0,
"AiQuota": 16TOPS
},
"Environments": [
{
"Key": "docker1_ip",
"Value": "192.168.100.1"
},
],
"Volumes": [
{
"Name": "/dev/sda2",
"MountPath": "/tmp0",
"TotalSize": "10GB",
"Method": "RW"
}
],
"Options": {
"Priviledge": true,
"RebootPolicy": "Always",
"UseHostNetwork": false,
"PortMap": [
{
"DockerPort": "443",
"HostPort": "10003"
}
]
},
"Actions": {
"Reset": {
"target": "/redfish/v1/Softwares/UserAgents/1/Actions/DockerService.Reset",
},
"Stop": {
"target": "/redfish/v1/Softwares/UserAgents/1/Actions/DockerService.Stop",
},
"Attach": {
"target": "/redfish/v1/Softwares/UserAgents/1/Actions/DockerService.Attach",
},
"Upgrade": {
"target": "/redfish/v1/Softwares/UserAgents/1/Actions/DockerService.Upgrade",
}
}
Response code: 200
Output Description
Attribute |
Type |
Description |
|---|---|---|
Id |
Character string |
ID of the container service software. |
Name |
Character string |
Name of the container service software. |
ServiceDescription |
Character string |
Description of the container service software. |
Version |
Character string |
Version of the container service software. |
PackageName |
Character string |
Name of the container service software installation package. |
InstallDateTime |
Character string |
Installation time. |
Uptime |
Character string |
Startup duration. |
Status |
Object |
Running status.
|
Group |
Character string |
Home group. |
ResourceQuota |
Object |
Resource quota. |
ResourceQuota.CpuQuota |
Character string |
CPU quota. |
ResourceQuota.MemQuota |
Character string |
Memory quota. |
ResourceQuota.StorageQuota |
Character string |
Storage quota. |
ResourceQuota.AiQuota |
Character string |
AI computing quota. |
Environments[] |
Array |
Environment variable of the container service. |
Environments[].Key |
Character string |
Name of the environment variable. |
Environments[].Value |
Character string |
Value of the environment variable. |
Volumes[] |
Array |
Volume attached to the container service. |
Volumes[].Name |
Character string |
Name of the volume to be attached. |
Volumes[].TotalSize |
Character string |
Size of the attached volume. |
Volumes[].MountPath |
Character string |
Mount path. |
Volumes[].Method |
Character string |
Method for the container service to access the attached volume. The value can be read-only or readable and writable. |
Options |
Object |
Options. |
Options.Priviledge |
Boolean |
Indicates whether the container service can directly access the hardware device. |
Options.RebootPolicy |
Character string |
Restart policy. |
Options.UseHostNetwork |
Boolean |
Whether to use the host network. |
Options.PortMap[] |
Array |
Container port mapping. |
Options.PortMap[].DockerPort |
Character string |
Port number of the container. |
Options.PortMap[].HostPort |
Character string |
Port number of the host. |
Actions |
Object |
Operations that can be performed. |
Actions.#UserAgent.Reset |
Object |
Reset operation. |
Actions.#UserAgent.Reset.target |
Character string |
URL of the service software resource to be reset. |
Actions.#UserAgent.Stop |
Object |
Stop operation. |
Actions.#UserAgent.Stop.target |
Character string |
URL of the service software resource to be stopped. |
Actions.#UserAgent.Attach |
Object |
Operation to add attachment data and profiles for the service software. |
Actions.#UserAgent.Attach.target |
Character string |
URL for adding an attachment. |
