Get Cloud Connection Details
Select
Get details of one cloud connection
Path Parameters
- cloudConnectionId int32 required
Id of an existing cloud connection
- 200
- 400
- 500
Success
- application/json
- Schema
- Example (from schema)
Schema
cloudConnection object
Summary of a cloud connection entity
id int32name stringdisplayName stringcloudType CloudConnectionCloudTypePossible values: [
AMAZON_WEB_SERVICES
,MICROSOFT_AZURE
]Cloud type for the connection.
credentials object
Credentials for cloud connections
credentialType CloudConnectionCredentialTypePossible values: [
AWS_STS_ASSUME_ROLE
,AWS_IAM_ROLE
]Type of credential to be used to access cloud connection.
credentialId int32ID of the saved credentials.
accessNodes object[]
List of servers and server groups to use to access the connection.
id int32name stringdisplayName stringaccessNodeType AccessNodeItemTypePossible values: [
SERVER
,SERVER_GROUP
]Type of access node item
cloudSpecificDetails object
Details specific to connections cloud type.
aws object
AWS specific cloud connection configuration.
regions stringList of AWS regions to connect to.
organizationId stringId of the AWS organization.
organizationArn stringARN of the AWS organization.
masterAccountId stringId of the AWS organization's management account.
masterAccountArn stringARN of the AWS organization's management account.
masterAccountEmail stringE-mail of the AWS organization's management account.
azure object
Azure specific cloud connection configuration.
tenantId stringAzure Tenant Id
tenantName stringAzure Tenant Name
environment stringAzure environment
subscriptions object[]
List of Azure Subscriptions
name stringcloud account name
id stringcloud account id
uuid stringThe globally unique identifier for the account
email stringemail for cloud account
discoverAllSubscription booleanDefault value:
false
Automatically discover future subscription in Azure tenant.
{
"cloudConnection": {
"id": 0,
"name": "string",
"displayName": "string",
"cloudType": "AMAZON_WEB_SERVICES",
"credentials": {
"credentialType": "AWS_STS_ASSUME_ROLE",
"credentialId": 0
},
"accessNodes": [
{
"id": 0,
"name": "string",
"displayName": "string",
"accessNodeType": "SERVER"
}
],
"cloudSpecificDetails": {
"aws": {
"regions": "string",
"organizationId": "string",
"organizationArn": "string",
"masterAccountId": "string",
"masterAccountArn": "string",
"masterAccountEmail": "string"
},
"azure": {
"tenantId": "string",
"tenantName": "string",
"environment": "string",
"subscriptions": [
{
"name": "string",
"id": "string",
"uuid": "string",
"email": "string"
}
],
"discoverAllSubscription": false
}
}
}
}
Bad Request
- application/json
- Schema
- Example (from schema)
Schema
- errorMessage string
Tells about the error occured
- errorCode ErrorCode
Possible values: [
NO_ERROR
,INVALID_INPUT
,VALUE_NOT_FOUND
,UNKNOWN_EXCEPTION
,CONNECTION_PROBLEM
,UNKNOWN_SQL_ERROR
,INVALID_USER
,INVALID_OPERATION_TYPE
,INTERNAL_SERVER_PROBLEM
,INSUFFICIENT_USER_PERMISSION_ON_ENTITY
,INVALID_ENTITY_ID
,REFRESH_TOKEN_EXPIRED
]Error code value
{
"errorMessage": "string",
"errorCode": "NO_ERROR"
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
Schema
- errorMessage string
Tells about the error occured
- errorCode ErrorCode
Possible values: [
NO_ERROR
,INVALID_INPUT
,VALUE_NOT_FOUND
,UNKNOWN_EXCEPTION
,CONNECTION_PROBLEM
,UNKNOWN_SQL_ERROR
,INVALID_USER
,INVALID_OPERATION_TYPE
,INTERNAL_SERVER_PROBLEM
,INSUFFICIENT_USER_PERMISSION_ON_ENTITY
,INVALID_ENTITY_ID
,REFRESH_TOKEN_EXPIRED
]Error code value
{
"errorMessage": "string",
"errorCode": "NO_ERROR"
}