You can call this operation to query the clusters that have been deleted.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeDeletedClusters

The operation that you want to perform. Set the value to DescribeDeletedClusters.

RegionId String No cn-hangzhou

The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.

PageNumber Integer No 1

The number of the page to return. Valid values: any non-zero positive integer.

Default value: 1

PageSize Integer No 20

The number of entries to return on each page.

Response parameters

Parameter Type Example Description
Clusters Array

The list of clusters that have been deleted.

Cluster
ClusterId String cds-bp1hy2ip****z46g

The ID of the cluster.

ClusterName String Cassandra-test-wjk

The name of the cluster.

CreatedTime String 2019-10-09T14:59:31Z

The time when the cluster was created. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC and denoted by Z.

DataCenterCount Integer 1

The number of cluster data center.

ExpireTime String 2019-10-09T20:29:27Z

The expiration time of the cluster. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC and denoted by Z.

MajorVersion String 3.11

The major version number of the cluster.

MinorVersion String 3.11.5

The minor version number of the cluster.

PayType String PayAsYouGo

The billing method. Valid values:

  • Subscription
  • PayAsYouGo
Note Pay-as-you-go clusters never expire.
Status String Deleted

The running status of the cluster. Valid values:

  • Creating
  • CreateFailed
  • Running
  • Deleting
  • DeleteFailed
  • Deleted
PageNumber Integer 1

The page number of the returned page.Valid values: any non-zero positive integer.

Default value: 1

PageSize Integer 10

The number of entries returned per page.

RequestId String 018F3C6E-2F9F-4181-8602-4AB4FB86F4ED

The ID of the request.

TotalCount Long 3

The total number of clusters returned.

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeDeletedClusters
&<Common request parameters>

Sample success responses

XML format

<DescribeDeletedClustersResponse>
  <PageNumber>1</PageNumber>
  <TotalCount>3</TotalCount>
  <Clusters>
        <Cluster>
              <Status>Deleted</Status>
              <CreatedTime>2019-10-09T14:59:31Z</CreatedTime>
              <MinorVersion>3.11.5</MinorVersion>
              <ClusterName>Cassandra-test-wjk</ClusterName>
              <ClusterId>cds-bp1hy2ip****z46g</ClusterId>
              <ExpireTime>2019-10-09T20:29:27Z</ExpireTime>
              <DataCenterCount>1</DataCenterCount>
              <PayType>PayAsYouGo</PayType>
              <MajorVersion>3.11</MajorVersion>
        </Cluster>
        <Cluster>
              <Status>Deleted</Status>
              <CreatedTime>2019-09-24T20:37:17Z</CreatedTime>
              <MinorVersion>3.11.5</MinorVersion>
              <ClusterName>baitu-resize-disk-size</ClusterName>
              <ClusterId>cds-bp1354yf****35bw</ClusterId>
              <ExpireTime>2019-10-08T20:16:22Z</ExpireTime>
              <DataCenterCount>1</DataCenterCount>
              <PayType>PayAsYouGo</PayType>
              <MajorVersion>3.11</MajorVersion>
        </Cluster>
        <Cluster>
              <Status>Deleted</Status>
              <CreatedTime>2019-09-23T11:45:48Z</CreatedTime>
              <MinorVersion>3.11.5</MinorVersion>
              <ClusterName>baitu-4c16gaaa</ClusterName>
              <ClusterId>cds-bp1ia8ui****8dle</ClusterId>
              <ExpireTime>2019-10-08T20:16:19Z</ExpireTime>
              <DataCenterCount>1</DataCenterCount>
              <PayType>PayAsYouGo</PayType>
              <MajorVersion>3.11</MajorVersion>
        </Cluster>
  </Clusters>
  <PageSize>10</PageSize>
  <RequestId>018F3C6E-2F9F-4181-8602-4AB4FB86F4ED</RequestId>
</DescribeDeletedClustersResponse>

JSON format

{
  "PageNumber": 1,
  "TotalCount": 3,
  "Clusters": {
    "Cluster": [
      {
        "Status": "Deleted",
        "CreatedTime": "2019-10-09T14:59:31Z",
        "MinorVersion": "3.11.5",
        "ClusterName": "Cassandra-test-wjk",
        "ClusterId": "cds-bp1hy2ip****z46g",
        "ExpireTime": "2019-10-09T20:29:27Z",
        "DataCenterCount": 1,
        "PayType": "PayAsYouGo",
        "MajorVersion": "3.11"
      },
      {
        "Status": "Deleted",
        "CreatedTime": "2019-09-24T20:37:17Z",
        "MinorVersion": "3.11.5",
        "ClusterName": "baitu-resize-disk-size",
        "ClusterId": "cds-bp1354yf****35bw",
        "ExpireTime": "2019-10-08T20:16:22Z",
        "DataCenterCount": 1,
        "PayType": "PayAsYouGo",
        "MajorVersion": "3.11"
      },
      {
        "Status": "Deleted",
        "CreatedTime": "2019-09-23T11:45:48Z",
        "MinorVersion": "3.11.5",
        "ClusterName": "baitu-4c16gaaa",
        "ClusterId": "cds-bp1ia8ui****8dle",
        "ExpireTime": "2019-10-08T20:16:19Z",
        "DataCenterCount": 1,
        "PayType": "PayAsYouGo",
        "MajorVersion": "3.11"
      }
    ]
  },
  "PageSize": 10,
  "RequestId": "018F3C6E-2F9F-4181-8602-4AB4FB86F4ED"
}

Error codes

For a list of error codes, visit the API Error Center.