All Products
Search
Document Center

ENS:DeploySDG

Last Updated:Apr 16, 2024

Deploys shared data groups (SDGs).

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdsarrayYes

The IDs of instances on which you want to deploy SDGs. You can deploy SDGs on a maximum of 100 instances at a time.

stringYes

The IDs of instances on which you want to deploy SDGs. You can deploy SDGs on a maximum of 100 instances at a time.

["aic-1", "aic-2", "aic-3"]
SDGIdstringYes

The SDG ID. This parameter is used to create a disk, which is attached to an instance.

sdg-xxxxx
DeploymentTypestringNo

The SDG deployment type. Valid values:

  • common (default): read/write deployment. Data updates are written to disks.
  • overlay: read/write splitting deployment. Content in SDGs is read-only. Data updates are written to the local storage of the instance.
common

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The ID of the request.

A331CA96-3948-4BD2-B067-F6174F5C17EA
Dataobject

The returned data object.

Messagestring

The response message. Success is returned for a successful request.

success
Resultobject

The task result.

FailedCountlong

The number of failed tasks.

0
FailedItemsobject []

Details of failed tasks.

ErrMessagestring

The error message.

sdg not found
InstanceIdstring

The ID of the instance.

aic-xxxxx-0
SuccessCountlong

The number of successful tasks.

1
Successboolean

Indicates whether all tasks are successful. Valid values:

  • true: All tasks are successful.
  • false: Failed tasks exist.
true

Examples

Sample success responses

JSONformat

{
  "RequestId": "A331CA96-3948-4BD2-B067-F6174F5C17EA",
  "Data": {
    "Message": "success",
    "Result": {
      "FailedCount": 0,
      "FailedItems": [
        {
          "ErrMessage": "sdg not found",
          "InstanceId": "aic-xxxxx-0"
        }
      ],
      "SuccessCount": 1
    },
    "Success": true
  }
}

Error codes

HTTP status codeError codeError messageDescription
400Interface.Call.ErrorThe interface call error-
400Interface.Call.Failed%s.Request failed
400Parameter.InvalidThe parameter is invalid. Please check your parameters and try it again.The parameter is invalid.
400NoPermissionPermission denied.-
400InvalidParameter.%sThe specified field %s invalid. Please check it again.-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-03-22The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
2024-02-28The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Added Error Codes: 400
2023-11-23The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: DeploymentType