Queries information about a specified cluster.
Debugging
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:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| yundun-hsm:GetCluster | get | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ClusterId | string | Yes | The ID of the cluster. | cluster-p94y1dud9ts**** |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
"Cluster": {
"ClusterId": "cluster-p94y1dud9ts****",
"ClusterName": "cluster_polar_****",
"Status": "NEW",
"CreateTime": 1641275680000,
"RegionId": "cn-hangzhou",
"VpcId": "vpc-8vbt0fjdm29hofvbo****",
"Whitelist": "130.176.XX.XX",
"Zones": [
{
"VSwitchId": "vsw-uf61s651p69bdgmki****",
"ZoneId": "cn-hangzhou-j"
}
],
"DeviceType": "jnta",
"ClusterCsr": "-----BEGIN CERTIFICATE REQUEST-----\\nMIIC5TCCAc0CAQAwgZ8xWTAJBgNVBAYTAlVTMAkGA1UECAwCQ0EwDQYDVQQKDAZD\\nYXZpdW0wDQYDVQQLDAZOM0ZJUFMwDgYDVQQHDAdTYW5Kb3NlMBMGA1UdEQwMMTk****\n-----END CERTIFICATE REQUEST-----",
"ClusterCertificate": "-----BEGIN CERTIFICATE-----\nMIIDfTCCAmWgAwIBAgIJAMRqQMr5if66MA0GCSqGSIb3DQEBCwUAMFUxCzAJBgNV\nBAYTAmNuMQswCQYDVQQIDAJ6ajELMAkGA1UEBwwCaHoxFjAUBgNVBAoMDUFsaWJh\nYmEgQ2xvdWQxFDA****\n-----END CERTIFICATE-----",
"ClusterOwnerCertificate": "----BEGIN CERTIFICATE-----\nMIIDaTCCAlECAQEwDQYJKoZIhvcNAQELBQAwVTELMAkGA1UEBhMCY24xCzAJBgNV\nBAgMAnpqMQswCQYDVQQHDAJoejEWMBQGA1UECgwNQWxpYmFiYSBDbG91ZDEUMBIG\nA1UECwwLU2VjQ2xvdWRIc20wHhcNMjQwNzAzM****\n-----END CERTIFICATE-----",
"Size": 2,
"Instances": [
{
"InstanceId": "hsm-cn-g6z3v0uf****",
"NodeId": 1,
"Master": true
}
],
"ClusterMode": 2
}
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | SwitchMaster.InstanceInvalid | Instance not in the cluster. | - |
| 400 | LeaveCluster.MasterLast | Master instance can not leave a cluster until all other instances are left. | - |
| 400 | Certificate.ChainInvalid | Certificate chain invalid. Please make sure issuer certificate is the trust anchor and cluster certificate is signed by issuer certificate. | - |
| 400 | Certificate.FormatInvalid | Certificate format invalid. Cluster/Issuer certificate must be in PEM format. | - |
| 400 | ConfigClusterSubnet.DuplicateZone | VSwitches should not contain duplicate zones. | - |
| 400 | InvalidApiParam.Error | api param is invalid | - |
| 400 | InvalidClusterName | Invalid parameter clusterName. | - |
| 400 | InvalidPageSize | Invalid parameter pageSize. | - |
| 400 | InvalidCurrentPage | Invalid parameter currentPage. | - |
| 400 | InvalidRegionId | Invalid parameter regionId. | - |
| 400 | InvalidVSwitch | Invalid parameter vSwitch. | - |
| 400 | InvalidVpc | Invalid parameter vpcId. | - |
| 400 | InvalidIp | Invalid parameter IP. | - |
| 400 | InvalidAliuid | Invalid parameter aliuid. | - |
| 400 | InvalidClusterId | Invalid parameter clusterId. | - |
| 400 | InvalidInstanceId | Invalid parameter instanceId. | - |
| 400 | InvalidBackupId | Invalid parameter backupId. | - |
| 400 | InvalidImageId | Invalid parameter imageId. | - |
| 400 | HsmInstanceNotExist.Error | hsm instance not exist | - |
| 400 | HSMIntanceNotActived.Error | hsm intance is not actived | - |
| 400 | WhiteListMaxCount.Error | whilte list is more than max count | - |
| 400 | ClusterIdIsNotExists.Error | cluster ID non-exists | - |
| 400 | InstanceListIsEmpty.Error | instance list is empty | - |
| 400 | InstanceIdIsEmpty.Error | instance id is empty | - |
| 400 | InstanceIsNotExistsInCluster.Error | cluster has no such instance | - |
| 400 | InstanceIsExistsInCluster.Error | instance already in the cluster | - |
| 400 | RegionNoEmpty.Error | region no. is empty | - |
| 400 | ClusterNameEmpty.Error | empty cluster name not allowed | - |
| 400 | ClusterNameIsExists.Error | the cluster name is already taken | - |
| 400 | IpNotValid.Error | ip not valid | - |
| 400 | ClusterIsEmpty.Error | cluster is empty | - |
| 400 | NoMasterFoundInCluster.Error | cluster has no master instance | - |
| 400 | HsmInstanceIdNotFound.Error | no such instance | - |
| 400 | NoInstanceFoundInCluster.Error | cluster is empty | - |
| 400 | Whitelist.Invalid | Whitelist blocks not in CIDR format. | - |
| 400 | Whitelist.TooLong | Whitelist too long, exceeds 10 CIDR blocks. | - |
| 403 | NoPermission | Caller has no permission on the resource. | - |
| 403 | InstanceNotPaused | Please pause the instance before reset. | - |
| 403 | InstanceNotActive | Instance is not active. | - |
| 403 | ConfigIp.IncorrectState | Instance not in pending or active state, can not config IP address. | - |
| 403 | SwitchMaster.IncorrectState | Cluster not initialized, please initialize the cluster first. | - |
| 403 | SyncCluster.IncorrectState | Cluster not initialized, please initialize the cluster first. | - |
| 403 | LeaveCluster.InstanceInvalid | The instance is not in the cluster. | - |
| 403 | DeleteCluster.IncorrectState | Cluster not empty, please remove all instances first. | - |
| 403 | JoinCluster.InstanceVSwitchNotInCluster | Instance's vSwitch is not in cluster config, please change instance's vSwitch first. | - |
| 403 | JoinCluster.InstanceInitialized | Initialized instance can not join a cluster. | - |
| 403 | JoinCluster.IncorrectState | Cluster not initialized, please initialize the cluster first. | - |
| 403 | InitializeCluster.InstanceNotInitialized | Cluster master instance not initialized, please initialize cluster master instance first. | - |
| 403 | InitializeCluster.IncorrectConfig | Cluster subnet not configured, please config cluster subnet first. | - |
| 403 | InitializeCluster.IncorrectState | Cluster initialized, do not re-initialize. | - |
| 403 | Cluster.CN.ActionForbidden | This API is forbidden for non-international site cluster. | - |
| 403 | Cluster.INTL.ActionForbidden | This API is forbidden for international site cluster. | - |
| 403 | ConfigClusterCertificate.IncorrectState | Cluster initialized or certificates already configured. | - |
| 403 | ConfigClusterSubnet.InvalidVpcId | VPC Id invalid. Cluster VPC is the same as cluster master's VPC. | - |
| 403 | ConfigClusterSubnet.InvalidVSwitchId | VSwitch Id invalid. VSwitches should contain all current cluster vSwitches. | - |
| 403 | ConfigClusterSubnet.IncorrectState | Cluster not in NEW state, can not config cluster subnet. | - |
| 403 | ClusterName.Exist | Cluster name already exists, please use another name. | - |
| 403 | Whitelist.InstanceInCluster | Whitelist.InstanceInCluster | - |
| 404 | Resource.NotFound | Resource not found. | - |
| 405 | ClusterAPI.NotSupported | ClusterAPI not supported in this region. | - |
| 409 | Conflict | Resource is being updated by a previous request. Current request is redundant. | - |
| 409 | Cluster.Conflict | The cluster is being updated by a previous request. Please try again later. | - |
| 500 | ConfigWhitelistFailed.Error | config white list error | - |
| 500 | ActionFailed.Error | internal error, please try again | - |
| 500 | InternalError | The request processing has failed due to some unknown error. | Unknown error caused request processing to fail. |
For a list of error codes, visit the Service error codes.