All Products
Search
Document Center

:DeleteSDG

Last Updated:Dec 25, 2024

Deletes a shared data group (SDG).

Operation description

If all the SDGs corresponding to the original disk are deleted, the original disk is automatically cleared.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ens:DeleteSDGnone
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SDGIdarrayYes

The IDs of the SDGs that you want to delete.

stringYes

The ID of the SDG that you want to delete. You can delete a maximum of 10 SDGs at a time.

sdg-xxx

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

86A6D421-A0C7-4C01-8648-47377CA6A2CE
Dataobject

The returned data object.

Messagestring

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

success
Successboolean

Indicates whether all tasks are successful. Valid values:

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

The execution result of the synchronization request.

FailedCountlong

The number of failed tasks.

0
SuccessCountlong

The number of successful tasks.

1
FailedItemsarray<object>

Details about the failed tasks.

FailedItemsobject

Details about a failed task.

Itemobject

Description

SdgIdstring

The ID of the shared data group (SDG).

sdg-dfet5vvvgy
ErrMessagestring

The error message.

sdg not found

Examples

Sample success responses

JSONformat

{
  "RequestId": "86A6D421-A0C7-4C01-8648-47377CA6A2CE",
  "Data": {
    "Message": "success",
    "Success": true,
    "Result": {
      "FailedCount": 0,
      "SuccessCount": 1,
      "FailedItems": [
        {
          "Item": {
            "SdgId": "sdg-dfet5vvvgy\n"
          },
          "ErrMessage": "sdg not found"
        }
      ]
    }
  }
}

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-06-27The Error code has changed. The response structure of the API has changedView Change Details
2024-03-22The Error code has changedView Change Details