View The Splunk instance properties and update with Splunk cluster details

This operation is used to get the Splunk instance properties

Path Parameters

• instanceId string required

  Splunk Instance Id

Responses

• 200
• 401
• 404

---

OK

application/json

• Schema
• Example (from schema)
• Get Splunk Instance with General cluster details

---

Schema

• instanceProperties object

  excludeFromSLA boolean

  instance object

  instanceId integer

  clientId integer

  applicationId integer

  distributedClusterInstance object

  clusterType integer

  opType integer

  instance object

  instanceName string

  instanceId integer

  clusterConfig object

  splunkConfig object

  primaryNode object

  entity object

  clientId integer

  clientName string

  splunkUserCredInfo object

  credentialId integer

  credentialName string

  url string

{
  "instanceProperties": {
    "excludeFromSLA": true,
    "instance": {
      "instanceId": 0,
      "clientId": 0,
      "applicationId": 0
    },
    "distributedClusterInstance": {
      "clusterType": 0,
      "opType": 0,
      "instance": {
        "instanceName": "string",
        "instanceId": 0
      },
      "clusterConfig": {
        "splunkConfig": {
          "primaryNode": {
            "entity": {
              "clientId": 0,
              "clientName": "string"
            }
          },
          "splunkUserCredInfo": {
            "credentialId": 0,
            "credentialName": "string"
          },
          "url": "string"
        }
      }
    }
  }
}

{
  "instanceProperties": {
    "excludeFromSLA": false,
    "instance": {
      "instanceId": 210,
      "clientId": 212,
      "applicationId": 64
    },
    "distributedClusterInstance": {
      "clusterType": 16,
      "opType": 2,
      "instance": {
        "instanceName": "xxx",
        "instanceId": 210
      },
      "clusterConfig": {
        "splunkConfig": {
          "primaryNode": {
            "entity": {
              "clientId": 177,
              "clientName": "xxx"
            }
          },
          "splunkUserCredInfo": {
            "credentialId": 117,
            "credentialName": "xxxx"
          },
          "url": "https://xx.xx.xx.xx:8089"
        }
      }
    }
  }
}

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...