Getting Information About Your Dedicated Groups
You can get information about your dedicated groups, such as their names, IDs, the Subregions in which they are located, their CPU generations or the VMs and Nets in the dedicated group.
Getting Information About Your Dedicated Groups Using OSC CLI
This feature is currently in beta. |
The ReadDedicatedGroups command list one or more dedicated groups of virtual machines (VMs).
$ osc-cli api ReadDedicatedGroups --profile "default" \
--Filters '{
"DedicatedGroupIds": ["ded-12345678"]
}'
$ osc-cli api ReadDedicatedGroups --profile "default" \
--Filters '{
"SubregionNames": ["eu-west-2a"],
"CpuGenerations": [4]
}'
This command contains the following attributes that you need to specify:
-
DryRun
: (optional) If true, checks whether you have the required permissions to perform the action. -
Filters
: (optional) One or more filters.-
CpuGenerations
: (optional) The processor generation for the VMs in the dedicated group (for example,4
). -
DedicatedGroupIds
: (optional) The IDs of the dedicated groups. -
Names
: (optional) The names of the dedicated groups. -
SubregionNames
: (optional) The names of the Subregions in which the dedicated groups are located.
-
-
NextPageToken
: (optional) The token to request the next page of results. Each token refers to a specific page. -
ResultsPerPage
: (optional) The maximum number of logs returned in a single response (between1
and1000
, both included). By default,100
.
The ReadDedicatedGroups command returns the following elements:
-
DedicatedGroups
: Information about one or more dedicated groups.-
AccountId
: The account ID of the owners of the dedicated group. -
CpuGeneration
: The processor generation. -
DedicatedGroupId
: The ID of the dedicated group. -
Name
: The name of the dedicated group. -
NetIds
: The IDs of the Nets in the dedicated group. -
SubregionName
: The name of the Subregion in which the dedicated group is located. -
VmIds
: The IDs of the VMs in the dedicated group.
-
-
NextPageToken
: The token to request the next page of results. Each token refers to a specific page. -
ResponseContext
: Information about the context of the response.-
RequestId
: The ID of the request.
-
{
"ResponseContext": {
"RequestId": "0475ca1e-d0c5-441d-712a-da55a4175157"
},
"DedicatedGroups": [
{
"VmIds": [
"i-12345678"
],
"NetIds": [],
"AccountId": "123456789012",
"CpuGeneration": 4,
"Name": "dedicated-group-example",
"SubregionName": "eu-west-2a",
"DedicatedGroupId": "ded-12345678"
}
]
}
Getting Information About Your Dedicated Groups Using oapi-cli
This feature is currently in beta. |
The ReadDedicatedGroups command list one or more dedicated groups of virtual machines (VMs).
$ oapi-cli --profile "default" ReadDedicatedGroups \
--Filters '{
"DedicatedGroupIds": ["ded-12345678"]
}'
$ oapi-cli --profile "default" ReadDedicatedGroups \
--Filters '{
"SubregionNames": ["eu-west-2a"],
"CpuGenerations": [4]
}'
This command contains the following attributes that you need to specify:
-
DryRun
: (optional) If true, checks whether you have the required permissions to perform the action. -
Filters
: (optional) One or more filters.-
CpuGenerations
: (optional) The processor generation for the VMs in the dedicated group (for example,4
). -
DedicatedGroupIds
: (optional) The IDs of the dedicated groups. -
Names
: (optional) The names of the dedicated groups. -
SubregionNames
: (optional) The names of the Subregions in which the dedicated groups are located.
-
-
NextPageToken
: (optional) The token to request the next page of results. Each token refers to a specific page. -
ResultsPerPage
: (optional) The maximum number of logs returned in a single response (between1
and1000
, both included). By default,100
.
The ReadDedicatedGroups command returns the following elements:
-
DedicatedGroups
: Information about one or more dedicated groups.-
AccountId
: The account ID of the owners of the dedicated group. -
CpuGeneration
: The processor generation. -
DedicatedGroupId
: The ID of the dedicated group. -
Name
: The name of the dedicated group. -
NetIds
: The IDs of the Nets in the dedicated group. -
SubregionName
: The name of the Subregion in which the dedicated group is located. -
VmIds
: The IDs of the VMs in the dedicated group.
-
-
NextPageToken
: The token to request the next page of results. Each token refers to a specific page. -
ResponseContext
: Information about the context of the response.-
RequestId
: The ID of the request.
-
{
"ResponseContext": {
"RequestId": "0475ca1e-d0c5-441d-712a-da55a4175157"
},
"DedicatedGroups": [
{
"VmIds": [
"i-12345678"
],
"NetIds": [],
"AccountId": "123456789012",
"CpuGeneration": 4,
"Name": "dedicated-group-example",
"SubregionName": "eu-west-2a",
"DedicatedGroupId": "ded-12345678"
}
]
}
Related Pages
Corresponding API Method