S3 Object storage client creation operation
Select
SaaS
Customer Managed
This operation adds the S3 object storage client
- application/json
Request Body
clientInfo object
clientType integer requiredcloudClonnectorProperties object
instanceType string requiredInstance type for S3 value is AMAZON_S3
instance object
instance object required
instanceName string requiredcommCellId integer requiredDefault value:
2
applicationId integer requiredcloudAppsInstance object
instanceTypeDisplayName string requiredinstanceTypeDisplayName for S3 is "Amazon S3"
instanceType string requiredInstance type for S3 value is AMAZON_S3
generalCloudProperties object required
numberOfBackupStreams integer requiredDefault value:
4
Number of backup streams for default subclient
memberServers object[] required
client object required
clientName string required_type_ integercredentials object
credentialName stringobjectStorageInstance object
isCloudEncryptionKeySet booleans3Instance object required
hostURL string requiredDefault value:
s3.amazonaws.com
S3 host URL
useIamRole boolean requiredcredentialType string requireduseResourcePoolInfo booleanplan object required
planName string requiredentity object required
clientName string required
Responses
- 200
- 400
OK
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
processinginstructioninfo object
attributes object[]
name stringvalue stringresponse object
errorCode integerentity object
clientId integerclientName 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": 228,
"clientName": "api doc s3",
"_type_": 3
}
}
}
Bad Request
- application/json
- Schema
- Example (from schema)
- Wrong credentials
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "Invalid Parameter : S3: Incorrect Secret Key: Make sure Secret Key is correct and active. Also verify privileges. Error[The request signature we calculated does not match the signature you provided. Check your key and signing method. Details: AWSAccessKeyId = \"*************\" StringToSign = \"AWS4-HMAC-SHA256\n********\n20240109/us-east-1/s3/aws4_request\n15757******\" SignatureProvided = \"abhbub*********************\" StringToSignBytes = \"41 57 53 34 2d 48 4d 41 43 2d 53 48 41 32 35 36 0a 32 30 32 34 30 31 30 39 54 31 34 31 36 34 39 5a 0a 32 30 32 34 30 31 30 39 2f 75 73 2d 65 61 73 74 2d 31 2f 73 33 2f 61 77 73 34 5f 72 65 71 75 65 73 74 0a 31 34 34 36 65 36 32 35 34 36 62 65 65 31 33 65 62 36 31 39 35 30 61 64 34 35 61 65 64 31 35 35 37 35 39 31 64 61 64 33 30 31 33 34 38 36 32 30 36 30 33 61 65 39 35 66 35 61 35 66 35 61 64 34\" CanonicalRequest = \"GET\n/\n\nhost:s3.amazonaws.com\nx-amz-content-sha256:bbbbbbbbbbbbbbaaaaaaaaaaa***********\nx-amz-date:20240109T141649Z\n\nhost;x-amz-content-sha256;x-amz-date\ne]",
"errorCode": -1
}
Loading...