View YugabyteDB instance properties
Select
SaaS
Customer Managed
This API is used to view YugabyteDB instance properties
Path Parameters
- instanceid string required
Responses
- 200
- 401
- 404
OK
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
instanceProperties object[]
isDeleted booleanapplicationSize integerexcludeFromSLA booleanscIdxEnabled integerisSnapEnabled booleanautoDiscovered booleanstatus integerinstance object
clientName stringinstanceName stringdisplayName stringinstanceId integerinstanceGUID stringclientId integerappName stringapplicationId integerdistributedClusterInstance object
clusterType integerinstance object
instanceName stringinstanceId integerclusterConfig object
yugabytedbConfig object
dbHost stringuser stringcustomerConfig object
name stringuuid stringuniverse object
name stringuuid stringcustomer object
name stringuuid stringconfig object
sslCMCredInfo object
credentialId integerstaging object
stagingType integerserviceHost stringcloudURL stringstagingPath stringstagingCredentials object
_type_ integercredentialId integercredentialName stringdataAccessNodes object
dataAccessNodes object[]
hostName stringclientId integerclientName stringdisplayName string_type_ integerinstanceActivityControl object
activityControlOptions object[]
activityType integerenableAfterADelay booleanenableActivityType booleancredentialEntity object
credentialId integercredentialName stringcloudDBInstance object
overRideAccessNode booleanaccessNodes object
{
"instanceProperties": [
{
"isDeleted": true,
"applicationSize": 0,
"excludeFromSLA": true,
"scIdxEnabled": 0,
"isSnapEnabled": true,
"autoDiscovered": true,
"status": 0,
"instance": {
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"instanceId": 0,
"instanceGUID": "string",
"clientId": 0,
"appName": "string",
"applicationId": 0
},
"distributedClusterInstance": {
"clusterType": 0,
"instance": {
"instanceName": "string",
"instanceId": 0
},
"clusterConfig": {
"yugabytedbConfig": {
"dbHost": "string",
"user": "string",
"customerConfig": {
"name": "string",
"uuid": "string"
},
"universe": {
"name": "string",
"uuid": "string"
},
"customer": {
"name": "string",
"uuid": "string"
}
},
"config": {
"sslCMCredInfo": {
"credentialId": 0
},
"staging": {
"stagingType": 0,
"serviceHost": "string",
"cloudURL": "string",
"stagingPath": "string",
"stagingCredentials": {
"_type_": 0,
"credentialId": 0,
"credentialName": "string"
}
}
}
},
"dataAccessNodes": {
"dataAccessNodes": [
{
"hostName": "string",
"clientId": 0,
"clientName": "string",
"displayName": "string",
"_type_": 0
}
]
}
},
"instanceActivityControl": {
"activityControlOptions": [
{
"activityType": 0,
"enableAfterADelay": true,
"enableActivityType": true
}
]
},
"credentialEntity": {
"credentialId": 0,
"credentialName": "string"
},
"cloudDBInstance": {
"overRideAccessNode": true,
"accessNodes": {}
}
}
]
}
{
"instanceProperties": [
{
"isDeleted": false,
"applicationSize": 0,
"excludeFromSLA": false,
"scIdxEnabled": 1,
"isSnapEnabled": false,
"autoDiscovered": false,
"status": 0,
"instance": {
"clientName": "yb-apidoc",
"instanceName": "yb-apidoc",
"displayName": "yb-apidoc",
"instanceId": 39,
"instanceGUID": "7A904FF3-3989-4B81-AD90-BCF2EDFE0E6A",
"clientId": 62,
"appName": "Big Data Apps",
"applicationId": 64
},
"distributedClusterInstance": {
"clusterType": 19,
"instance": {
"instanceName": "yb-apidoc",
"instanceId": 39
},
"clusterConfig": {
"yugabytedbConfig": {
"dbHost": "172.16.100.10",
"user": "",
"customerConfig": {
"name": "apsouth1",
"uuid": "a7899c70-aed1-412b-kacjmnbv43"
},
"universe": {
"name": "on-prem1",
"uuid": "33f85e10-70db-4bd0-b5mhnb4161"
},
"customer": {
"name": "",
"uuid": "1e9b3d21-d668-4eb2-a3mjhff160"
}
},
"config": {
"sslCMCredInfo": {
"credentialId": 0
},
"staging": {
"stagingType": 1,
"serviceHost": "s3.amazonaws.com",
"cloudURL": "s3.amazonaws.com",
"stagingPath": "/yb-apsouth1",
"stagingCredentials": {
"_type_": 174,
"credentialId": 3,
"credentialName": "s3"
}
}
}
},
"dataAccessNodes": {
"dataAccessNodes": [
{
"hostName": "",
"clientId": 12,
"clientName": "testcb1",
"displayName": "testcb1",
"_type_": 3
},
{
"hostName": "",
"clientId": 11,
"clientName": "testcb2",
"displayName": "testcb2",
"_type_": 3
}
]
}
},
"instanceActivityControl": {
"activityControlOptions": [
{
"activityType": 1,
"enableAfterADelay": false,
"enableActivityType": true
},
{
"activityType": 2,
"enableAfterADelay": false,
"enableActivityType": true
}
]
},
"credentialEntity": {
"credentialId": 0,
"credentialName": ""
},
"cloudDBInstance": {
"overRideAccessNode": false,
"accessNodes": {}
}
}
]
}
Unauthorized
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "Access Denied",
"errorCode": 5
}
Not Found
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "string",
"errorCode": 0
}
Loading...