get serverGroup
GET/projects/:projectId/zones/:zoneName/servergroups/:serverGroupId
Get the Server Group with its id in the path.
Request
Path Parameters
Project Identifier
Zone name
Server Group identifier.
Header Parameters
Your SIU token if you use this API through Orange Developer.
Bearer access token authentication if you use this API through Orange Developer or Orange Developer Inside.
Your SIU Id if you use this API through Orange Developer Inside.
Responses
- 200
- 400
- 401
- 403
- 404
- 405
- 500
- 503
Ok
- application/json
- Schema
- Example (from schema)
Schema
- creating: resource creation in progress
- updating: resource update in progress
- deleting: resource deletion in progress
- active: resource created/updated successfully
- error: resource in error because the last creation/update/deletion failed
- affinity: places instances on the same host.
- anti-affinity: place instances on separate hosts.
- soft-anti-affinity: place instances on separate hosts if possible.
- soft-affinity: place instances on the same host if possible.
Possible values: <= 40 characters
, Value must match regular expression [A-Za-z0-9-]
Unique resource name. This attribute can not be updated.
Resource description
tags
object
Tags associated with the resource
Resource identifier.
Hypertext reference of the resource.
Creation date of the resource.
Date of the last modification of the resource.
Identifier of the user of the last create/update/delete operation requested on the resource.
Possible values: [creating
, updating
, deleting
, active
, error
]
Provisioning state of the resource. Possible state:
Possible values: [affinity
, anti-affinity
, soft-anti-affinity
, soft-affinity
]
Affinity policy of the server group. It defines how the compute is selected.
{
"name": "string",
"description": "string",
"tags": {},
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"hRef": "string",
"createdDate": "2024-10-02T15:25:04.247Z",
"lastModifiedDate": "2024-10-02T15:25:04.247Z",
"lastRequesterId": "string",
"provisioningState": "creating",
"policy": "affinity"
}
Bad Request
Request is not valid
- application/json
- Schema
- Example (from schema)
Schema
An integer coding the error type. This is given to caller so he can translate them if required.
A short localized string that describes the error.
(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.
{
"code": 0,
"message": "string",
"description": "string"
}
Unauthorized
Credentials are missing
- application/json
- Schema
- Example (from schema)
Schema
An integer coding the error type. This is given to caller so he can translate them if required.
A short localized string that describes the error.
(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.
{
"code": 0,
"message": "string",
"description": "string"
}
Forbidden
Valid credentials but not enough privileges to perform the operation
- application/json
- Schema
- Example (from schema)
Schema
An integer coding the error type. This is given to caller so he can translate them if required.
A short localized string that describes the error.
(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.
{
"code": 0,
"message": "string",
"description": "string"
}
Not Found
Unknown resource or service
- application/json
- Schema
- Example (from schema)
Schema
An integer coding the error type. This is given to caller so he can translate them if required.
A short localized string that describes the error.
(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.
{
"code": 0,
"message": "string",
"description": "string"
}
Method Not Allowed
Operation is not valid according to the state of the resource
- application/json
- Schema
- Example (from schema)
Schema
An integer coding the error type. This is given to caller so he can translate them if required.
A short localized string that describes the error.
(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.
{
"code": 0,
"message": "string",
"description": "string"
}
Internal Server Error
Unexpected error, please contact support
- application/json
- Schema
- Example (from schema)
Schema
An integer coding the error type. This is given to caller so he can translate them if required.
A short localized string that describes the error.
(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.
{
"code": 0,
"message": "string",
"description": "string"
}
Service Unavailable
Service probably in maintenance. Please retry later.
- application/json
- Schema
- Example (from schema)
Schema
An integer coding the error type. This is given to caller so he can translate them if required.
A short localized string that describes the error.
(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.
{
"code": 0,
"message": "string",
"description": "string"
}