Jump to

• Request
• Response

2-Configure the Clone Data Center for MDC

post

/oam/services/rest/mdc/clone

To be executed only on the clone data center. It contacts the master DC to download the generated cloning artifatcs and then applies the configurations on the clone, thereby making this DC as a MDC clone

Request

Supported Media Types

• application/json

Body ()

These input parameters enable the clone DC to reach out to the master to download the cloning artifacts

Root Schema : configureCloneParameters

Type: object

Show Source

• artifactPassword: string
  Password used for protecting the cloning artifacts. This should be the same password that was passed during setup of master
• artifactsZipLocation(optional): string
  Location where backup artifacts has to be stored. OPTIONAL - To be specified if backup artifacts has to be stored in any location other than /tmp
• forceOverWrite(optional): string
  true|false. OPTIONAL - To OverWrite the Existing MDC Configuration or to recover from Inconsistent State
• masterAdminUserNamePassword(optional): string
  UserName:Password of Master DC Administrator. OPTIONAL - To be specified when the Master and Clone Admin Users/Password are different
• masterArtifactsZipLocation(optional): string
  Location where cloning artifacts are present in Master DC. OPTIONAL - To be specified when artifactsZipLocation was used in input while configuring Master Data Center
• masterServerPolicyManagerURL: string
  URL of the master policy manager endpoint or the URL of the reverse proxy front-ending the master policy manager.
• masterServerURL: string
  URL of the master admin server or the URL of the reverse proxy front-ending the master admin server

{
    "type":"object",
    "required":[
        "masterServerURL",
        "masterServerPolicyManagerURL",
        "artifactPassword"
    ],
    "properties":{
        "masterServerURL":{
            "type":"string",
            "description":"URL of the master admin server or the URL of the reverse proxy front-ending the master admin server"
        },
        "masterServerPolicyManagerURL":{
            "type":"string",
            "description":"URL of the master policy manager endpoint or the URL of the reverse proxy front-ending the master policy manager."
        },
        "artifactPassword":{
            "type":"string",
            "description":"Password used for protecting the cloning artifacts. This should be the same password that was passed during setup of master"
        },
        "masterAdminUserNamePassword":{
            "type":"string",
            "description":"UserName:Password of Master DC Administrator. OPTIONAL - To be specified when the Master and Clone Admin Users/Password are different"
        },
        "artifactsZipLocation":{
            "type":"string",
            "description":"Location where backup artifacts has to be stored. OPTIONAL - To be specified if backup artifacts has to be stored in any location other than /tmp"
        },
        "masterArtifactsZipLocation":{
            "type":"string",
            "description":"Location where cloning artifacts are present in Master DC. OPTIONAL - To be specified when artifactsZipLocation was used in input while configuring Master Data Center"
        },
        "forceOverWrite":{
            "type":"string",
            "description":"true|false. OPTIONAL - To OverWrite the Existing MDC Configuration or to recover from Inconsistent State"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

The cloning articacts were downloaded and applied on the clone successfully

Body ()

Root Schema : responseConfigureClone

Type: object

Show Source

• responseCode(optional): string
• responseDetails(optional): object responseDetails
• responseText(optional): string

{
    "type":"object",
    "properties":{
        "responseCode":{
            "type":"string"
        },
        "responseText":{
            "type":"string"
        },
        "responseDetails":{
            "type":"object",
            "properties":{
                "CloneArtifactsBackupLocation":{
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : responseDetails

Type: object

Show Source

• CloneArtifactsBackupLocation(optional): string

{
    "type":"object",
    "properties":{
        "CloneArtifactsBackupLocation":{
            "type":"string"
        }
    }
}

400 Response

Error

Body ()

Root Schema : errorresponse

Type: object

Show Source

• errorCode(optional): string
• errorDesc(optional): string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorDesc":{
            "type":"string"
        }
    }
}

401 Response

Error

Body ()

Root Schema : errorresponse

Type: object

Show Source

• errorCode(optional): string
• errorDesc(optional): string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorDesc":{
            "type":"string"
        }
    }
}

500 Response

Error

Body ()

Root Schema : errorresponse

Type: object

Show Source

• errorCode(optional): string
• errorDesc(optional): string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorDesc":{
            "type":"string"
        }
    }
}

504 Response

Error

Body ()

Root Schema : errorresponse

Type: object

Show Source

• errorCode(optional): string
• errorDesc(optional): string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorDesc":{
            "type":"string"
        }
    }
}

Back to Top