Modify S3 object storage instance

Select

SaaS

Customer Managed

S3 object storage instance modify operation

Path Parameters

instanceid integer required
S3 instance id

application/json

Request Body

instanceProperties object
instance object required
applicationId integer
clientId integer
instanceId integer
cloudAppsInstance object required
instanceTypeDisplayName string
instanceTypeDisplayName for S3 is "Amazon S3"
instanceType string
Instance type for S3 value is AMAZON_S3
generalCloudProperties object required
numberOfBackupStreams integer
memberServers object[]
Required for backup using the gateway(s)
client object
clientName string
_type_ integer
credentials object
credentialName string
objectStorageInstance object
isCloudEncryptionKeySet boolean
s3Instance object required
hostURL string
useIamRole boolean
credentialType string required
planEntity object required
planName string
association object required
entity object[]
clientName string

Responses

application/json

Schema
Example (from schema)
Example 1

Schema

processinginstructioninfo object
attributes object[]
name string
value string
response object[]
warningCode integer
errorCode integer
warningMessage string
entity object
subclientId integer
clientId integer
instanceName string
instanceId integer
_type_ integer

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "string",
        "value": "string"
      }
    ]
  },
  "response": [
    {
      "warningCode": 0,
      "errorCode": 0,
      "warningMessage": "string",
      "entity": {
        "subclientId": 0,
        "clientId": 0,
        "instanceName": "string",
        "instanceId": 0,
        "_type_": 0
      }
    }
  ]
}

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "exitval",
        "value": "0"
      }
    ]
  },
  "response": [
    {
      "warningCode": 0,
      "errorCode": 0,
      "warningMessage": "",
      "entity": {
        "subclientId": 0,
        "clientId": 0,
        "instanceName": "",
        "instanceId": 0,
        "_type_": 0
      }
    }
  ]
}

Not Found

application/json

Schema
Example (from schema)

Schema

errorMessage string
errorCode integer

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

POST /instance/:instanceid

Request

Click Edit to configure Base URL

https://CommandCenterHostName/webconsole/api

instanceid — path required

Body

Default
Example 1
Hosted Infrastructure STS assume role with IAM policy

{
  "instanceProperties": {
    "instance": {
      "applicationId": 0,
      "clientId": 0,
      "instanceId": 0
    },
    "cloudAppsInstance": {
      "instanceTypeDisplayName": "string",
      "instanceType": "string",
      "generalCloudProperties": {
        "numberOfBackupStreams": 0,
        "memberServers": [
          {
            "client": {
              "clientName": "string",
              "_type_": 0
            }
          }
        ],
        "credentials": {
          "credentialName": "string"
        }
      },
      "objectStorageInstance": {
        "isCloudEncryptionKeySet": true
      },
      "s3Instance": {
        "hostURL": "string",
        "useIamRole": true
      },
      "credentialType": "string"
    },
    "planEntity": {
      "planName": "string"
    }
  },
  "association": {
    "entity": [
      {
        "clientName": "string"
      }
    ]
  }
}

