Queries details of an ApsaraDB for Cassandra instance.

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 DescribeCluster

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

ClusterId String Yes cds-bp1b136j****5d58

The ID of the cluster.

Response parameters

Parameter Type Example Description
Cluster Struct

The list of cluster information.

AutoRenewPeriod Integer 12

The period of the auto-renewal.

  • Monthly subscription: The auto-renewal cycle is one month.
  • Annual subscription: The auto-renewal cycle is one year (12 months).
Note Pay-as-you-go instances never expire.
AutoRenewal Boolean true

Specifies whether to enable auto-renewal. Valid values: true or false.

Note Pay-as-you-go instances never expire.
ClusterId String cds-bp1b136j****5d56

The ID of the cluster.

ClusterName String Cassandra-test

The name of the cluster.

The name must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). It must start with a letter.

CreatedTime String 2019-09-20T16:02:34Z

The time when the cluster was created. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC and denoted by Z.

DataCenterCount Integer 1

The number of data centers.

ExpireTime String 2019-10-20T16:02:34Z

The expiration time of the cluster. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC and denoted by Z.

IsLatestVersion Boolean true

Indicates whether the current minor version is the latest.

LockMode String None

The lock mode. Valid values:

  • None: The cluster is not locked.
  • Expired: The cluster is locked upon expiration of subscription.
  • DiskFull: The cluster is locked because the disk is full.
MaintainEndTime String 4:00Z

The end time of the maintenance window of the instance. The time is in the HH:mmZ format. The time is displayed in UTC and denoted by Z.

MaintainStartTime String 2:00Z

The start time of the maintenance window of the instance. The time is in the HH:mmZ 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.7

The minor version number of the cluster.

PayType String PayAsYouGo

The billing method. Valid values:

  • Subscription
  • PayAsYouGo
Note Pay-as-you-go instances never expire.
ResourceGroupId String rg-xxxxxxxxxxx

The ID of the resource group to which the resource belongs.

Status String Running

The running status of the cluster. Examples of valid values:

  • Creating: The cluster is being created.
  • CreateFailed: The cluster failed to be created.
  • Running: The cluster is running.
  • Deleting: The cluster is being deleted.
  • DeleteFailed: The cluster failed to be deleted.
  • Deleted: The cluster is deleted.
Tags Array of Tag

The tag.

Tag
Key String test-key

The tag key.

Value String test-value

The tag value.

RequestId String 17E2B462-5FD3-4A0C-AF13-225C66E47BD5

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeCluster
&ClusterId=cds-bp1b136j****5d58
&<Common request parameters>

Sample success responses

XML format

<RequestId>17E2B462-5FD3-4A0C-AF13-225C66E47BD5</RequestId>
<Cluster>
    <Status>Running</Status>
    <MajorVersion>3.11</MajorVersion>
    <AutoRenewPeriod>12</AutoRenewPeriod>
    <CreatedTime>2019-09-20T16:02:34Z</CreatedTime>
    <ClusterId>cds-bp1b136j****5d56</ClusterId>
    <MinorVersion>3.11.7</MinorVersion>
    <PayType>PayAsYouGo</PayType>
    <LockMode>None</LockMode>
    <IsLatestVersion>true</IsLatestVersion>
    <MaintainEndTime>4:00Z</MaintainEndTime>
    <AutoRenewal>true</AutoRenewal>
    <DataCenterCount>1</DataCenterCount>
    <ClusterName>Cassandra-test</ClusterName>
    <ExpireTime>2019-10-20T16:02:34Z</ExpireTime>
    <MaintainStartTime>2:00Z</MaintainStartTime>
    <ResourceGroupId>rg-xxxxxxxxxxx</ResourceGroupId>
    <Tags>
        <Tag>
            <Value>test-value</Value>
            <Key>test-key</Key>
        </Tag>
    </Tags>
</Cluster>

JSON format

{
    "RequestId": "17E2B462-5FD3-4A0C-AF13-225C66E47BD5",
    "Cluster": {
        "Status": "Running",
        "MajorVersion": 3.11,
        "AutoRenewPeriod": 12,
        "CreatedTime": "2019-09-20T16:02:34Z",
        "ClusterId": "cds-bp1b136j****5d56",
        "MinorVersion": "3.11.7",
        "PayType": "PayAsYouGo",
        "LockMode": "None",
        "IsLatestVersion": true,
        "MaintainEndTime": "4:00Z",
        "AutoRenewal": true,
        "DataCenterCount": 1,
        "ClusterName": "Cassandra-test",
        "ExpireTime": "2019-10-20T16:02:34Z",
        "MaintainStartTime": "2:00Z",
        "ResourceGroupId": "rg-xxxxxxxxxxx",
        "Tags": {
            "Tag": {
                "Value": "test-value",
                "Key": "test-key"
            }
        }
    }
}

Error codes

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