Get a specified ManagedCluster.
Retrieve a ManagedCluster by ID.
Path Parameters
- id string required
ID of the ManagedCluster to get
- 200
- 400
- 403
- 404
Responds with ManagedCluster having the given ID.
- application/json
- Schema
- Example (from schema)
Schema
- id string
ManagedCluster ID
- name string
ManagedCluster name
- pod string
ManagedCluster pod
- org string
ManagedCluster org
- type string
Possible values: [
idn
,iai
]The Type of Cluster
configuration object
ManagedProcess configuration map
property name*
stringkeyPair object
key pair for the ManagedCluster
publicKey stringManagedCluster publicKey
publicKeyThumbprint stringManagedCluster publicKeyThumbprint
publicKeyCertificate stringManagedCluster publicKeyCertificate
attributes object
Specific Attributes for Configuring a ManagedCluster by Type
queue object
ManagedCluster keystore for sqsCluster type
name stringManagedCluster queue name
region stringManagedCluster queue aws region
keystore stringManagedCluster keystore for spConnectCluster type
- description string
ManagedCluster description
redis object
Redis configuration for the ManagedCluster
redisHost stringManagedCluster redisHost
redisPort int32ManagedCluster redisPort
- clientType string
Possible values: [
CCG
,VA
,INTERNAL
]type of client for the ManagedCluster
- ccgVersion string
CCG version used by the ManagedCluster
- pinnedConfig boolean
Default value:
false
boolean flag indiacting whether or not the cluster configuration is pinned
logConfiguration object
client log configuration for the cluster
clientId stringclient ID of the Log configuration
durationMinutes int32Possible values:
>= 5
and<= 1440
duration in minutes for the log configuration to remain in effect before resetting to defaults
expiration date-timeExpiration date-time of the log configuration request
rootLevel stringPossible values: [
OFF
,FATAL
,ERROR
,WARN
,INFO
,DEBUG
,TRACE
]Default value:
INFO
Root Log level to apply
logLevels object
Map of LogLevel by key
property name*
stringPossible values: [
OFF
,FATAL
,ERROR
,WARN
,INFO
,DEBUG
,TRACE
]- operational boolean
Default value:
false
Whether or not the cluster is operational or not
- status string
Cluster status
- publicKeyCertificate string
Public key certificate
- publicKeyThumbprint string
Public key thumbprint
- publicKey string
Public key
- alertKey string
Key describing any immediate cluster alerts
- clientIds string[]
List of clients in a cluster
- serviceCount int32
Number of services bound to a cluster
- ccId string
Default value:
0
CC ID only used in calling CC, will be removed without notice when Migration to CEGS is finished
{
"id": "aClusterId",
"name": "Managed Cluster Name",
"pod": "megapod-useast1",
"org": "denali",
"type": "idn",
"configuration": {
"clusterExternalId": "externalId",
"ccgVersion": "77.0.0"
},
"keyPair": {
"publicKey": "-----BEGIN PUBLIC KEY-----******-----END PUBLIC KEY-----",
"publicKeyThumbprint": "6CMlaJIV44-xJxcB3CJBjDUUn54",
"publicKeyCertificate": "-----BEGIN CERTIFICATE-----****-----END CERTIFICATE-----"
},
"attributes": {
"queue": {
"name": "megapod-useast1-denali-lwt-cluster-1533",
"region": "us-east-1"
},
"keystore": "/u3+7QAAAAIAAAABAAAAAQAvL3Byb3h5LWNsdXN0ZXIvMmM5MTgwODc3Yjg3MW"
},
"description": "A short description of the managed cluster.",
"redis": {
"redisHost": "megapod-useast1-shared-redis.cloud.sailpoint.com",
"redisPort": 6379
},
"clientType": "CCG",
"ccgVersion": "v01",
"pinnedConfig": false,
"logConfiguration": "{ \"rootLevel\": \"WARN\", \"logLevels\": { \"foobar\": \"WARN\" } }",
"operational": false,
"status": "NORMAL",
"publicKeyCertificate": "-----BEGIN CERTIFICATE-----TCCAb2gAwIBAgIBADANBgkqhkiG9w0BAQsFADAuMQ0wCwYDVQQD-----END CERTIFICATE-----",
"publicKeyThumbprint": "obc6pLiulGbtZ",
"publicKey": "-----BEGIN PUBLIC KEY-----jANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA3WgnsxP52MDgBTfHR+5n4-----END PUBLIC KEY-----",
"alertKey": "LIMITED_RESOURCES",
"clientIds": [
"1244",
"1245"
],
"serviceCount": 6,
"ccId": "1533"
}
Client Error - Returned if the request body is invalid.
- application/json
- Schema
- Example (from schema)
Schema
- detailCode string
Fine-grained error code providing more detail of the error.
- trackingId string
Unique tracking id for the error.
messages object[]
Generic localized reason for error
locale stringThe locale for the message text, a BCP 47 language tag.
localeOrigin stringPossible values: [
DEFAULT
,REQUEST
]An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text stringActual text of the error message in the indicated locale.
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
locale stringThe locale for the message text, a BCP 47 language tag.
localeOrigin stringPossible values: [
DEFAULT
,REQUEST
]An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text stringActual text of the error message in the indicated locale.
{
"detailCode": "400.1 Bad Request Content",
"trackingId": "e7eab60924f64aa284175b9fa3309599",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The request was syntactically correct but its content is semantically invalid."
}
],
"causes": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The request was syntactically correct but its content is semantically invalid."
}
]
}
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
- application/json
- Schema
- Example (from schema)
- 403
Schema
- detailCode string
Fine-grained error code providing more detail of the error.
- trackingId string
Unique tracking id for the error.
messages object[]
Generic localized reason for error
locale stringThe locale for the message text, a BCP 47 language tag.
localeOrigin stringPossible values: [
DEFAULT
,REQUEST
]An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text stringActual text of the error message in the indicated locale.
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
locale stringThe locale for the message text, a BCP 47 language tag.
localeOrigin stringPossible values: [
DEFAULT
,REQUEST
]An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text stringActual text of the error message in the indicated locale.
{
"detailCode": "400.1 Bad Request Content",
"trackingId": "e7eab60924f64aa284175b9fa3309599",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The request was syntactically correct but its content is semantically invalid."
}
],
"causes": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The request was syntactically correct but its content is semantically invalid."
}
]
}
An example of a 403 response object
{
"detailCode": "403 Forbidden",
"trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The server understood the request but refuses to authorize it."
}
]
}
Not Found - returned if the request URL refers to a resource or object that does not exist
- application/json
- Schema
- Example (from schema)
- 404
Schema
- detailCode string
Fine-grained error code providing more detail of the error.
- trackingId string
Unique tracking id for the error.
messages object[]
Generic localized reason for error
locale stringThe locale for the message text, a BCP 47 language tag.
localeOrigin stringPossible values: [
DEFAULT
,REQUEST
]An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text stringActual text of the error message in the indicated locale.
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
locale stringThe locale for the message text, a BCP 47 language tag.
localeOrigin stringPossible values: [
DEFAULT
,REQUEST
]An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text stringActual text of the error message in the indicated locale.
{
"detailCode": "400.1 Bad Request Content",
"trackingId": "e7eab60924f64aa284175b9fa3309599",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The request was syntactically correct but its content is semantically invalid."
}
],
"causes": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The request was syntactically correct but its content is semantically invalid."
}
]
}
An example of a 404 response object
{
"detailCode": "404 Not found",
"trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The server did not find a current representation for the target resource."
}
]
}