GCP Object Storage client creation

Select

SaaS

Customer Managed

This operation creates the GCP Object Storage client

application/json

Request Body

• clientInfo object

  clientType integer required

  cloudClonnectorProperties object required

  instanceType string required

  Possible values: [GOOGLE_CLOUD]

  instance object required

  instance object required

  instanceName string

  commCellId integer

  applicationId integer

  cloudAppsInstance object required

  instanceTypeDisplayName string

  Possible values: [Google Cloud]

  instanceType string

  Possible values: [GOOGLE_CLOUD]

  generalCloudProperties object required

  numberOfBackupStreams integer

  Number of backup streams for default subclient

  memberServers object[]

  client object

  clientName string

  Access node name

  _type_ integer

  credentials object

  credentialName string

  objectStorageInstance object

  isCloudEncryptionKeySet boolean

  googleCloudInstance object required

  serverName string

  Default value: storage.googleapis.com

  Host url of the GCP cloud

  credentialType string required

  useResourcePoolInfo boolean

  plan object required

  planName string
• entity object

  clientName string required

Responses

• 200
• 400

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• processinginstructioninfo object

  attributes object[]

  name string

  value string
• response object

  errorCode integer

  entity object

  clientId integer

  clientName string

  _type_ integer

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "string",
        "value": "string"
      }
    ]
  },
  "response": {
    "errorCode": 0,
    "entity": {
      "clientId": 0,
      "clientName": "string",
      "_type_": 0
    }
  }
}

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "exitval",
        "value": "0"
      }
    ]
  },
  "response": {
    "errorCode": 0,
    "entity": {
      "clientId": 241,
      "clientName": "GCP",
      "_type_": 3
    }
  }
}

Bad Request

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• errorMessage string
• errorCode integer

{
  "errorMessage": "string",
  "errorCode": 0
}

{
  "errorMessage": "Invalid Parameter : Google Cloud: Authentication or Access Error: Make sure the credentials provided are correct and active, the Google Cloud resource exists. Also validate privileges. Error [Invalid argument. Details: Project id: 0 is invalid or not found.]",
  "errorCode": -1
}

POST /client    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/webconsole/api

Security Scheme

tokenbearerToken

token

Body

• Default
• GCP key based authentication payload
• GCP Service account based authentication

---

{
  "clientInfo": {
    "clientType": 0,
    "cloudClonnectorProperties": {
      "instanceType": "GOOGLE_CLOUD",
      "instance": {
        "instance": {
          "instanceName": "string",
          "commCellId": 0,
          "applicationId": 0
        },
        "cloudAppsInstance": {
          "instanceTypeDisplayName": "Google Cloud",
          "instanceType": "GOOGLE_CLOUD",
          "generalCloudProperties": {
            "numberOfBackupStreams": 0,
            "memberServers": [
              {
                "client": {
                  "clientName": "string",
                  "_type_": 0
                }
              }
            ],
            "credentials": {
              "credentialName": "string"
            }
          },
          "objectStorageInstance": {
            "isCloudEncryptionKeySet": true
          },
          "googleCloudInstance": {
            "serverName": "storage.googleapis.com"
          },
          "credentialType": "string"
        },
        "useResourcePoolInfo": true
      }
    },
    "plan": {
      "planName": "string"
    }
  },
  "entity": {
    "clientName": "string"
  }
}

curl -L -X POST 'https://CommandCenterHostName/webconsole/api/Client' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "clientInfo": {
    "clientType": 0,
    "cloudClonnectorProperties": {
      "instanceType": "GOOGLE_CLOUD",
      "instance": {
        "instance": {
          "instanceName": "string",
          "commCellId": 0,
          "applicationId": 0
        },
        "cloudAppsInstance": {
          "instanceTypeDisplayName": "Google Cloud",
          "instanceType": "GOOGLE_CLOUD",
          "generalCloudProperties": {
            "numberOfBackupStreams": 0,
            "memberServers": [
              {
                "client": {
                  "clientName": "string",
                  "_type_": 0
                }
              }
            ],
            "credentials": {
              "credentialName": "string"
            }
          },
          "objectStorageInstance": {
            "isCloudEncryptionKeySet": true
          },
          "googleCloudInstance": {
            "serverName": "storage.googleapis.com"
          },
          "credentialType": "string"
        },
        "useResourcePoolInfo": true
      }
    },
    "plan": {
      "planName": "string"
    }
  },
  "entity": {
    "clientName": "string"
  }
}'

curl -L -X POST 'https://CommandCenterHostName/webconsole/api/Client' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "clientInfo": {
    "clientType": 0,
    "cloudClonnectorProperties": {
      "instanceType": "GOOGLE_CLOUD",
      "instance": {
        "instance": {
          "instanceName": "string",
          "commCellId": 0,
          "applicationId": 0
        },
        "cloudAppsInstance": {
          "instanceTypeDisplayName": "Google Cloud",
          "instanceType": "GOOGLE_CLOUD",
          "generalCloudProperties": {
            "numberOfBackupStreams": 0,
            "memberServers": [
              {
                "client": {
                  "clientName": "string",
                  "_type_": 0
                }
              }
            ],
            "credentials": {
              "credentialName": "string"
            }
          },
          "objectStorageInstance": {
            "isCloudEncryptionKeySet": true
          },
          "googleCloudInstance": {
            "serverName": "storage.googleapis.com"
          },
          "credentialType": "string"
        },
        "useResourcePoolInfo": true
      }
    },
    "plan": {
      "planName": "string"
    }
  },
  "entity": {
    "clientName": "string"
  }
}'

