GetCluster API で HSM クラスターの詳細をクエリ - KMS - Alibaba Cloud - Key Management Service

指定されたクラスターの情報を照会します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

yundun-hsm:GetCluster

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ClusterId	string	必須	クラスターID。	cluster-p94y1dud9ts****

レスポンスフィールド

フィールド	型	説明	例
	object	PlainResult
RequestId	string	リクエストID。Alibaba Cloudは各リクエストに対して一意の識別子を生成します。リクエストIDを使用して問題のトラブルシューティングを行うことができます。	4C467B38-3910-447D-87BC-AC049166F216
Cluster	object	クラスター情報。
ClusterId	string	クラスターID。	cluster-p94y1dud9ts****
ClusterName	string	クラスター名。	cluster_polar_****
Status	string	クラスターのステータス。有効な値： NEW：未初期化 INITIALIZED：初期化済み DELETED：削除済み SYNCHRONIZING：同期中 TO_DELETE：削除保留中。	NEW
CreateTime	integer	クラスターが作成された時刻（ミリ秒単位）。値はUNIXタイムスタンプです。	1641275680000
RegionId	string	クラスターのリージョンID。	cn-hangzhou
VpcId	string	クラスターが属するVPCのID。	vpc-8vbt0fjdm29hofvbo****
Whitelist	string	クラスターのアクセスホワイトリスト。	130.176.XX.XX
Zones	array<object>	クラスターのゾーン。
	object	ゾーン。
VSwitchId	string	vSwitch ID。	vsw-uf61s651p69bdgmki****
ZoneId	string	ゾーン ID。	cn-hangzhou-j
DeviceType	string	デバイスタイプ。	jnta
ClusterCsr	string	クラスターの証明書署名リクエスト（CSR）ファイル。	-----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	HSM インスタンスの ID。	hsm-cn-g6z3v0uf****
NodeId	integer	クラスタ内の HSM インスタンスの番号。	1
Master	boolean	インスタンスがマスター HSM であるかどうかを示します。 true: はい false: いいえ	true
ClusterMode	integer	クラスターモード。 2：自動同期クラスター。	2
EntityCertExpireTime	string	クラスターのマネージド証明書の有効期限（ミリ秒単位）。値はUNIXタイムスタンプです。この値は、CertManagedがtrueに設定されている場合にのみ有効です。	1641275680000
CertManaged	boolean	クラスター証明書がマネージドであるかどうかを示します。有効な値： true：クラスター証明書はマネージドです。 false：クラスター証明書はマネージドではありません。	true
KmsInstanceId	string		kst-xxx

例

成功レスポンス

JSONJSON

{
  "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 ステータスコード	エラーコード	エラーメッセージ
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.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。