Cloud Director Object Storage Extension API Data Structures
{
"daysAfterInitiation": "integer"
}
daysAfterInitiation
The definition of bucket/object ACL.
{
"owner": {
"id": "string",
"displayName": "string"
},
"grants": [
{
"grantee": {
"id": "string",
"displayName": "string",
"uri": "string",
"emailAddress": "string",
"type": "string"
},
"permission": "string"
}
]
}
{
"owner": "string"
}
owner
{
"prefix": "string",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
prefix
{
"name": "string",
"creationDate": "string"
}
name
creationDate
{
"exist": "boolean",
"ownBucket": "boolean"
}
exist
ownBucket
{
"loggingEnabled": {
"targetBucket": "string",
"targetPrefix": "string",
"targetGrants": [
{
"grantee": {
"id": "string",
"displayName": "string",
"uri": "string",
"emailAddress": "string",
"type": "string"
},
"permission": "string"
}
]
}
}
{
"topicConfiguration": [
{
"id": "string",
"events": [
"string"
],
"filter": {
"s3Key": {
"filterRules": [
{
"name": "string",
"value": "string"
}
]
}
},
"topic": "string"
}
],
"queueConfiguration": [
{
"id": "string",
"events": [
"string"
],
"filter": {
"s3Key": {
"filterRules": [
{
"name": "string",
"value": "string"
}
]
}
},
"queue": "string"
}
],
"cloudFunctionConfiguration": [
{
"id": "string",
"events": [
"string"
],
"filter": {
"s3Key": {
"filterRules": [
{
"name": "string",
"value": "string"
}
]
}
},
"cloudFunction": "string"
}
]
}
{
"corsRules": [
{
"id": "string",
"allowedOrigins": [
"string"
],
"allowedMethods": [
"string"
],
"maxAgeSeconds": "integer",
"exposeHeaders": [
"string"
],
"allowedHeaders": [
"string"
]
}
]
}
{
"id": "string",
"allowedOrigins": [
"string"
],
"allowedMethods": [
"string"
],
"maxAgeSeconds": "integer",
"exposeHeaders": [
"string"
],
"allowedHeaders": [
"string"
]
}
id
allowedOrigins
allowedMethods
maxAgeSeconds
exposeHeaders
allowedHeaders
{
"allowQuotedRecordDelimiter": "boolean",
"comments": "string",
"fieldDelimiter": "string",
"fileHeaderInfo": "string",
"quoteCharacter": "string",
"quoteEscapeCharacter": "string",
"recordDelimiter": "string"
}
allowQuotedRecordDelimiter
comments
fieldDelimiter
fileHeaderInfo
quoteCharacter
quoteEscapeCharacter
recordDelimiter
{
"fieldDelimiter": "string",
"quoteCharacter": "string",
"quoteEscapeCharacter": "string",
"quoteFields": "string",
"recordDelimiter": "string"
}
fieldDelimiter
quoteCharacter
quoteEscapeCharacter
quoteFields
recordDelimiter
{
"prefix": "string",
"owner": {
"id": "string",
"displayName": "string"
}
}
prefix
{
"part": [
{
"partNumber": "integer",
"geteTag": "string",
"lastModified": "string",
"size": "integer"
}
]
}
{
"location": "string",
"bucket": "string",
"key": "string",
"geteTag": "string"
}
location
bucket
key
geteTag
{
"keyPrefixEquals": "string",
"httpErrorCodeReturnedEquals": "string"
}
keyPrefixEquals
httpErrorCodeReturnedEquals
{
"lastModified": "string",
"etag": "string"
}
lastModified
etag
{
"geteTag": "string",
"lastModified": "string"
}
geteTag
lastModified
{
"locationConstraint": "string"
}
locationConstraint
{
"days": "integer",
"mode": "string",
"years": "integer"
}
days
mode
years
{
"key": "string",
"versionId": "string",
"code": "string",
"message": "string"
}
key
versionId
code
message
{
"status": "string"
}
status
{
"key": "string",
"versionId": "string",
"deleteMarker": "boolean",
"deleteMarkerVersionId": "string"
}
key
versionId
deleteMarker
deleteMarkerVersionId
{
"value": "string",
"displayName": "string",
"description": "string"
}
value
displayName
description
{
"bucket": "string",
"storageClass": "string",
"account": "string",
"accessControlTranslation": {
"owner": "string"
}
}
bucket
storageClass
account
{
"key": "string"
}
key
{
"date": "string",
"days": "integer",
"expiredObjectDeleteMarker": "boolean"
}
date
days
expiredObjectDeleteMarker
{
"name": "string",
"value": "string"
}
name
value
{
"prefix": "string",
"tag": {
"key": "string",
"value": "string"
},
"and": {
"prefix": "string",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
}
{
"hostName": "string",
"protocol": "string",
"replaceKeyPrefixWith": "string",
"replaceKeyWith": "string",
"httpRedirectCode": "string"
}
hostName
protocol
replaceKeyPrefixWith
replaceKeyWith
httpRedirectCode
{
"payer": "string"
}
payer
{
"tier": "string"
}
tier
{
"grantee": {
"id": "string",
"displayName": "string",
"uri": "string",
"emailAddress": "string",
"type": "string"
},
"permission": "string"
}
permission
{
"id": "string",
"displayName": "string",
"uri": "string",
"emailAddress": "string",
"type": "string"
}
id
displayName
uri
emailAddress
type
{
"suffix": "string"
}
suffix
{
"bucket": "string",
"key": "string",
"uploadId": "string"
}
bucket
key
uploadId
{
"compressionType": "string",
"csv": {
"allowQuotedRecordDelimiter": "boolean",
"comments": "string",
"fieldDelimiter": "string",
"fileHeaderInfo": "string",
"quoteCharacter": "string",
"quoteEscapeCharacter": "string",
"recordDelimiter": "string"
},
"json": {
"type": "string"
}
}
{
"type": "string"
}
type
{
"recordDelimiter": "string"
}
recordDelimiter
{
"id": "string",
"events": [
"string"
],
"filter": {
"s3Key": {
"filterRules": [
{
"name": "string",
"value": "string"
}
]
}
},
"cloudFunction": "string"
}
id
events
cloudFunction
{
"status": "string"
}
status
{
"rules": [
{
"id": "string",
"status": "string",
"filter": {
"prefix": "string",
"tag": {
"key": "string",
"value": "string"
},
"and": {
"prefix": "string",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
},
"transitions": [
{
"days": "integer",
"date": "string",
"storageClass": "string"
}
],
"noncurrentVersionTransitions": [
{
"noncurrentDays": "integer",
"storageClass": "string"
}
],
"noncurrentVersionExpiration": {
"noncurrentDays": "integer"
},
"abortIncompleteMultipartUpload": {
"daysAfterInitiation": "integer"
},
"expiration": {
"date": "string",
"days": "integer",
"expiredObjectDeleteMarker": "boolean"
}
}
]
}
{
"id": "string",
"status": "string",
"filter": {
"prefix": "string",
"tag": {
"key": "string",
"value": "string"
},
"and": {
"prefix": "string",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
},
"transitions": [
{
"days": "integer",
"date": "string",
"storageClass": "string"
}
],
"noncurrentVersionTransitions": [
{
"noncurrentDays": "integer",
"storageClass": "string"
}
],
"noncurrentVersionExpiration": {
"noncurrentDays": "integer"
},
"abortIncompleteMultipartUpload": {
"daysAfterInitiation": "integer"
},
"expiration": {
"date": "string",
"days": "integer",
"expiredObjectDeleteMarker": "boolean"
}
}
id
status
noncurrentVersionTransitions
abortIncompleteMultipartUpload
{
"owner": {
"id": "string",
"displayName": "string"
},
"buckets": [
{
"name": "string",
"creationDate": "string"
}
]
}
{
"truncated": "boolean",
"continuationToken": "string",
"nextContinuationToken": "string",
"name": "string",
"prefix": "string",
"delimiter": "string",
"encodingType": "string",
"keyCount": "integer",
"maxKeys": "integer",
"commonPrefixes": [
{
"prefix": "string",
"owner": {
"id": "string",
"displayName": "string"
}
}
],
"objectBrief": [
{
"key": "string",
"versionId": "string",
"owner": {
"id": "string",
"displayName": "string"
},
"ownerId": "string",
"storageClass": "string",
"etag": "string",
"size": "integer",
"lastModified": "string"
}
],
"startAfter": "string"
}
truncated
continuationToken
nextContinuationToken
name
prefix
delimiter
encodingType
keyCount
maxKeys
startAfter
{
"bucketName": "string",
"keyMarker": "string",
"uploadIdMarker": "string",
"prefix": "string",
"delimiter": "string",
"nextKeyMarker": "string",
"nextUploadIdMarker": "string",
"encodingType": "string",
"maxUploads": "integer",
"truncated": "boolean",
"uploads": [
{
"key": "string",
"uploadId": "string",
"initiator": {
"id": "string",
"displayName": "string"
},
"owner": {
"id": "string",
"displayName": "string"
},
"storageClass": "string",
"initiated": "string"
}
],
"commonPrefixes": [
{
"prefix": "string",
"owner": {
"id": "string",
"displayName": "string"
}
}
]
}
bucketName
keyMarker
uploadIdMarker
prefix
delimiter
nextKeyMarker
nextUploadIdMarker
encodingType
maxUploads
truncated
{
"key": "string",
"uploadId": "string",
"initiator": {
"id": "string",
"displayName": "string"
},
"owner": {
"id": "string",
"displayName": "string"
},
"storageClass": "string",
"bucket": "string",
"partNumberMarker": "integer",
"nextPartNumberMarker": "integer",
"maxParts": "integer",
"isTruncated": "boolean",
"part": [
{
"partNumber": "integer",
"geteTag": "string",
"lastModified": "string",
"size": "integer"
}
],
"abortDate": "string",
"abortRuleId": "string"
}
key
uploadId
storageClass
bucket
partNumberMarker
nextPartNumberMarker
maxParts
isTruncated
abortDate
abortRuleId
{
"name": "string",
"prefix": "string",
"keyMarker": "string",
"versionIdMarker": "string",
"nextKeyMarker": "string",
"nextVersionIdMarker": "string",
"maxKeys": "integer",
"commonPrefixes": [
{
"prefix": "string",
"owner": {
"id": "string",
"displayName": "string"
}
}
],
"versionSummaries": [
{
"key": "string",
"versionId": "string",
"latest": "boolean",
"lastModified": "string",
"owner": {
"id": "string",
"displayName": "string"
},
"tenant": "string",
"deleteMarker": "boolean"
}
],
"truncated": "boolean"
}
name
prefix
keyMarker
versionIdMarker
nextKeyMarker
nextVersionIdMarker
maxKeys
truncated
{
"targetBucket": "string",
"targetPrefix": "string",
"targetGrants": [
{
"grantee": {
"id": "string",
"displayName": "string",
"uri": "string",
"emailAddress": "string",
"type": "string"
},
"permission": "string"
}
]
}
targetBucket
targetPrefix
{
"name": "string",
"value": "string"
}
name
value
{
"objectRefs": [
{
"key": "string",
"versionId": "string",
"deleteMarker": "boolean",
"deleteMarkerVersionId": "string"
}
],
"errors": [
{
"key": "string",
"versionId": "string",
"code": "string",
"message": "string"
}
]
}
{
"noncurrentDays": "integer"
}
noncurrentDays
{
"noncurrentDays": "integer",
"storageClass": "string"
}
noncurrentDays
storageClass
{
"s3Key": {
"filterRules": [
{
"name": "string",
"value": "string"
}
]
}
}
{
"key": "string",
"versionId": "string",
"owner": {
"id": "string",
"displayName": "string"
},
"ownerId": "string",
"storageClass": "string",
"etag": "string",
"size": "integer",
"lastModified": "string"
}
key
versionId
ownerId
storageClass
etag
size
lastModified
{
"key": "string",
"versionId": "string",
"owner": {
"id": "string",
"displayName": "string"
},
"ownerId": "string",
"storageClass": "string",
"etag": "string",
"size": "integer",
"lastModified": "string",
"path": "string",
"tenant": "string",
"contentType": "string",
"encryption": "string",
"encryptionAlgorithm": "string",
"creationDate": "string",
"s3Href": "string",
"s3AltHref": "string",
"sharingStatus": "string",
"versionDeleted": "boolean",
"expiryDate": "string",
"ruleId": "string",
"objectLock": "boolean",
"requesterPays": "boolean",
"requesterCharged": "boolean",
"folder": "boolean"
}
key
versionId
ownerId
storageClass
etag
size
lastModified
path
tenant
contentType
encryption
encryptionAlgorithm
creationDate
s3Href
s3AltHref
sharingStatus
userMeta
versionDeleted
expiryDate
ruleId
objectLock
requesterPays
requesterCharged
folder
{
"objectLockEnabled": "string",
"rule": {
"defaultRetention": {
"days": "integer",
"mode": "string",
"years": "integer"
}
}
}
objectLockEnabled
{
"defaultRetention": {
"days": "integer",
"mode": "string",
"years": "integer"
}
}
{
"s3": {
"grants": [
{
"grantee": {
"id": "string",
"displayName": "string",
"uri": "string",
"emailAddress": "string",
"type": "string"
},
"permission": "string"
}
],
"bucketName": "string",
"cannedACL": "string",
"encryption": {
"encryptionType": "string",
"kmsContext": "string",
"kmsKeyId": "string"
},
"prefix": "string",
"storageClass": "string",
"tagging": {
"tagSets": [
{
"tags": [
{
"key": "string",
"value": "string"
}
]
}
]
},
"userMetadata": [
{
"name": "string",
"value": "string"
}
]
}
}
{
"csv": {
"fieldDelimiter": "string",
"quoteCharacter": "string",
"quoteEscapeCharacter": "string",
"quoteFields": "string",
"recordDelimiter": "string"
},
"json": {
"recordDelimiter": "string"
}
}
{
"id": "string",
"displayName": "string"
}
id
displayName
{
"partNumber": "integer",
"geteTag": "string",
"lastModified": "string",
"size": "integer"
}
partNumber
geteTag
lastModified
size
{
"isPublic": "boolean"
}
isPublic
{
"bucket": "string",
"etag": "string",
"key": "string",
"location": "string"
}
bucket
etag
key
location
{
"blockPublicAcls": "boolean",
"ignorePublicAcls": "boolean",
"blockPublicPolicy": "boolean",
"restrictPublicBuckets": "boolean"
}
blockPublicAcls
ignorePublicAcls
blockPublicPolicy
restrictPublicBuckets
{
"id": "string",
"events": [
"string"
],
"filter": {
"s3Key": {
"filterRules": [
{
"name": "string",
"value": "string"
}
]
}
},
"queue": "string"
}
id
events
queue
{
"role": "string",
"rule": [
{
"id": "string",
"status": "string",
"priority": "integer",
"deleteMarkerReplication": {
"status": "string"
},
"prefix": "string",
"filter": {
"prefix": "string",
"tag": {
"key": "string",
"value": "string"
},
"and": {
"prefix": "string",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
},
"destination": {
"bucket": "string",
"storageClass": "string",
"account": "string",
"accessControlTranslation": {
"owner": "string"
}
}
}
]
}
role
{
"id": "string",
"status": "string",
"priority": "integer",
"deleteMarkerReplication": {
"status": "string"
},
"prefix": "string",
"filter": {
"prefix": "string",
"tag": {
"key": "string",
"value": "string"
},
"and": {
"prefix": "string",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
},
"destination": {
"bucket": "string",
"storageClass": "string",
"account": "string",
"accessControlTranslation": {
"owner": "string"
}
}
}
id
status
priority
prefix
{
"payer": "string"
}
payer
{
"enabled": "boolean"
}
enabled
{
"encryptionType": "string",
"kmsContext": "string",
"kmsKeyId": "string"
}
encryptionType
kmsContext
kmsKeyId
{
"days": "integer",
"glacierJobParameters": {
"tier": "string"
},
"type": "string",
"tier": "string",
"description": "string",
"selectParameters": {
"expression": "string",
"expressionType": "string",
"inputSerialization": {
"compressionType": "string",
"csv": {
"allowQuotedRecordDelimiter": "boolean",
"comments": "string",
"fieldDelimiter": "string",
"fileHeaderInfo": "string",
"quoteCharacter": "string",
"quoteEscapeCharacter": "string",
"recordDelimiter": "string"
},
"json": {
"type": "string"
}
},
"outputSerialization": {
"csv": {
"fieldDelimiter": "string",
"quoteCharacter": "string",
"quoteEscapeCharacter": "string",
"quoteFields": "string",
"recordDelimiter": "string"
},
"json": {
"recordDelimiter": "string"
}
}
},
"outputLocation": {
"s3": {
"grants": [
{
"grantee": {
"id": "string",
"displayName": "string",
"uri": "string",
"emailAddress": "string",
"type": "string"
},
"permission": "string"
}
],
"bucketName": "string",
"cannedACL": "string",
"encryption": {
"encryptionType": "string",
"kmsContext": "string",
"kmsKeyId": "string"
},
"prefix": "string",
"storageClass": "string",
"tagging": {
"tagSets": [
{
"tags": [
{
"key": "string",
"value": "string"
}
]
}
]
},
"userMetadata": [
{
"name": "string",
"value": "string"
}
]
}
}
}
days
type
tier
description
{
"mode": "string",
"retainUntilDate": "string"
}
mode
retainUntilDate
{
"condition": {
"keyPrefixEquals": "string",
"httpErrorCodeReturnedEquals": "string"
},
"redirect": {
"hostName": "string",
"protocol": "string",
"replaceKeyPrefixWith": "string",
"replaceKeyWith": "string",
"httpRedirectCode": "string"
}
}
{
"filterRules": [
{
"name": "string",
"value": "string"
}
]
}
{
"grants": [
{
"grantee": {
"id": "string",
"displayName": "string",
"uri": "string",
"emailAddress": "string",
"type": "string"
},
"permission": "string"
}
],
"bucketName": "string",
"cannedACL": "string",
"encryption": {
"encryptionType": "string",
"kmsContext": "string",
"kmsKeyId": "string"
},
"prefix": "string",
"storageClass": "string",
"tagging": {
"tagSets": [
{
"tags": [
{
"key": "string",
"value": "string"
}
]
}
]
},
"userMetadata": [
{
"name": "string",
"value": "string"
}
]
}
bucketName
cannedACL
prefix
storageClass
{
"sseAlgorithm": "string",
"kmsMasterKeyID": "string",
"sseCKey": "string",
"sseCKeyMd5": "string",
"alias": "string"
}
sseAlgorithm
kmsMasterKeyID
sseCKey
sseCKeyMd5
alias
{
"sseRules": [
{
"sseByDefault": {
"sseAlgorithm": "string",
"kmsMasterKeyID": "string",
"sseCKey": "string",
"sseCKeyMd5": "string",
"alias": "string"
}
}
]
}
{
"sseByDefault": {
"sseAlgorithm": "string",
"kmsMasterKeyID": "string",
"sseCKey": "string",
"sseCKeyMd5": "string",
"alias": "string"
}
}
{
"end": "integer",
"start": "integer"
}
end
start
{
"expression": "string",
"expressionType": "string",
"requestProgress": {
"enabled": "boolean"
},
"inputSerialization": {
"compressionType": "string",
"csv": {
"allowQuotedRecordDelimiter": "boolean",
"comments": "string",
"fieldDelimiter": "string",
"fileHeaderInfo": "string",
"quoteCharacter": "string",
"quoteEscapeCharacter": "string",
"recordDelimiter": "string"
},
"json": {
"type": "string"
}
},
"outputSerialization": {
"csv": {
"fieldDelimiter": "string",
"quoteCharacter": "string",
"quoteEscapeCharacter": "string",
"quoteFields": "string",
"recordDelimiter": "string"
},
"json": {
"recordDelimiter": "string"
}
},
"scanRange": {
"end": "integer",
"start": "integer"
}
}
expression
expressionType
{
"expression": "string",
"expressionType": "string",
"inputSerialization": {
"compressionType": "string",
"csv": {
"allowQuotedRecordDelimiter": "boolean",
"comments": "string",
"fieldDelimiter": "string",
"fileHeaderInfo": "string",
"quoteCharacter": "string",
"quoteEscapeCharacter": "string",
"recordDelimiter": "string"
},
"json": {
"type": "string"
}
},
"outputSerialization": {
"csv": {
"fieldDelimiter": "string",
"quoteCharacter": "string",
"quoteEscapeCharacter": "string",
"quoteFields": "string",
"recordDelimiter": "string"
},
"json": {
"recordDelimiter": "string"
}
}
}
expression
expressionType
{
"key": "string",
"value": "string"
}
key
value
New tags for bucket/object.
{
"tagSets": [
{
"tags": [
{
"key": "string",
"value": "string"
}
]
}
]
}
{
"id": "string",
"vcdId": "string",
"vcdAssociationId": "string",
"description": "string",
"status": "string",
"resourceType": "string",
"resourceKey": "string",
"progress": "integer",
"tenant": "string",
"owner": "string",
"startDate": "string",
"endDate": "string",
"reason": "string"
}
id
vcdId
vcdAssociationId
description
status
resourceType
resourceKey
progress
tenant
owner
startDate
endDate
reason
metadata
{
"id": "string",
"events": [
"string"
],
"filter": {
"s3Key": {
"filterRules": [
{
"name": "string",
"value": "string"
}
]
}
},
"topic": "string"
}
id
events
topic
{
"days": "integer",
"date": "string",
"storageClass": "string"
}
days
date
storageClass
{
"key": "string",
"uploadId": "string",
"initiator": {
"id": "string",
"displayName": "string"
},
"owner": {
"id": "string",
"displayName": "string"
},
"storageClass": "string",
"initiated": "string"
}
{
"key": "string",
"versionId": "string",
"latest": "boolean",
"lastModified": "string",
"owner": {
"id": "string",
"displayName": "string"
},
"tenant": "string",
"deleteMarker": "boolean"
}
key
versionId
latest
lastModified
tenant
deleteMarker
{
"status": "string",
"mfaDelete": "string"
}
status
mfaDelete
{
"indexDocument": {
"suffix": "string"
},
"errorDocument": {
"key": "string"
},
"redirectAllRequestsTo": {
"hostName": "string",
"protocol": "string",
"replaceKeyPrefixWith": "string",
"replaceKeyWith": "string",
"httpRedirectCode": "string"
},
"routingRules": [
{
"condition": {
"keyPrefixEquals": "string",
"httpErrorCodeReturnedEquals": "string"
},
"redirect": {
"hostName": "string",
"protocol": "string",
"replaceKeyPrefixWith": "string",
"replaceKeyWith": "string",
"httpRedirectCode": "string"
}
}
]
}