查詢指定叢集資訊。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
yundun-hsm:GetCluster |
get |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| ClusterId |
string |
是 |
叢集 ID。 |
cluster-p94y1dud9ts**** |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
PlainResult |
||
| RequestId |
string |
本次調用請求的 ID，是由阿里雲為該請求產生的唯一識別碼，可用於排查和定位問題。 |
4C467B38-3910-447D-87BC-AC049166F216 |
| Cluster |
object |
叢集資訊。 |
|
| ClusterId |
string |
叢集 ID。 |
cluster-p94y1dud9ts**** |
| ClusterName |
string |
叢集名稱。 |
cluster_polar_**** |
| Status |
string |
叢集狀態。
|
NEW |
| CreateTime |
integer |
叢集建立時間，精確到毫秒。時間戳記格式。 |
1641275680000 |
| RegionId |
string |
叢集所在地區 ID。 |
cn-hangzhou |
| VpcId |
string |
叢集所屬 VPC ID。 |
vpc-8vbt0fjdm29hofvbo**** |
| Whitelist |
string |
叢集訪問白名單列表。 |
130.176.XX.XX |
| Zones |
array<object> |
叢集可用性區域列表。 |
|
|
object |
可用性區域。 |
||
| VSwitchId |
string |
交換器 ID。 |
vsw-uf61s651p69bdgmki**** |
| ZoneId |
string |
可用性區域 ID。 |
cn-hangzhou-j |
| DeviceType |
string |
裝置類型。 |
jnta |
| ClusterCsr |
string |
叢集認證簽章要求檔案。 |
-----BEGIN CERTIFICATE REQUEST-----\nMIIC5TCCAc0CAQAwgZ8xWTAJBgNVBAYTAlVTMAkGA1UECAwCQ0EwDQYDVQQKDAZD\nYXZpdW0wDQYDVQQLDAZOM0ZJUFMwDgYDVQQHDAdTYW5Kb3NlMBMGA1UdEQwMMTk**** -----END CERTIFICATE REQUEST----- |
| ClusterCertificate |
string |
叢集認證。 |
-----BEGIN CERTIFICATE----- MIIDfTCCAmWgAwIBAgIJAMRqQMr5if66MA0GCSqGSIb3DQEBCwUAMFUxCzAJBgNV BAYTAmNuMQswCQYDVQQIDAJ6ajELMAkGA1UEBwwCaHoxFjAUBgNVBAoMDUFsaWJh YmEgQ2xvdWQxFDA**** -----END CERTIFICATE----- |
| ClusterOwnerCertificate |
string |
叢集自我簽署憑證。 |
----BEGIN CERTIFICATE----- MIIDaTCCAlECAQEwDQYJKoZIhvcNAQELBQAwVTELMAkGA1UEBhMCY24xCzAJBgNV BAgMAnpqMQswCQYDVQQHDAJoejEWMBQGA1UECgwNQWxpYmFiYSBDbG91ZDEUMBIG A1UECwwLU2VjQ2xvdWRIc20wHhcNMjQwNzAzM**** -----END CERTIFICATE----- |
| Size |
integer |
叢集內執行個體數量。 |
2 |
| Instances |
array<object> |
叢集執行個體列表。 |
|
|
object |
密碼機執行個體資訊。 |
||
| InstanceId |
string |
密碼機執行個體 ID。 |
hsm-cn-g6z3v0uf**** |
| NodeId |
integer |
密碼機執行個體在叢集中的編號。 |
1 |
| Master |
boolean |
是否為主密碼機。
|
true |
| ClusterMode |
integer |
叢集模式。 2: 自動同步叢集 |
2 |
| EntityCertExpireTime |
string |
叢集託管認證到期時間，精確到毫秒，時間戳記格式。 僅當 CertManaged 為 true 時該值有意義。 |
1641275680000 |
| CertManaged |
boolean |
叢集認證是否託管。
|
true |
樣本
正常返回樣本
JSON格式
{
"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,
"EntityCertExpireTime": "1641275680000",
"CertManaged": true
}
}錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 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. | |
| 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. | 未知錯誤導致請求處理失敗。 |
| 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. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。