curl -L -X POST 'https://CommandCenterHostName/webconsole/api/Client' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "clientInfo": {
    "clientType": 0,
    "cloudClonnectorProperties": {
      "instanceType": "GOOGLE_CLOUD",
      "instance": {
        "instance": {
          "instanceName": "string",
          "commCellId": 0,
          "applicationId": 0
        },
        "cloudAppsInstance": {
          "instanceTypeDisplayName": "Google Cloud",
          "instanceType": "GOOGLE_CLOUD",
          "generalCloudProperties": {
            "numberOfBackupStreams": 0,
            "memberServers": [
              {
                "client": {
                  "clientName": "string",
                  "_type_": 0
                }
              }
            ],
            "credentials": {
              "credentialName": "string"
            }
          },
          "objectStorageInstance": {
            "isCloudEncryptionKeySet": true
          },
          "googleCloudInstance": {
            "serverName": "storage.googleapis.com"
          },
          "credentialType": "string"
        },
        "useResourcePoolInfo": true
      }
    },
    "plan": {
      "planName": "string"
    }
  },
  "entity": {
    "clientName": "string"
  }
}'

curl -L -X POST 'https://CommandCenterHostName/webconsole/api/Client' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "clientInfo": {
    "clientType": 0,
    "cloudClonnectorProperties": {
      "instanceType": "GOOGLE_CLOUD",
      "instance": {
        "instance": {
          "instanceName": "string",
          "commCellId": 0,
          "applicationId": 0
        },
        "cloudAppsInstance": {
          "instanceTypeDisplayName": "Google Cloud",
          "instanceType": "GOOGLE_CLOUD",
          "generalCloudProperties": {
            "numberOfBackupStreams": 0,
            "memberServers": [
              {
                "client": {
                  "clientName": "string",
                  "_type_": 0
                }
              }
            ],
            "credentials": {
              "credentialName": "string"
            }
          },
          "objectStorageInstance": {
            "isCloudEncryptionKeySet": true
          },
          "googleCloudInstance": {
            "serverName": "storage.googleapis.com"
          },
          "credentialType": "string"
        },
        "useResourcePoolInfo": true
      }
    },
    "plan": {
      "planName": "string"
    }
  },
  "entity": {
    "clientName": "string"
  }
}'

curl -L -X POST 'https://CommandCenterHostName/webconsole/api/Client' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "clientInfo": {
    "clientType": 0,
    "cloudClonnectorProperties": {
      "instanceType": "GOOGLE_CLOUD",
      "instance": {
        "instance": {
          "instanceName": "string",
          "commCellId": 0,
          "applicationId": 0
        },
        "cloudAppsInstance": {
          "instanceTypeDisplayName": "Google Cloud",
          "instanceType": "GOOGLE_CLOUD",
          "generalCloudProperties": {
            "numberOfBackupStreams": 0,
            "memberServers": [
              {
                "client": {
                  "clientName": "string",
                  "_type_": 0
                }
              }
            ],
            "credentials": {
              "credentialName": "string"
            }
          },
          "objectStorageInstance": {
            "isCloudEncryptionKeySet": true
          },
          "googleCloudInstance": {
            "serverName": "storage.googleapis.com"
          },
          "credentialType": "string"
        },
        "useResourcePoolInfo": true
      }
    },
    "plan": {
      "planName": "string"
    }
  },
  "entity": {
    "clientName": "string"
  }
}'

curl -L -X POST 'https://CommandCenterHostName/webconsole/api/Client' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "clientInfo": {
    "clientType": 0,
    "cloudClonnectorProperties": {
      "instanceType": "GOOGLE_CLOUD",
      "instance": {
        "instance": {
          "instanceName": "string",
          "commCellId": 0,
          "applicationId": 0
        },
        "cloudAppsInstance": {
          "instanceTypeDisplayName": "Google Cloud",
          "instanceType": "GOOGLE_CLOUD",
          "generalCloudProperties": {
            "numberOfBackupStreams": 0,
            "memberServers": [
              {
                "client": {
                  "clientName": "string",
                  "_type_": 0
                }
              }
            ],
            "credentials": {
              "credentialName": "string"
            }
          },
          "objectStorageInstance": {
            "isCloudEncryptionKeySet": true
          },
          "googleCloudInstance": {
            "serverName": "storage.googleapis.com"
          },
          "credentialType": "string"
        },
        "useResourcePoolInfo": true
      }
    },
    "plan": {
      "planName": "string"
    }
  },
  "entity": {
    "clientName": "string"
  }
}'

curl -L -X POST 'https://CommandCenterHostName/webconsole/api/Client' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "clientInfo": {
    "clientType": 0,
    "cloudClonnectorProperties": {
      "instanceType": "GOOGLE_CLOUD",
      "instance": {
        "instance": {
          "instanceName": "string",
          "commCellId": 0,
          "applicationId": 0
        },
        "cloudAppsInstance": {
          "instanceTypeDisplayName": "Google Cloud",
          "instanceType": "GOOGLE_CLOUD",
          "generalCloudProperties": {
            "numberOfBackupStreams": 0,
            "memberServers": [
              {
                "client": {
                  "clientName": "string",
                  "_type_": 0
                }
              }
            ],
            "credentials": {
              "credentialName": "string"
            }
          },
          "objectStorageInstance": {
            "isCloudEncryptionKeySet": true
          },
          "googleCloudInstance": {
            "serverName": "storage.googleapis.com"
          },
          "credentialType": "string"
        },
        "useResourcePoolInfo": true
      }
    },
    "plan": {
      "planName": "string"
    }
  },
  "entity": {
    "clientName": "string"
  }
}'