curl -L -X POST 'https://CommandCenterHostName/webconsole/api/Instance/:instanceid' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "applicationId": 0,
      "clientId": 0,
      "instanceId": 0
    },
    "cloudAppsInstance": {
      "instanceTypeDisplayName": "string",
      "instanceType": "string",
      "generalCloudProperties": {
        "numberOfBackupStreams": 0,
        "memberServers": [
          {
            "client": {
              "clientName": "string",
              "_type_": 0
            }
          }
        ],
        "credentials": {
          "credentialName": "string"
        }
      },
      "objectStorageInstance": {
        "isCloudEncryptionKeySet": true
      },
      "s3Instance": {
        "hostURL": "string",
        "useIamRole": true
      },
      "credentialType": "string"
    },
    "planEntity": {
      "planName": "string"
    }
  },
  "association": {
    "entity": [
      {
        "clientName": "string"
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/webconsole/api/Instance/:instanceid' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "applicationId": 0,
      "clientId": 0,
      "instanceId": 0
    },
    "cloudAppsInstance": {
      "instanceTypeDisplayName": "string",
      "instanceType": "string",
      "generalCloudProperties": {
        "numberOfBackupStreams": 0,
        "memberServers": [
          {
            "client": {
              "clientName": "string",
              "_type_": 0
            }
          }
        ],
        "credentials": {
          "credentialName": "string"
        }
      },
      "objectStorageInstance": {
        "isCloudEncryptionKeySet": true
      },
      "s3Instance": {
        "hostURL": "string",
        "useIamRole": true
      },
      "credentialType": "string"
    },
    "planEntity": {
      "planName": "string"
    }
  },
  "association": {
    "entity": [
      {
        "clientName": "string"
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/webconsole/api/Instance/:instanceid' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "applicationId": 0,
      "clientId": 0,
      "instanceId": 0
    },
    "cloudAppsInstance": {
      "instanceTypeDisplayName": "string",
      "instanceType": "string",
      "generalCloudProperties": {
        "numberOfBackupStreams": 0,
        "memberServers": [
          {
            "client": {
              "clientName": "string",
              "_type_": 0
            }
          }
        ],
        "credentials": {
          "credentialName": "string"
        }
      },
      "objectStorageInstance": {
        "isCloudEncryptionKeySet": true
      },
      "s3Instance": {
        "hostURL": "string",
        "useIamRole": true
      },
      "credentialType": "string"
    },
    "planEntity": {
      "planName": "string"
    }
  },
  "association": {
    "entity": [
      {
        "clientName": "string"
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/webconsole/api/Instance/:instanceid' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "applicationId": 0,
      "clientId": 0,
      "instanceId": 0
    },
    "cloudAppsInstance": {
      "instanceTypeDisplayName": "string",
      "instanceType": "string",
      "generalCloudProperties": {
        "numberOfBackupStreams": 0,
        "memberServers": [
          {
            "client": {
              "clientName": "string",
              "_type_": 0
            }
          }
        ],
        "credentials": {
          "credentialName": "string"
        }
      },
      "objectStorageInstance": {
        "isCloudEncryptionKeySet": true
      },
      "s3Instance": {
        "hostURL": "string",
        "useIamRole": true
      },
      "credentialType": "string"
    },
    "planEntity": {
      "planName": "string"
    }
  },
  "association": {
    "entity": [
      {
        "clientName": "string"
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/webconsole/api/Instance/:instanceid' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "applicationId": 0,
      "clientId": 0,
      "instanceId": 0
    },
    "cloudAppsInstance": {
      "instanceTypeDisplayName": "string",
      "instanceType": "string",
      "generalCloudProperties": {
        "numberOfBackupStreams": 0,
        "memberServers": [
          {
            "client": {
              "clientName": "string",
              "_type_": 0
            }
          }
        ],
        "credentials": {
          "credentialName": "string"
        }
      },
      "objectStorageInstance": {
        "isCloudEncryptionKeySet": true
      },
      "s3Instance": {
        "hostURL": "string",
        "useIamRole": true
      },
      "credentialType": "string"
    },
    "planEntity": {
      "planName": "string"
    }
  },
  "association": {
    "entity": [
      {
        "clientName": "string"
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/webconsole/api/Instance/:instanceid' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "applicationId": 0,
      "clientId": 0,
      "instanceId": 0
    },
    "cloudAppsInstance": {
      "instanceTypeDisplayName": "string",
      "instanceType": "string",
      "generalCloudProperties": {
        "numberOfBackupStreams": 0,
        "memberServers": [
          {
            "client": {
              "clientName": "string",
              "_type_": 0
            }
          }
        ],
        "credentials": {
          "credentialName": "string"
        }
      },
      "objectStorageInstance": {
        "isCloudEncryptionKeySet": true
      },
      "s3Instance": {
        "hostURL": "string",
        "useIamRole": true
      },
      "credentialType": "string"
    },
    "planEntity": {
      "planName": "string"
    }
  },
  "association": {
    "entity": [
      {
        "clientName": "string"
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/webconsole/api/Instance/:instanceid' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "applicationId": 0,
      "clientId": 0,
      "instanceId": 0
    },
    "cloudAppsInstance": {
      "instanceTypeDisplayName": "string",
      "instanceType": "string",
      "generalCloudProperties": {
        "numberOfBackupStreams": 0,
        "memberServers": [
          {
            "client": {
              "clientName": "string",
              "_type_": 0
            }
          }
        ],
        "credentials": {
          "credentialName": "string"
        }
      },
      "objectStorageInstance": {
        "isCloudEncryptionKeySet": true
      },
      "s3Instance": {
        "hostURL": "string",
        "useIamRole": true
      },
      "credentialType": "string"
    },
    "planEntity": {
      "planName": "string"
    }
  },
  "association": {
    "entity": [
      {
        "clientName": "string"
      }
    ]
  }
}'

Modify S3 object storage instance​

Request

Modify S3 object storage instance