Creates a couchbase Bucketgroup/subclient
Select
SaaS
Customer Managed
This API is used to create couchbase bucketgroup/subclient
- application/json
Request Body
subClientProperties object required
Responses
- 200
- 401
OK
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
processinginstructioninfo object
response object
{
"processinginstructioninfo": {
"attributes": [
{
"name": "string",
"value": "string"
}
]
},
"response": {
"warningCode": 0,
"errorCode": 0,
"warningMessage": "string",
"entity": {
"subclientId": 0,
"_type_": 0
}
}
}
{
"processinginstructioninfo": {
"attributes": [
{
"name": "exitval",
"value": "0"
}
]
},
"response": {
"warningCode": 0,
"errorCode": 0,
"warningMessage": "",
"entity": {
"subclientId": 6,
"_type_": 0
}
}
}
Unauthorized
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "Access Denied",
"errorCode": 5
}
POST /subclient
Authorization
type: apiKeyname: Authtokenin: header
Request
Request
curl -L -X POST 'https://localhost/webconsole/api/Subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"subClientProperties": {
"fsContentOperationType": "OVERWRITE",
"subClientEntity": {
"clientId": 0,
"applicationId": 64,
"subclientName": "string"
},
"planEntity": {
"planId": 0
},
"content": [
{
"path": "string"
}
],
"useLocalContent": true,
"dfsSubclientProp": {
"distributedDataAccessNodes": {
"dataAccessNodes": [
{
"hostName": "string",
"clientId": 0,
"clientName": "string",
"displayName": "string"
}
]
}
}
}
}'
curl -L -X POST 'https://localhost/webconsole/api/Subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"subClientProperties": {
"fsContentOperationType": "OVERWRITE",
"subClientEntity": {
"clientId": 0,
"applicationId": 64,
"subclientName": "string"
},
"planEntity": {
"planId": 0
},
"content": [
{
"path": "string"
}
],
"useLocalContent": true,
"dfsSubclientProp": {
"distributedDataAccessNodes": {
"dataAccessNodes": [
{
"hostName": "string",
"clientId": 0,
"clientName": "string",
"displayName": "string"
}
]
}
}
}
}'
curl -L -X POST 'https://localhost/webconsole/api/Subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"subClientProperties": {
"fsContentOperationType": "OVERWRITE",
"subClientEntity": {
"clientId": 0,
"applicationId": 64,
"subclientName": "string"
},
"planEntity": {
"planId": 0
},
"content": [
{
"path": "string"
}
],
"useLocalContent": true,
"dfsSubclientProp": {
"distributedDataAccessNodes": {
"dataAccessNodes": [
{
"hostName": "string",
"clientId": 0,
"clientName": "string",
"displayName": "string"
}
]
}
}
}
}'
curl -L -X POST 'https://localhost/webconsole/api/Subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"subClientProperties": {
"fsContentOperationType": "OVERWRITE",
"subClientEntity": {
"clientId": 0,
"applicationId": 64,
"subclientName": "string"
},
"planEntity": {
"planId": 0
},
"content": [
{
"path": "string"
}
],
"useLocalContent": true,
"dfsSubclientProp": {
"distributedDataAccessNodes": {
"dataAccessNodes": [
{
"hostName": "string",
"clientId": 0,
"clientName": "string",
"displayName": "string"
}
]
}
}
}
}'
curl -L -X POST 'https://localhost/webconsole/api/Subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"subClientProperties": {
"fsContentOperationType": "OVERWRITE",
"subClientEntity": {
"clientId": 0,
"applicationId": 64,
"subclientName": "string"
},
"planEntity": {
"planId": 0
},
"content": [
{
"path": "string"
}
],
"useLocalContent": true,
"dfsSubclientProp": {
"distributedDataAccessNodes": {
"dataAccessNodes": [
{
"hostName": "string",
"clientId": 0,
"clientName": "string",
"displayName": "string"
}
]
}
}
}
}'
curl -L -X POST 'https://localhost/webconsole/api/Subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"subClientProperties": {
"fsContentOperationType": "OVERWRITE",
"subClientEntity": {
"clientId": 0,
"applicationId": 64,
"subclientName": "string"
},
"planEntity": {
"planId": 0
},
"content": [
{
"path": "string"
}
],
"useLocalContent": true,
"dfsSubclientProp": {
"distributedDataAccessNodes": {
"dataAccessNodes": [
{
"hostName": "string",
"clientId": 0,
"clientName": "string",
"displayName": "string"
}
]
}
}
}
}'
curl -L -X POST 'https://localhost/webconsole/api/Subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"subClientProperties": {
"fsContentOperationType": "OVERWRITE",
"subClientEntity": {
"clientId": 0,
"applicationId": 64,
"subclientName": "string"
},
"planEntity": {
"planId": 0
},
"content": [
{
"path": "string"
}
],
"useLocalContent": true,
"dfsSubclientProp": {
"distributedDataAccessNodes": {
"dataAccessNodes": [
{
"hostName": "string",
"clientId": 0,
"clientName": "string",
"displayName": "string"
}
]
}
}
}
}'