Browse DocumentDB clusters on AWS

Select

SaaS

Customer Managed

This operation fetches DocumentDB Clusters for the cloud account.

application/json

Request Body

• instanceType integer
• clientEntity object

  clientId integer required

  clientName string required

  cloud account name

• appId object

  clientName string

  clientId integer

  instanceId integer

  applicationId integer
• browseTargetType object

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• cloudDBEntity object

  type integer

  children object[]

  displayName string

  name string

  type integer
• errorResp object

  errorCode integer

{
  "cloudDBEntity": {
    "type": 0,
    "children": [
      {
        "displayName": "string",
        "name": "string",
        "type": 0
      }
    ]
  },
  "errorResp": {
    "errorCode": 0
  }
}

{
  "cloudDBEntity": {
    "type": 17,
    "children": [
      {
        "displayName": "US East (N. Virginia) (us-east-1)",
        "name": "us-east-1",
        "type": 4
      }
    ]
  },
  "errorResp": {
    "errorCode": 0
  }
}

POST /cloudapps/clouddbcontentpreview    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://ServerURL/commandcenter/api

Security Scheme

tokenbearerToken

token

Body

• Default
• Example 1

---

{
  "instanceType": 0,
  "clientEntity": {
    "clientId": 0,
    "clientName": "string"
  },
  "appId": {
    "clientName": "string",
    "clientId": 0,
    "instanceId": 0,
    "applicationId": 0
  },
  "browseTargetType": {}
}

curl -L -X POST 'https://ServerURL/commandcenter/api/CloudApps/CloudDBContentPreview' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceType": 0,
  "clientEntity": {
    "clientId": 0,
    "clientName": "string"
  },
  "appId": {
    "clientName": "string",
    "clientId": 0,
    "instanceId": 0,
    "applicationId": 0
  },
  "browseTargetType": {}
}'

curl -L -X POST 'https://ServerURL/commandcenter/api/CloudApps/CloudDBContentPreview' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceType": 0,
  "clientEntity": {
    "clientId": 0,
    "clientName": "string"
  },
  "appId": {
    "clientName": "string",
    "clientId": 0,
    "instanceId": 0,
    "applicationId": 0
  },
  "browseTargetType": {}
}'

curl -L -X POST 'https://ServerURL/commandcenter/api/CloudApps/CloudDBContentPreview' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceType": 0,
  "clientEntity": {
    "clientId": 0,
    "clientName": "string"
  },
  "appId": {
    "clientName": "string",
    "clientId": 0,
    "instanceId": 0,
    "applicationId": 0
  },
  "browseTargetType": {}
}'

curl -L -X POST 'https://ServerURL/commandcenter/api/CloudApps/CloudDBContentPreview' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceType": 0,
  "clientEntity": {
    "clientId": 0,
    "clientName": "string"
  },
  "appId": {
    "clientName": "string",
    "clientId": 0,
    "instanceId": 0,
    "applicationId": 0
  },
  "browseTargetType": {}
}'

curl -L -X POST 'https://ServerURL/commandcenter/api/CloudApps/CloudDBContentPreview' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceType": 0,
  "clientEntity": {
    "clientId": 0,
    "clientName": "string"
  },
  "appId": {
    "clientName": "string",
    "clientId": 0,
    "instanceId": 0,
    "applicationId": 0
  },
  "browseTargetType": {}
}'

curl -L -X POST 'https://ServerURL/commandcenter/api/CloudApps/CloudDBContentPreview' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceType": 0,
  "clientEntity": {
    "clientId": 0,
    "clientName": "string"
  },
  "appId": {
    "clientName": "string",
    "clientId": 0,
    "instanceId": 0,
    "applicationId": 0
  },
  "browseTargetType": {}
}'

curl -L -X POST 'https://ServerURL/commandcenter/api/CloudApps/CloudDBContentPreview' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceType": 0,
  "clientEntity": {
    "clientId": 0,
    "clientName": "string"
  },
  "appId": {
    "clientName": "string",
    "clientId": 0,
    "instanceId": 0,
    "applicationId": 0
  },
  "browseTargetType": {}
}'