'1.0', 'info' => ['style' => 'RPC', 'product' => 'hsm', 'version' => '2023-11-13'], 'directories' => [ [ 'children' => ['ConfigAuditLog', 'GetAuditLogStatus', 'InitializeAuditLog'], 'type' => 'directory', 'title' => 'Audit logs', ], [ 'children' => ['ConfigImageRemark'], 'type' => 'directory', 'title' => 'Images', ], [ 'children' => ['EnableBackup', 'GetBackup', 'ConfigBackupTask', 'ConfigBackupRemark'], 'type' => 'directory', 'title' => 'Backups', ], [ 'children' => ['JoinCluster', 'InitializeCluster', 'SwitchClusterMaster', 'ConfigClusterName', 'LeaveCluster', 'ConfigClusterCertificate', 'GetCluster', 'ConfigClusterWhitelist', 'QuickDeployCluster', 'RotateClusterManagedCert', 'DownloadClusterManagedCert'], 'type' => 'directory', 'title' => 'Clusters', ], [ 'children' => ['ResetInstance', 'QuickInitInstance', 'ConfigInstanceRemark'], 'type' => 'directory', 'title' => 'Instances', ], [ 'children' => [ 'GetJob', 'ConfigClusterSubnet', 'ConfigInstanceIpAddress', 'ConfigInstanceWhitelist', 'CopyImage', 'CreateCluster', 'DeleteCluster', 'DescribeRegions', 'ExportImage', 'GetImage', 'GetInstance', 'ListBackups', 'ListClusters', 'ListImages', 'ListInstances', 'MoveResourceGroup', 'PauseInstance', 'ResetBackup', 'RestoreInstance', 'ResumeInstance', 'SyncCluster', ], 'type' => 'directory', 'title' => 'Others', ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ 'ConfigAuditLog' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => ['FEATUREhsmVF2KT5'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the region.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'AuditOssBucket', 'in' => 'query', 'schema' => ['description' => 'The bucket to which audit logs are delivered.', 'type' => 'string', 'required' => false, 'example' => 'hsm-log', 'title' => ''], ], [ 'name' => 'AuditAction', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable the audit log feature. Valid values:'."\n" ."\n" .'- enable'."\n" ."\n" .'- disable', 'enumValueTitles' => [], 'type' => 'string', 'required' => true, 'enum' => ['disable', 'enable'], 'example' => 'enable', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '42B118FB-16A6-56FB-B877-D58637EEC6AF', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'OSSPermissionDenied.Error', 'errorMessage' => '获取OSS bucket权限失败，请检查对应OSS权限设置: %s', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => 'Unknown error caused request processing to fail.'], ], ], 'title' => 'ConfigAuditLog', 'summary' => 'Enables or disables the audit log feature and delivers audit logs to buckets.', 'description' => '- The region of the bucket must be the same as the region where the security audit feature is enabled.'."\n" ."\n" .'- If the security audit feature is enabled, do not delete Object Storage Service (OSS) buckets. If you delete OSS buckets, audit logs fail to be delivered.'."\n" ."\n" .'- Only electronic virtual security modules (EVSMs) and general virtual security modules (GVSMs) within the Chinese mainland support the security audit feature.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:ConfigAuditLog', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"42B118FB-16A6-56FB-B877-D58637EEC6AF\\"\\n}","type":"json"}]', ], 'ConfigBackupRemark' => [ 'summary' => 'Configure the name and remark information of a backup.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '203655', 'abilityTreeNodes' => ['FEATUREhsmQEGDGS'], ], 'parameters' => [ [ 'name' => 'BackupId', 'in' => 'query', 'schema' => ['description' => 'The backup ID.', 'type' => 'string', 'required' => true, 'example' => 'backup-fdb897sdfg****', 'title' => ''], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => ['description' => 'The remark information of the backup.', 'type' => 'string', 'required' => false, 'example' => 'Backup-Feb-9-test-1B', 'title' => ''], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'The backup name.', 'type' => 'string', 'required' => false, 'example' => 'backup-test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The structure of the response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID, which is a unique identifier generated by Alibaba Cloud for the request. You can use the ID to troubleshoot issues.', 'type' => 'string', 'example' => '4C467B38-3910-447D-87BC-AC049166F216'], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidApiParam.Error', 'errorMessage' => 'api param is invalid', 'description' => ''], ], 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'caller has no permission', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => 'Unknown error caused request processing to fail.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ConfigBackupRemark', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:ConfigBackupRemark', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C467B38-3910-447D-87BC-AC049166F216\\"\\n}","type":"json"}]', ], 'ConfigBackupTask' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREhsmV7VE3Y', 'FEATUREhsm01FLNB', 'FEATUREhsmGIFYCG', 'FEATUREhsmLBBV5W'], ], 'parameters' => [ [ 'name' => 'BackupId', 'in' => 'query', 'schema' => ['description' => 'The backup ID.', 'type' => 'string', 'required' => true, 'example' => 'backup-173620705****', 'title' => ''], ], [ 'name' => 'BackupPeriod', 'in' => 'query', 'schema' => [ 'description' => 'The automatic backup interval, in days. Valid values: 1, 3, 7, and 30.', 'enumValueTitles' => [], 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '30', 'minimum' => '1', 'enum' => ['1', '3', '7', '30'], 'example' => '3', 'title' => '', ], ], [ 'name' => 'BackupHourInDay', 'in' => 'query', 'schema' => [ 'description' => 'The backup time in 24-hour format. Valid values: 1 to 24.', 'enumValueTitles' => [], 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '23', 'minimum' => '0', 'enum' => [ '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '10', '11', '12', '13', '14', '15', '16', '17', '18', '19', '20', '21', '22', '23', ], 'example' => '12', 'title' => '', ], ], [ 'name' => 'Manual2PeriodicList', 'in' => 'query', 'style' => 'flat', 'schema' => [ 'description' => 'A list of image IDs to change from manual backup to automatic backup.', 'type' => 'array', 'items' => ['description' => 'The ID of an image to change from manual backup to automatic backup.', 'type' => 'string', 'required' => false, 'example' => 'image-haiduf23bj****', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'Periodic2ManualList', 'in' => 'query', 'style' => 'flat', 'schema' => [ 'description' => 'A list of image IDs to change from automatic backup to manual backup.', 'type' => 'array', 'items' => ['description' => 'The ID of an image to change from automatic backup to manual backup.', 'type' => 'string', 'required' => false, 'example' => 'image-daiduahsbj****', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request. Alibaba Cloud generates a unique ID for each request. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '4C467B38-3910-447D-87BC-AC049166F216', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidApiParam.Error', 'errorMessage' => 'api param is invalid', 'description' => ''], ], 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'caller has no permission', 'description' => ''], ['errorCode' => 'Backup.ActionForbidden', 'errorMessage' => 'This API is forbidden for this backup type.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => 'Unknown error caused request processing to fail.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ConfigBackupTask', 'summary' => 'Modifies the execution pattern of a backup task.', 'description' => 'This operation applies only to backup tasks for Hardware Security Module (HSM) instances in the Chinese mainland.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:ConfigBackupTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C467B38-3910-447D-87BC-AC049166F216\\"\\n}","type":"json"}]', ], 'ConfigClusterCertificate' => [ 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREhsmLBBV5W'], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the cluster.', 'type' => 'string', 'required' => true, 'example' => 'cluster-BqxX63Bsg****', 'title' => ''], ], [ 'name' => 'IssuerCertificate', 'in' => 'formData', 'schema' => ['description' => 'The self-signed certificate.', 'type' => 'string', 'required' => true, 'example' => '-----BEGIN CERTIFICATE-----'."\n" .'MIIDfTCCAmWgAwIBAgIJAMRqQMr5if66MA0GCSqGSIb3DQEBCwUAMFUxCzAJBgNV'."\n" .'BAYTAmNuMQswCQYDVQQIDAJ6ajELMAkGA1UEBwwCaHoxFjAUBgNVBAoMDUFsaWJh'."\n" .'YmEgQ2xvdWQxFDA****'."\n" .'-----END CERTIFICATE-----', 'title' => ''], ], [ 'name' => 'ClusterCertificate', 'in' => 'formData', 'schema' => ['description' => 'The cluster certificate.', 'type' => 'string', 'required' => true, 'example' => '-----BEGIN CERTIFICATE-----'."\n" .'MIIDaTCCAlECAQEwDQYJKoZIhvcNAQELBQAwVTELMAkGA1UEBhMCY24xCzAJBgNV'."\n" .'BAgMAnpqMQswCQYDVQQHDAJoejEWMBQGA1UECgwNQWxpYmFiYSBDbG91ZDEUMBIG'."\n" .'A1UECwwLU2VjQ2xvdWRIc20wHhcNMjQwNzAzM****-----END CERTIFICATE-----', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'BaseResult', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4C467B38-3910-447D-87BC-AC049166F216', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'SwitchMaster.InstanceInvalid', 'errorMessage' => 'Instance not in the cluster.', 'description' => ''], ['errorCode' => 'LeaveCluster.MasterLast', 'errorMessage' => 'Master instance can not leave a cluster until all other instances are left.', 'description' => ''], ['errorCode' => 'Certificate.ChainInvalid', 'errorMessage' => 'Certificate chain invalid. Please make sure issuer certificate is the trust anchor and cluster certificate is signed by issuer certificate.', 'description' => ''], ['errorCode' => 'Certificate.FormatInvalid', 'errorMessage' => 'Certificate format invalid. Cluster/Issuer certificate must be in PEM format.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.DuplicateZone', 'errorMessage' => 'VSwitches should not contain duplicate zones.', 'description' => ''], ['errorCode' => 'InvalidApiParam.Error', 'errorMessage' => 'api param is invalid', 'description' => ''], ['errorCode' => 'InvalidClusterName', 'errorMessage' => 'Invalid parameter clusterName.', 'description' => ''], ['errorCode' => 'InvalidPageSize', 'errorMessage' => 'Invalid parameter pageSize.', 'description' => ''], ['errorCode' => 'InvalidCurrentPage', 'errorMessage' => 'Invalid parameter currentPage.', 'description' => ''], ['errorCode' => 'InvalidRegionId', 'errorMessage' => 'Invalid parameter regionId.', 'description' => ''], ['errorCode' => 'InvalidVSwitch', 'errorMessage' => 'Invalid parameter vSwitch.', 'description' => ''], ['errorCode' => 'InvalidVpc', 'errorMessage' => 'Invalid parameter vpcId.', 'description' => ''], ['errorCode' => 'InvalidIp', 'errorMessage' => 'Invalid parameter IP.', 'description' => ''], ['errorCode' => 'InvalidAliuid', 'errorMessage' => 'Invalid parameter aliuid.', 'description' => ''], ['errorCode' => 'InvalidClusterId', 'errorMessage' => 'Invalid parameter clusterId.', 'description' => ''], ['errorCode' => 'InvalidInstanceId', 'errorMessage' => 'Invalid parameter instanceId.', 'description' => ''], ['errorCode' => 'InvalidBackupId', 'errorMessage' => 'Invalid parameter backupId.', 'description' => ''], ['errorCode' => 'InvalidImageId', 'errorMessage' => 'Invalid parameter imageId.', 'description' => ''], ['errorCode' => 'HsmInstanceNotExist.Error', 'errorMessage' => 'hsm instance not exist', 'description' => ''], ['errorCode' => 'HSMIntanceNotActived.Error', 'errorMessage' => 'hsm intance is not actived', 'description' => ''], ['errorCode' => 'WhiteListMaxCount.Error', 'errorMessage' => 'whilte list is more than max count', 'description' => ''], ['errorCode' => 'ClusterIdIsNotExists.Error', 'errorMessage' => 'cluster ID non-exists', 'description' => ''], ['errorCode' => 'InstanceListIsEmpty.Error', 'errorMessage' => 'instance list is empty', 'description' => ''], ['errorCode' => 'InstanceIdIsEmpty.Error', 'errorMessage' => 'instance id is empty', 'description' => ''], ['errorCode' => 'InstanceIsNotExistsInCluster.Error', 'errorMessage' => 'cluster has no such instance', 'description' => ''], ['errorCode' => 'InstanceIsExistsInCluster.Error', 'errorMessage' => 'instance already in the cluster', 'description' => ''], ['errorCode' => 'RegionNoEmpty.Error', 'errorMessage' => 'region no. is empty', 'description' => ''], ['errorCode' => 'ClusterNameEmpty.Error', 'errorMessage' => 'empty cluster name not allowed', 'description' => ''], ['errorCode' => 'ClusterNameIsExists.Error', 'errorMessage' => 'the cluster name is already taken', 'description' => ''], ['errorCode' => 'IpNotValid.Error', 'errorMessage' => 'ip not valid', 'description' => ''], ['errorCode' => 'ClusterIsEmpty.Error', 'errorMessage' => 'cluster is empty', 'description' => ''], ['errorCode' => 'NoMasterFoundInCluster.Error', 'errorMessage' => 'cluster has no master instance', 'description' => ''], ['errorCode' => 'HsmInstanceIdNotFound.Error', 'errorMessage' => 'no such instance', 'description' => ''], ['errorCode' => 'NoInstanceFoundInCluster.Error', 'errorMessage' => 'cluster is empty', 'description' => ''], ['errorCode' => 'Whitelist.Invalid', 'errorMessage' => 'Whitelist blocks not in CIDR format.', 'description' => ''], ['errorCode' => 'Whitelist.TooLong', 'errorMessage' => 'Whitelist too long, exceeds 10 CIDR blocks.', 'description' => ''], ], 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'Caller has no permission on the resource.', 'description' => ''], ['errorCode' => 'InstanceNotPaused', 'errorMessage' => 'Please pause the instance before reset.', 'description' => ''], ['errorCode' => 'InstanceNotActive', 'errorMessage' => 'Instance is not active.', 'description' => ''], ['errorCode' => 'ConfigIp.IncorrectState', 'errorMessage' => 'Instance not in pending or active state, can not config IP address.', 'description' => ''], ['errorCode' => 'SwitchMaster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'SyncCluster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'LeaveCluster.InstanceInvalid', 'errorMessage' => 'The instance is not in the cluster.', 'description' => ''], ['errorCode' => 'DeleteCluster.IncorrectState', 'errorMessage' => 'Cluster not empty, please remove all instances first.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceVSwitchNotInCluster', 'errorMessage' => 'Instance\'s vSwitch is not in cluster config, please change instance\'s vSwitch first.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceInitialized', 'errorMessage' => 'Initialized instance can not join a cluster.', 'description' => ''], ['errorCode' => 'JoinCluster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'InitializeCluster.InstanceNotInitialized', 'errorMessage' => 'Cluster master instance not initialized, please initialize cluster master instance first.', 'description' => ''], ['errorCode' => 'InitializeCluster.IncorrectConfig', 'errorMessage' => 'Cluster subnet not configured, please config cluster subnet first.', 'description' => ''], ['errorCode' => 'InitializeCluster.IncorrectState', 'errorMessage' => 'Cluster initialized, do not re-initialize.', 'description' => ''], ['errorCode' => 'Cluster.CN.ActionForbidden', 'errorMessage' => 'This API is forbidden for non-international site cluster.', 'description' => ''], ['errorCode' => 'Cluster.INTL.ActionForbidden', 'errorMessage' => 'This API is forbidden for international site cluster.', 'description' => ''], ['errorCode' => 'ConfigClusterCertificate.IncorrectState', 'errorMessage' => 'Cluster initialized or certificates already configured.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.InvalidVpcId', 'errorMessage' => 'VPC Id invalid. Cluster VPC is the same as cluster master\'s VPC.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.InvalidVSwitchId', 'errorMessage' => 'VSwitch Id invalid. VSwitches should contain all current cluster vSwitches.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.IncorrectState', 'errorMessage' => 'Cluster not in NEW state, can not config cluster subnet.', 'description' => ''], ['errorCode' => 'ClusterName.Exist', 'errorMessage' => 'Cluster name already exists, please use another name.', 'description' => ''], ['errorCode' => 'Whitelist.InstanceInCluster', 'errorMessage' => 'Whitelist.InstanceInCluster', 'description' => ''], ], [ ['errorCode' => 'Resource.NotFound', 'errorMessage' => 'Resource not found.', 'description' => ''], ], [ ['errorCode' => 'ClusterAPI.NotSupported', 'errorMessage' => 'ClusterAPI not supported in this region.', 'description' => ''], ], 409 => [ ['errorCode' => 'Conflict', 'errorMessage' => 'Resource is being updated by a previous request. Current request is redundant.', 'description' => ''], ['errorCode' => 'Cluster.Conflict', 'errorMessage' => 'The cluster is being updated by a previous request. Please try again later.', 'description' => ''], ], 500 => [ ['errorCode' => 'ConfigWhitelistFailed.Error', 'errorMessage' => 'config white list error', 'description' => ''], ['errorCode' => 'ActionFailed.Error', 'errorMessage' => 'internal error, please try again', 'description' => ''], ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => 'Unknown error caused request processing to fail.'], ], ], 'title' => 'ConfigClusterCertificate', 'summary' => 'Configures a certificate for a cluster of hardware security modules (HSMs) outside the Chinese mainland.', 'description' => 'For more information about how to create a self-signed certificate and a cluster certificate on an Elastic Compute Service (ECS) instance, see [Create a NIST FIPS-validated GVSM cluster](~~293585~~).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:ConfigClusterCertificate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C467B38-3910-447D-87BC-AC049166F216\\"\\n}","type":"json"}]', ], 'ConfigClusterName' => [ 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREhsmV7VE3Y', 'FEATUREhsm01FLNB', 'FEATUREhsmGIFYCG', 'FEATUREhsmLBBV5W'], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'formData', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'cluster-BqxX63Bsgfaisdf****', 'title' => ''], ], [ 'name' => 'ClusterName', 'in' => 'formData', 'schema' => ['description' => 'The cluster name.', 'type' => 'string', 'required' => true, 'example' => 'cluster_on****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'BaseResult', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID. Alibaba Cloud generates a unique ID for each request. You can use the ID to troubleshoot issues.', 'type' => 'string', 'example' => '4C467B38-3910-447D-87BC-AC049166F216', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'SwitchMaster.InstanceInvalid', 'errorMessage' => 'Instance not in the cluster.', 'description' => ''], ['errorCode' => 'LeaveCluster.MasterLast', 'errorMessage' => 'Master instance can not leave a cluster until all other instances are left.', 'description' => ''], ['errorCode' => 'Certificate.ChainInvalid', 'errorMessage' => 'Certificate chain invalid. Please make sure issuer certificate is the trust anchor and cluster certificate is signed by issuer certificate.', 'description' => ''], ['errorCode' => 'Certificate.FormatInvalid', 'errorMessage' => 'Certificate format invalid. Cluster/Issuer certificate must be in PEM format.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.DuplicateZone', 'errorMessage' => 'VSwitches should not contain duplicate zones.', 'description' => ''], ['errorCode' => 'InvalidApiParam.Error', 'errorMessage' => 'api param is invalid', 'description' => ''], ['errorCode' => 'InvalidClusterName', 'errorMessage' => 'Invalid parameter clusterName.', 'description' => ''], ['errorCode' => 'InvalidPageSize', 'errorMessage' => 'Invalid parameter pageSize.', 'description' => ''], ['errorCode' => 'InvalidCurrentPage', 'errorMessage' => 'Invalid parameter currentPage.', 'description' => ''], ['errorCode' => 'InvalidRegionId', 'errorMessage' => 'Invalid parameter regionId.', 'description' => ''], ['errorCode' => 'InvalidVSwitch', 'errorMessage' => 'Invalid parameter vSwitch.', 'description' => ''], ['errorCode' => 'InvalidVpc', 'errorMessage' => 'Invalid parameter vpcId.', 'description' => ''], ['errorCode' => 'InvalidIp', 'errorMessage' => 'Invalid parameter IP.', 'description' => ''], ['errorCode' => 'InvalidAliuid', 'errorMessage' => 'Invalid parameter aliuid.', 'description' => ''], ['errorCode' => 'InvalidClusterId', 'errorMessage' => 'Invalid parameter clusterId.', 'description' => ''], ['errorCode' => 'InvalidInstanceId', 'errorMessage' => 'Invalid parameter instanceId.', 'description' => ''], ['errorCode' => 'InvalidBackupId', 'errorMessage' => 'Invalid parameter backupId.', 'description' => ''], ['errorCode' => 'InvalidImageId', 'errorMessage' => 'Invalid parameter imageId.', 'description' => ''], ['errorCode' => 'HsmInstanceNotExist.Error', 'errorMessage' => 'hsm instance not exist', 'description' => ''], ['errorCode' => 'HSMIntanceNotActived.Error', 'errorMessage' => 'hsm intance is not actived', 'description' => ''], ['errorCode' => 'WhiteListMaxCount.Error', 'errorMessage' => 'whilte list is more than max count', 'description' => ''], ['errorCode' => 'ClusterIdIsNotExists.Error', 'errorMessage' => 'cluster ID non-exists', 'description' => ''], ['errorCode' => 'InstanceListIsEmpty.Error', 'errorMessage' => 'instance list is empty', 'description' => ''], ['errorCode' => 'InstanceIdIsEmpty.Error', 'errorMessage' => 'instance id is empty', 'description' => ''], ['errorCode' => 'InstanceIsNotExistsInCluster.Error', 'errorMessage' => 'cluster has no such instance', 'description' => ''], ['errorCode' => 'InstanceIsExistsInCluster.Error', 'errorMessage' => 'instance already in the cluster', 'description' => ''], ['errorCode' => 'RegionNoEmpty.Error', 'errorMessage' => 'region no. is empty', 'description' => ''], ['errorCode' => 'ClusterNameEmpty.Error', 'errorMessage' => 'empty cluster name not allowed', 'description' => ''], ['errorCode' => 'ClusterNameIsExists.Error', 'errorMessage' => 'the cluster name is already taken', 'description' => ''], ['errorCode' => 'IpNotValid.Error', 'errorMessage' => 'ip not valid', 'description' => ''], ['errorCode' => 'ClusterIsEmpty.Error', 'errorMessage' => 'cluster is empty', 'description' => ''], ['errorCode' => 'NoMasterFoundInCluster.Error', 'errorMessage' => 'cluster has no master instance', 'description' => ''], ['errorCode' => 'HsmInstanceIdNotFound.Error', 'errorMessage' => 'no such instance', 'description' => ''], ['errorCode' => 'NoInstanceFoundInCluster.Error', 'errorMessage' => 'cluster is empty', 'description' => ''], ['errorCode' => 'Whitelist.Invalid', 'errorMessage' => 'Whitelist blocks not in CIDR format.', 'description' => ''], ['errorCode' => 'Whitelist.TooLong', 'errorMessage' => 'Whitelist too long, exceeds 10 CIDR blocks.', 'description' => ''], ], 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'Caller has no permission on the resource.', 'description' => ''], ['errorCode' => 'InstanceNotPaused', 'errorMessage' => 'Please pause the instance before reset.', 'description' => ''], ['errorCode' => 'InstanceNotActive', 'errorMessage' => 'Instance is not active.', 'description' => ''], ['errorCode' => 'ConfigIp.IncorrectState', 'errorMessage' => 'Instance not in pending or active state, can not config IP address.', 'description' => ''], ['errorCode' => 'SwitchMaster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'SyncCluster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'LeaveCluster.InstanceInvalid', 'errorMessage' => 'The instance is not in the cluster.', 'description' => ''], ['errorCode' => 'DeleteCluster.IncorrectState', 'errorMessage' => 'Cluster not empty, please remove all instances first.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceVSwitchNotInCluster', 'errorMessage' => 'Instance\'s vSwitch is not in cluster config, please change instance\'s vSwitch first.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceInitialized', 'errorMessage' => 'Initialized instance can not join a cluster.', 'description' => ''], ['errorCode' => 'JoinCluster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'InitializeCluster.InstanceNotInitialized', 'errorMessage' => 'Cluster master instance not initialized, please initialize cluster master instance first.', 'description' => ''], ['errorCode' => 'InitializeCluster.IncorrectConfig', 'errorMessage' => 'Cluster subnet not configured, please config cluster subnet first.', 'description' => ''], ['errorCode' => 'InitializeCluster.IncorrectState', 'errorMessage' => 'Cluster initialized, do not re-initialize.', 'description' => ''], ['errorCode' => 'Cluster.CN.ActionForbidden', 'errorMessage' => 'This API is forbidden for non-international site cluster.', 'description' => ''], ['errorCode' => 'Cluster.INTL.ActionForbidden', 'errorMessage' => 'This API is forbidden for international site cluster.', 'description' => ''], ['errorCode' => 'ConfigClusterCertificate.IncorrectState', 'errorMessage' => 'Cluster initialized or certificates already configured.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.InvalidVpcId', 'errorMessage' => 'VPC Id invalid. Cluster VPC is the same as cluster master\'s VPC.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.InvalidVSwitchId', 'errorMessage' => 'VSwitch Id invalid. VSwitches should contain all current cluster vSwitches.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.IncorrectState', 'errorMessage' => 'Cluster not in NEW state, can not config cluster subnet.', 'description' => ''], ['errorCode' => 'ClusterName.Exist', 'errorMessage' => 'Cluster name already exists, please use another name.', 'description' => ''], ['errorCode' => 'Whitelist.InstanceInCluster', 'errorMessage' => 'Whitelist.InstanceInCluster', 'description' => ''], ], [ ['errorCode' => 'Resource.NotFound', 'errorMessage' => 'Resource not found.', 'description' => ''], ], [ ['errorCode' => 'ClusterAPI.NotSupported', 'errorMessage' => 'ClusterAPI not supported in this region.', 'description' => ''], ], 409 => [ ['errorCode' => 'Conflict', 'errorMessage' => 'Resource is being updated by a previous request. Current request is redundant.', 'description' => ''], ['errorCode' => 'Cluster.Conflict', 'errorMessage' => 'The cluster is being updated by a previous request. Please try again later.', 'description' => ''], ], 500 => [ ['errorCode' => 'ConfigWhitelistFailed.Error', 'errorMessage' => 'config white list error', 'description' => ''], ['errorCode' => 'ActionFailed.Error', 'errorMessage' => 'internal error, please try again', 'description' => ''], ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => 'Unknown error caused request processing to fail.'], ], ], 'title' => 'Configure cluster name', 'summary' => 'Modifies the name of a cluster.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:ConfigClusterName', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C467B38-3910-447D-87BC-AC049166F216\\"\\n}","type":"json"}]', ], 'ConfigClusterSubnet' => [ 'summary' => 'Modifies a list of vSwitches that are associated with a hardware security module (HSM) cluster.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '211854', 'abilityTreeNodes' => ['FEATUREhsmV7VE3Y', 'FEATUREhsm01FLNB', 'FEATUREhsmGIFYCG', 'FEATUREhsmLBBV5W'], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the cluster. You can call the ListCluster operation to obtain cluster IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cluster-BqxX63Bsg****', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'VpcId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the virtual private cloud (VPC).'."\n", 'type' => 'string', 'required' => true, 'example' => 'vpc-7xvkh90cw39p0****', 'title' => ''], ], [ 'name' => 'VSwitchIds', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'A list of vSwitches that are associated with the cluster. Note: You must include all vSwitches that you want to associate with the cluster.'."\n", 'type' => 'array', 'items' => ['description' => 'The ID of the vSwitch.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vsw-2zeqkh8ar8yey5ejv****', 'title' => ''], 'required' => true, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'BaseResult'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '4C467B38-3910-447D-87BC-AC049366F216', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'SwitchMaster.InstanceInvalid', 'errorMessage' => 'Instance not in the cluster.', 'description' => ''], ['errorCode' => 'LeaveCluster.MasterLast', 'errorMessage' => 'Master instance can not leave a cluster until all other instances are left.', 'description' => ''], ['errorCode' => 'Certificate.ChainInvalid', 'errorMessage' => 'Certificate chain invalid. Please make sure issuer certificate is the trust anchor and cluster certificate is signed by issuer certificate.', 'description' => ''], ['errorCode' => 'Certificate.FormatInvalid', 'errorMessage' => 'Certificate format invalid. Cluster/Issuer certificate must be in PEM format.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.DuplicateZone', 'errorMessage' => 'VSwitches should not contain duplicate zones.', 'description' => ''], ['errorCode' => 'InvalidApiParam.Error', 'errorMessage' => 'api param is invalid', 'description' => ''], ['errorCode' => 'InvalidClusterName', 'errorMessage' => 'Invalid parameter clusterName.', 'description' => ''], ['errorCode' => 'InvalidPageSize', 'errorMessage' => 'Invalid parameter pageSize.', 'description' => ''], ['errorCode' => 'InvalidCurrentPage', 'errorMessage' => 'Invalid parameter currentPage.', 'description' => ''], ['errorCode' => 'InvalidRegionId', 'errorMessage' => 'Invalid parameter regionId.', 'description' => ''], ['errorCode' => 'InvalidVSwitch', 'errorMessage' => 'Invalid parameter vSwitch.', 'description' => ''], ['errorCode' => 'InvalidVpc', 'errorMessage' => 'Invalid parameter vpcId.', 'description' => ''], ['errorCode' => 'InvalidIp', 'errorMessage' => 'Invalid parameter IP.', 'description' => ''], ['errorCode' => 'InvalidAliuid', 'errorMessage' => 'Invalid parameter aliuid.', 'description' => ''], ['errorCode' => 'InvalidClusterId', 'errorMessage' => 'Invalid parameter clusterId.', 'description' => ''], ['errorCode' => 'InvalidInstanceId', 'errorMessage' => 'Invalid parameter instanceId.', 'description' => ''], ['errorCode' => 'InvalidBackupId', 'errorMessage' => 'Invalid parameter backupId.', 'description' => ''], ['errorCode' => 'InvalidImageId', 'errorMessage' => 'Invalid parameter imageId.', 'description' => ''], ['errorCode' => 'HsmInstanceNotExist.Error', 'errorMessage' => 'hsm instance not exist', 'description' => ''], ['errorCode' => 'HSMIntanceNotActived.Error', 'errorMessage' => 'hsm intance is not actived', 'description' => ''], ['errorCode' => 'WhiteListMaxCount.Error', 'errorMessage' => 'whilte list is more than max count', 'description' => ''], ['errorCode' => 'ClusterIdIsNotExists.Error', 'errorMessage' => 'cluster ID non-exists', 'description' => ''], ['errorCode' => 'InstanceListIsEmpty.Error', 'errorMessage' => 'instance list is empty', 'description' => ''], ['errorCode' => 'InstanceIdIsEmpty.Error', 'errorMessage' => 'instance id is empty', 'description' => ''], ['errorCode' => 'InstanceIsNotExistsInCluster.Error', 'errorMessage' => 'cluster has no such instance', 'description' => ''], ['errorCode' => 'InstanceIsExistsInCluster.Error', 'errorMessage' => 'instance already in the cluster', 'description' => ''], ['errorCode' => 'RegionNoEmpty.Error', 'errorMessage' => 'region no. is empty', 'description' => ''], ['errorCode' => 'ClusterNameEmpty.Error', 'errorMessage' => 'empty cluster name not allowed', 'description' => ''], ['errorCode' => 'ClusterNameIsExists.Error', 'errorMessage' => 'the cluster name is already taken', 'description' => ''], ['errorCode' => 'IpNotValid.Error', 'errorMessage' => 'ip not valid', 'description' => ''], ['errorCode' => 'ClusterIsEmpty.Error', 'errorMessage' => 'cluster is empty', 'description' => ''], ['errorCode' => 'NoMasterFoundInCluster.Error', 'errorMessage' => 'cluster has no master instance', 'description' => ''], ['errorCode' => 'HsmInstanceIdNotFound.Error', 'errorMessage' => 'no such instance', 'description' => ''], ['errorCode' => 'NoInstanceFoundInCluster.Error', 'errorMessage' => 'cluster is empty', 'description' => ''], ['errorCode' => 'Whitelist.Invalid', 'errorMessage' => 'Whitelist blocks not in CIDR format.', 'description' => ''], ['errorCode' => 'Whitelist.TooLong', 'errorMessage' => 'Whitelist too long, exceeds 10 CIDR blocks.', 'description' => ''], ], 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'Caller has no permission on the resource.', 'description' => ''], ['errorCode' => 'InstanceNotPaused', 'errorMessage' => 'Please pause the instance before reset.', 'description' => ''], ['errorCode' => 'InstanceNotActive', 'errorMessage' => 'Instance is not active.', 'description' => ''], ['errorCode' => 'ConfigIp.IncorrectState', 'errorMessage' => 'Instance not in pending or active state, can not config IP address.', 'description' => ''], ['errorCode' => 'SwitchMaster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'SyncCluster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'LeaveCluster.InstanceInvalid', 'errorMessage' => 'The instance is not in the cluster.', 'description' => ''], ['errorCode' => 'DeleteCluster.IncorrectState', 'errorMessage' => 'Cluster not empty, please remove all instances first.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceVSwitchNotInCluster', 'errorMessage' => 'Instance\'s vSwitch is not in cluster config, please change instance\'s vSwitch first.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceInitialized', 'errorMessage' => 'Initialized instance can not join a cluster.', 'description' => ''], ['errorCode' => 'JoinCluster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'InitializeCluster.InstanceNotInitialized', 'errorMessage' => 'Cluster master instance not initialized, please initialize cluster master instance first.', 'description' => ''], ['errorCode' => 'InitializeCluster.IncorrectConfig', 'errorMessage' => 'Cluster subnet not configured, please config cluster subnet first.', 'description' => ''], ['errorCode' => 'InitializeCluster.IncorrectState', 'errorMessage' => 'Cluster initialized, do not re-initialize.', 'description' => ''], ['errorCode' => 'Cluster.CN.ActionForbidden', 'errorMessage' => 'This API is forbidden for non-international site cluster.', 'description' => ''], ['errorCode' => 'Cluster.INTL.ActionForbidden', 'errorMessage' => 'This API is forbidden for international site cluster.', 'description' => ''], ['errorCode' => 'ConfigClusterCertificate.IncorrectState', 'errorMessage' => 'Cluster initialized or certificates already configured.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.InvalidVpcId', 'errorMessage' => 'VPC Id invalid. Cluster VPC is the same as cluster master\'s VPC.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.InvalidVSwitchId', 'errorMessage' => 'VSwitch Id invalid. VSwitches should contain all current cluster vSwitches.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.IncorrectState', 'errorMessage' => 'Cluster not in NEW state, can not config cluster subnet.', 'description' => ''], ['errorCode' => 'ClusterName.Exist', 'errorMessage' => 'Cluster name already exists, please use another name.', 'description' => ''], ['errorCode' => 'Whitelist.InstanceInCluster', 'errorMessage' => 'Whitelist.InstanceInCluster', 'description' => ''], ], [ ['errorCode' => 'Resource.NotFound', 'errorMessage' => 'Resource not found.', 'description' => ''], ], [ ['errorCode' => 'ClusterAPI.NotSupported', 'errorMessage' => 'ClusterAPI not supported in this region.', 'description' => ''], ], 409 => [ ['errorCode' => 'Conflict', 'errorMessage' => 'Resource is being updated by a previous request. Current request is redundant.', 'description' => ''], ['errorCode' => 'Cluster.Conflict', 'errorMessage' => 'The cluster is being updated by a previous request. Please try again later.', 'description' => ''], ], 500 => [ ['errorCode' => 'ConfigWhitelistFailed.Error', 'errorMessage' => 'config white list error', 'description' => ''], ['errorCode' => 'ActionFailed.Error', 'errorMessage' => 'internal error, please try again', 'description' => ''], ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => 'Unknown error caused request processing to fail.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ConfigClusterSubnet', 'description' => 'You can call the operation to configure all vSwitches that are associated with a HSM cluster. You can only add new vSwitches. You cannot delete vSwitches.'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:ConfigClusterSubnet', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C467B38-3910-447D-87BC-AC049366F216\\"\\n}","type":"json"}]', ], 'ConfigClusterWhitelist' => [ 'summary' => 'Modifies the IP address whitelist of a cluster.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREhsm01FLNB', 'FEATUREhsmV7VE3Y', 'FEATUREhsmGIFYCG', 'FEATUREhsmLBBV5W'], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the cluster.', 'type' => 'string', 'required' => true, 'example' => 'cluster-729dm40FG****', 'title' => ''], ], [ 'name' => 'Whitelist', 'in' => 'formData', 'schema' => ['description' => 'The IP address whitelist of the cluster.', 'type' => 'string', 'required' => true, 'example' => '18.68.XX.XX', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'BaseResult', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4C467B38-3910-447D-87BC-AC049166F216', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'SwitchMaster.InstanceInvalid', 'errorMessage' => 'Instance not in the cluster.', 'description' => ''], ['errorCode' => 'LeaveCluster.MasterLast', 'errorMessage' => 'Master instance can not leave a cluster until all other instances are left.', 'description' => ''], ['errorCode' => 'Certificate.ChainInvalid', 'errorMessage' => 'Certificate chain invalid. Please make sure issuer certificate is the trust anchor and cluster certificate is signed by issuer certificate.', 'description' => ''], ['errorCode' => 'Certificate.FormatInvalid', 'errorMessage' => 'Certificate format invalid. Cluster/Issuer certificate must be in PEM format.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.DuplicateZone', 'errorMessage' => 'VSwitches should not contain duplicate zones.', 'description' => ''], ['errorCode' => 'InvalidApiParam.Error', 'errorMessage' => 'api param is invalid', 'description' => ''], ['errorCode' => 'InvalidClusterName', 'errorMessage' => 'Invalid parameter clusterName.', 'description' => ''], ['errorCode' => 'InvalidPageSize', 'errorMessage' => 'Invalid parameter pageSize.', 'description' => ''], ['errorCode' => 'InvalidCurrentPage', 'errorMessage' => 'Invalid parameter currentPage.', 'description' => ''], ['errorCode' => 'InvalidRegionId', 'errorMessage' => 'Invalid parameter regionId.', 'description' => ''], ['errorCode' => 'InvalidVSwitch', 'errorMessage' => 'Invalid parameter vSwitch.', 'description' => ''], ['errorCode' => 'InvalidVpc', 'errorMessage' => 'Invalid parameter vpcId.', 'description' => ''], ['errorCode' => 'InvalidIp', 'errorMessage' => 'Invalid parameter IP.', 'description' => ''], ['errorCode' => 'InvalidAliuid', 'errorMessage' => 'Invalid parameter aliuid.', 'description' => ''], ['errorCode' => 'InvalidClusterId', 'errorMessage' => 'Invalid parameter clusterId.', 'description' => ''], ['errorCode' => 'InvalidInstanceId', 'errorMessage' => 'Invalid parameter instanceId.', 'description' => ''], ['errorCode' => 'InvalidBackupId', 'errorMessage' => 'Invalid parameter backupId.', 'description' => ''], ['errorCode' => 'InvalidImageId', 'errorMessage' => 'Invalid parameter imageId.', 'description' => ''], ['errorCode' => 'HsmInstanceNotExist.Error', 'errorMessage' => 'hsm instance not exist', 'description' => ''], ['errorCode' => 'HSMIntanceNotActived.Error', 'errorMessage' => 'hsm intance is not actived', 'description' => ''], ['errorCode' => 'WhiteListMaxCount.Error', 'errorMessage' => 'whilte list is more than max count', 'description' => ''], ['errorCode' => 'ClusterIdIsNotExists.Error', 'errorMessage' => 'cluster ID non-exists', 'description' => ''], ['errorCode' => 'InstanceListIsEmpty.Error', 'errorMessage' => 'instance list is empty', 'description' => ''], ['errorCode' => 'InstanceIdIsEmpty.Error', 'errorMessage' => 'instance id is empty', 'description' => ''], ['errorCode' => 'InstanceIsNotExistsInCluster.Error', 'errorMessage' => 'cluster has no such instance', 'description' => ''], ['errorCode' => 'InstanceIsExistsInCluster.Error', 'errorMessage' => 'instance already in the cluster', 'description' => ''], ['errorCode' => 'RegionNoEmpty.Error', 'errorMessage' => 'region no. is empty', 'description' => ''], ['errorCode' => 'ClusterNameEmpty.Error', 'errorMessage' => 'empty cluster name not allowed', 'description' => ''], ['errorCode' => 'ClusterNameIsExists.Error', 'errorMessage' => 'the cluster name is already taken', 'description' => ''], ['errorCode' => 'IpNotValid.Error', 'errorMessage' => 'ip not valid', 'description' => ''], ['errorCode' => 'ClusterIsEmpty.Error', 'errorMessage' => 'cluster is empty', 'description' => ''], ['errorCode' => 'NoMasterFoundInCluster.Error', 'errorMessage' => 'cluster has no master instance', 'description' => ''], ['errorCode' => 'HsmInstanceIdNotFound.Error', 'errorMessage' => 'no such instance', 'description' => ''], ['errorCode' => 'NoInstanceFoundInCluster.Error', 'errorMessage' => 'cluster is empty', 'description' => ''], ['errorCode' => 'Whitelist.Invalid', 'errorMessage' => 'Whitelist blocks not in CIDR format.', 'description' => ''], ['errorCode' => 'Whitelist.TooLong', 'errorMessage' => 'Whitelist too long, exceeds 10 CIDR blocks.', 'description' => ''], ], 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'Caller has no permission on the resource.', 'description' => ''], ['errorCode' => 'InstanceNotPaused', 'errorMessage' => 'Please pause the instance before reset.', 'description' => ''], ['errorCode' => 'InstanceNotActive', 'errorMessage' => 'Instance is not active.', 'description' => ''], ['errorCode' => 'ConfigIp.IncorrectState', 'errorMessage' => 'Instance not in pending or active state, can not config IP address.', 'description' => ''], ['errorCode' => 'SwitchMaster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'SyncCluster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'LeaveCluster.InstanceInvalid', 'errorMessage' => 'The instance is not in the cluster.', 'description' => ''], ['errorCode' => 'DeleteCluster.IncorrectState', 'errorMessage' => 'Cluster not empty, please remove all instances first.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceVSwitchNotInCluster', 'errorMessage' => 'Instance\'s vSwitch is not in cluster config, please change instance\'s vSwitch first.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceInitialized', 'errorMessage' => 'Initialized instance can not join a cluster.', 'description' => ''], ['errorCode' => 'JoinCluster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'InitializeCluster.InstanceNotInitialized', 'errorMessage' => 'Cluster master instance not initialized, please initialize cluster master instance first.', 'description' => ''], ['errorCode' => 'InitializeCluster.IncorrectConfig', 'errorMessage' => 'Cluster subnet not configured, please config cluster subnet first.', 'description' => ''], ['errorCode' => 'InitializeCluster.IncorrectState', 'errorMessage' => 'Cluster initialized, do not re-initialize.', 'description' => ''], ['errorCode' => 'Cluster.CN.ActionForbidden', 'errorMessage' => 'This API is forbidden for non-international site cluster.', 'description' => ''], ['errorCode' => 'Cluster.INTL.ActionForbidden', 'errorMessage' => 'This API is forbidden for international site cluster.', 'description' => ''], ['errorCode' => 'ConfigClusterCertificate.IncorrectState', 'errorMessage' => 'Cluster initialized or certificates already configured.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.InvalidVpcId', 'errorMessage' => 'VPC Id invalid. Cluster VPC is the same as cluster master\'s VPC.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.InvalidVSwitchId', 'errorMessage' => 'VSwitch Id invalid. VSwitches should contain all current cluster vSwitches.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.IncorrectState', 'errorMessage' => 'Cluster not in NEW state, can not config cluster subnet.', 'description' => ''], ['errorCode' => 'ClusterName.Exist', 'errorMessage' => 'Cluster name already exists, please use another name.', 'description' => ''], ['errorCode' => 'Whitelist.InstanceInCluster', 'errorMessage' => 'Whitelist.InstanceInCluster', 'description' => ''], ], [ ['errorCode' => 'Resource.NotFound', 'errorMessage' => 'Resource not found.', 'description' => ''], ], [ ['errorCode' => 'ClusterAPI.NotSupported', 'errorMessage' => 'ClusterAPI not supported in this region.', 'description' => ''], ], 409 => [ ['errorCode' => 'Conflict', 'errorMessage' => 'Resource is being updated by a previous request. Current request is redundant.', 'description' => ''], ['errorCode' => 'Cluster.Conflict', 'errorMessage' => 'The cluster is being updated by a previous request. Please try again later.', 'description' => ''], ], 500 => [ ['errorCode' => 'ConfigWhitelistFailed.Error', 'errorMessage' => 'config white list error', 'description' => ''], ['errorCode' => 'ActionFailed.Error', 'errorMessage' => 'internal error, please try again', 'description' => ''], ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => 'Unknown error caused request processing to fail.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ConfigClusterWhitelist', 'description' => 'The IP address whitelist of a cluster has a higher priority than the IP address whitelist of a hardware security module (HSM) in the cluster. In cluster mode, we recommend that you create an IP address whitelist for your cluster. You do not need to create an IP address for the HSM in the cluster.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:ConfigClusterWhitelist', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C467B38-3910-447D-87BC-AC049166F216\\"\\n}","type":"json"}]', ], 'ConfigImageRemark' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREhsmV7VE3Y', 'FEATUREhsm01FLNB', 'FEATUREhsmGIFYCG', 'FEATUREhsmLBBV5W'], ], 'parameters' => [ [ 'name' => 'ImageId', 'in' => 'query', 'schema' => ['description' => 'The image ID.', 'type' => 'string', 'required' => true, 'example' => 'image-d79x4k11pmg19****', 'title' => ''], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => ['description' => 'The remarks of the image.', 'type' => 'string', 'required' => true, 'example' => 'hsm-****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID. This ID is generated by Alibaba Cloud and is unique for each request. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '4C467B38-3910-447D-87BC-AC049166F216'], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidApiParam.Error', 'errorMessage' => 'api param is invalid', 'description' => ''], ], 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'caller has no permission', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => 'Unknown error caused request processing to fail.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ConfigImageRemark', 'summary' => 'Modifies the remarks for an image.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'yundun-hsm:ConfigImageRemark', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C467B38-3910-447D-87BC-AC049166F216\\"\\n}","type":"json"}]', ], 'ConfigInstanceIpAddress' => [ 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '211785', 'abilityTreeNodes' => ['FEATUREhsmV7VE3Y', 'FEATUREhsm01FLNB', 'FEATUREhsmGIFYCG', 'FEATUREhsmLBBV5W'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the HSM.'."\n", 'type' => 'string', 'required' => true, 'example' => 'hsm-cn-mp90fxef****', 'title' => ''], ], [ 'name' => 'VpcId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the VPC to which the HMS belongs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'vpc-lmkmivmo6****', 'title' => ''], ], [ 'name' => 'VSwitchId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the vSwitch to which the HMS belongs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'vsw-u7gb0qahu****', 'title' => ''], ], [ 'name' => 'Ip', 'in' => 'formData', 'schema' => ['description' => 'The endpoint of the VPC to which the HMS belongs.'."\n", 'type' => 'string', 'required' => true, 'example' => '192.168.XX.XX', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'BaseResult'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '4C467B38-3910-447D-87BC-AC049166F216', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'SwitchMaster.InstanceInvalid', 'errorMessage' => 'Instance not in the cluster.', 'description' => ''], ['errorCode' => 'LeaveCluster.MasterLast', 'errorMessage' => 'Master instance can not leave a cluster until all other instances are left.', 'description' => ''], ['errorCode' => 'Certificate.ChainInvalid', 'errorMessage' => 'Certificate chain invalid. Please make sure issuer certificate is the trust anchor and cluster certificate is signed by issuer certificate.', 'description' => ''], ['errorCode' => 'Certificate.FormatInvalid', 'errorMessage' => 'Certificate format invalid. Cluster/Issuer certificate must be in PEM format.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.DuplicateZone', 'errorMessage' => 'VSwitches should not contain duplicate zones.', 'description' => ''], ['errorCode' => 'InvalidApiParam.Error', 'errorMessage' => 'api param is invalid', 'description' => ''], ['errorCode' => 'InvalidClusterName', 'errorMessage' => 'Invalid parameter clusterName.', 'description' => ''], ['errorCode' => 'InvalidPageSize', 'errorMessage' => 'Invalid parameter pageSize.', 'description' => ''], ['errorCode' => 'InvalidCurrentPage', 'errorMessage' => 'Invalid parameter currentPage.', 'description' => ''], ['errorCode' => 'InvalidRegionId', 'errorMessage' => 'Invalid parameter regionId.', 'description' => ''], ['errorCode' => 'InvalidZoneId', 'errorMessage' => 'Invalid parameter zoneId.', 'description' => ''], ['errorCode' => 'InvalidVSwitch', 'errorMessage' => 'Invalid parameter vSwitch.', 'description' => ''], ['errorCode' => 'InvalidVpc', 'errorMessage' => 'Invalid parameter vpcId.', 'description' => ''], ['errorCode' => 'InvalidVsmType', 'errorMessage' => 'Invalid parameter vsmType.', 'description' => ''], ['errorCode' => 'InvalidIp', 'errorMessage' => 'Invalid parameter IP.', 'description' => ''], ['errorCode' => 'InvalidAliuid', 'errorMessage' => 'Invalid parameter aliuid.', 'description' => ''], ['errorCode' => 'InvalidClusterId', 'errorMessage' => 'Invalid parameter clusterId.', 'description' => ''], ['errorCode' => 'InvalidInstanceId', 'errorMessage' => 'Invalid parameter instanceId.', 'description' => ''], ['errorCode' => 'InvalidBackupId', 'errorMessage' => 'Invalid parameter backupId.', 'description' => ''], ['errorCode' => 'InvalidImageId', 'errorMessage' => 'Invalid parameter imageId.', 'description' => ''], ['errorCode' => 'HsmInstanceNotExist.Error', 'errorMessage' => 'hsm instance not exist', 'description' => ''], ['errorCode' => 'HSMIntanceNotActived.Error', 'errorMessage' => 'hsm intance is not actived', 'description' => ''], ['errorCode' => 'WhiteListMaxCount.Error', 'errorMessage' => 'whilte list is more than max count', 'description' => ''], ['errorCode' => 'ClusterIdIsNotExists.Error', 'errorMessage' => 'cluster ID non-exists', 'description' => ''], ['errorCode' => 'InstanceListIsEmpty.Error', 'errorMessage' => 'instance list is empty', 'description' => ''], ['errorCode' => 'InstanceIdIsEmpty.Error', 'errorMessage' => 'instance id is empty', 'description' => ''], ['errorCode' => 'InstanceIsNotExistsInCluster.Error', 'errorMessage' => 'cluster has no such instance', 'description' => ''], ['errorCode' => 'InstanceIsExistsInCluster.Error', 'errorMessage' => 'instance already in the cluster', 'description' => ''], ['errorCode' => 'RegionNoEmpty.Error', 'errorMessage' => 'region no. is empty', 'description' => ''], ['errorCode' => 'ClusterNameEmpty.Error', 'errorMessage' => 'empty cluster name not allowed', 'description' => ''], ['errorCode' => 'ClusterNameIsExists.Error', 'errorMessage' => 'the cluster name is already taken', 'description' => ''], ['errorCode' => 'IpNotValid.Error', 'errorMessage' => 'ip not valid', 'description' => ''], ['errorCode' => 'ClusterIsEmpty.Error', 'errorMessage' => 'cluster is empty', 'description' => ''], ['errorCode' => 'NoMasterFoundInCluster.Error', 'errorMessage' => 'cluster has no master instance', 'description' => ''], ['errorCode' => 'HsmInstanceIdNotFound.Error', 'errorMessage' => 'no such instance', 'description' => ''], ['errorCode' => 'NoInstanceFoundInCluster.Error', 'errorMessage' => 'cluster is empty', 'description' => ''], ['errorCode' => 'Whitelist.Invalid', 'errorMessage' => 'Whitelist blocks not in CIDR format.', 'description' => ''], ['errorCode' => 'Whitelist.TooLong', 'errorMessage' => 'Whitelist too long, exceeds 10 CIDR blocks.', 'description' => ''], ['errorCode' => 'ConfigIp.IpAlreadyInUse', 'errorMessage' => 'Ip is in use, can not config IP address.', 'description' => ''], ['errorCode' => 'ConfigIp.VpcIpNotMatched', 'errorMessage' => 'Vpc Ip must be in vpc network segment.', 'description' => ''], ['errorCode' => 'ConfigIp.IpOverFlow', 'errorMessage' => 'Vpc ip last place can not be in [253-255].', 'description' => ''], ], 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'User has no permission to access this resource.', 'description' => ''], ['errorCode' => 'Trial.Forbidden', 'errorMessage' => 'Current user is not allowed for trials!', 'description' => ''], ['errorCode' => 'Forbidden.InstanceInCluster', 'errorMessage' => 'This API is forbidden for instances in cluster.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceIncorrectState', 'errorMessage' => 'Instance not in Active/Pending state.', 'description' => ''], ['errorCode' => 'InstanceNotPaused', 'errorMessage' => 'Please pause the instance before reset.', 'description' => ''], ['errorCode' => 'InstanceNotActive', 'errorMessage' => 'Instance is not active.', 'description' => ''], ['errorCode' => 'ConfigIp.IncorrectState', 'errorMessage' => 'Instance not in pending or active state, can not config IP address.', 'description' => ''], ['errorCode' => 'SwitchMaster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'SyncCluster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'LeaveCluster.InstanceInvalid', 'errorMessage' => 'The instance is not in the cluster.', 'description' => ''], ['errorCode' => 'DeleteCluster.IncorrectState', 'errorMessage' => 'Cluster not empty, please remove all instances first.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceVSwitchNotInCluster', 'errorMessage' => 'Instance\'s vSwitch is not in cluster config, please change instance\'s vSwitch first.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceInitialized', 'errorMessage' => 'Initialized instance can not join a cluster.', 'description' => ''], ['errorCode' => 'JoinCluster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'InitializeCluster.InstanceNotInitialized', 'errorMessage' => 'Cluster master instance not initialized, please initialize cluster master instance first.', 'description' => ''], ['errorCode' => 'InitializeCluster.IncorrectConfig', 'errorMessage' => 'Cluster subnet not configured, please config cluster subnet first.', 'description' => ''], ['errorCode' => 'InitializeCluster.IncorrectState', 'errorMessage' => 'Cluster initialized, do not re-initialize.', 'description' => ''], ['errorCode' => 'Cluster.CN.ActionForbidden', 'errorMessage' => 'This API is forbidden for non-international site cluster.', 'description' => ''], ['errorCode' => 'Cluster.INTL.ActionForbidden', 'errorMessage' => 'This API is forbidden for international site cluster.', 'description' => ''], ['errorCode' => 'ConfigClusterCertificate.IncorrectState', 'errorMessage' => 'Cluster initialized or certificates already configured.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.InvalidVpcId', 'errorMessage' => 'VPC Id invalid. Cluster VPC is the same as cluster master\'s VPC.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.InvalidVSwitchId', 'errorMessage' => 'VSwitch Id invalid. VSwitches should contain all current cluster vSwitches.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.IncorrectState', 'errorMessage' => 'Cluster not in NEW state, can not config cluster subnet.', 'description' => ''], ['errorCode' => 'ClusterName.Exist', 'errorMessage' => 'Cluster name already exists, please use another name.', 'description' => ''], ['errorCode' => 'Image.ImageStatusInValid', 'errorMessage' => 'Image status is invalid.', 'description' => ''], ['errorCode' => 'CopyImage.ImageAlreadyCopied', 'errorMessage' => 'Image already copied, secondary copy is not supported.', 'description' => ''], ['errorCode' => 'Image.ActionForbiddenINTL', 'errorMessage' => 'This API is forbidden for international site.', 'description' => ''], ['errorCode' => 'Image.ActionForbiddenCN', 'errorMessage' => 'This API is forbidden for non-international site.', 'description' => ''], ['errorCode' => 'CopyImage.RegionInvalid', 'errorMessage' => 'Source region or target region invalid.', 'description' => ''], ['errorCode' => 'Backup.ActionForbiddenINTL', 'errorMessage' => 'This API is forbidden for international site.', 'description' => ''], ['errorCode' => 'CopyImage.TargetRegionImageAlreadyExists', 'errorMessage' => 'Target region has the same digest image.', 'description' => ''], ], [ ['errorCode' => 'Resource.NotFound', 'errorMessage' => 'Resource not found.', 'description' => ''], ], [ ['errorCode' => 'ClusterAPI.NotSupported', 'errorMessage' => 'ClusterAPI not supported in this region.', 'description' => ''], ], 409 => [ ['errorCode' => 'Conflict.InstanceModifying', 'errorMessage' => 'Instance is being modified by a previous request. Please try again later.', 'description' => ''], ['errorCode' => 'Conflict', 'errorMessage' => 'Resource is being updated by a previous request. Current request is redundant.', 'description' => ''], ['errorCode' => 'Cluster.Conflict', 'errorMessage' => 'The cluster is being updated by a previous request. Please try again later.', 'description' => ''], ], 500 => [ ['errorCode' => 'ConfigWhitelistFailed.Error', 'errorMessage' => 'config white list error', 'description' => ''], ['errorCode' => 'ActionFailed.Error', 'errorMessage' => 'internal error, please try again', 'description' => ''], ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => 'Unknown error caused request processing to fail.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ConfigInstanceIpAddress', 'summary' => 'Modifies the virtual private cloud (VPC) endpoint of a hardware security module (HSM).', 'description' => 'After you add an HSM to a cluster, you cannot modify the VPC endpoint of the HSM.'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:ConfigInstanceIpAddress', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C467B38-3910-447D-87BC-AC049166F216\\"\\n}","type":"json"}]', ], 'ConfigInstanceRemark' => [ 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREhsmV7VE3Y', 'FEATUREhsm01FLNB', 'FEATUREhsmGIFYCG', 'FEATUREhsmLBBV5W'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the HSM instance.', 'type' => 'string', 'required' => true, 'example' => 'hsm-cn-vj30bil8****', 'title' => ''], ], [ 'name' => 'Remark', 'in' => 'formData', 'schema' => ['description' => 'The remarks.', 'type' => 'string', 'required' => true, 'example' => 'hsmOnline', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'BaseResult', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request. Alibaba Cloud generates this ID to uniquely identify the request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '4C467B38-3910-447D-87BC-AC049166F216', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'SwitchMaster.InstanceInvalid', 'errorMessage' => 'Instance not in the cluster.', 'description' => ''], ['errorCode' => 'LeaveCluster.MasterLast', 'errorMessage' => 'Master instance can not leave a cluster until all other instances are left.', 'description' => ''], ['errorCode' => 'Certificate.ChainInvalid', 'errorMessage' => 'Certificate chain invalid. Please make sure issuer certificate is the trust anchor and cluster certificate is signed by issuer certificate.', 'description' => ''], ['errorCode' => 'Certificate.FormatInvalid', 'errorMessage' => 'Certificate format invalid. Cluster/Issuer certificate must be in PEM format.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.DuplicateZone', 'errorMessage' => 'VSwitches should not contain duplicate zones.', 'description' => ''], ['errorCode' => 'InvalidApiParam.Error', 'errorMessage' => 'api param is invalid', 'description' => ''], ['errorCode' => 'InvalidClusterName', 'errorMessage' => 'Invalid parameter clusterName.', 'description' => ''], ['errorCode' => 'InvalidPageSize', 'errorMessage' => 'Invalid parameter pageSize.', 'description' => ''], ['errorCode' => 'InvalidCurrentPage', 'errorMessage' => 'Invalid parameter currentPage.', 'description' => ''], ['errorCode' => 'InvalidRegionId', 'errorMessage' => 'Invalid parameter regionId.', 'description' => ''], ['errorCode' => 'InvalidVSwitch', 'errorMessage' => 'Invalid parameter vSwitch.', 'description' => ''], ['errorCode' => 'InvalidVpc', 'errorMessage' => 'Invalid parameter vpcId.', 'description' => ''], ['errorCode' => 'InvalidIp', 'errorMessage' => 'Invalid parameter IP.', 'description' => ''], ['errorCode' => 'InvalidAliuid', 'errorMessage' => 'Invalid parameter aliuid.', 'description' => ''], ['errorCode' => 'InvalidClusterId', 'errorMessage' => 'Invalid parameter clusterId.', 'description' => ''], ['errorCode' => 'InvalidInstanceId', 'errorMessage' => 'Invalid parameter instanceId.', 'description' => ''], ['errorCode' => 'InvalidBackupId', 'errorMessage' => 'Invalid parameter backupId.', 'description' => ''], ['errorCode' => 'InvalidImageId', 'errorMessage' => 'Invalid parameter imageId.', 'description' => ''], ['errorCode' => 'HsmInstanceNotExist.Error', 'errorMessage' => 'hsm instance not exist', 'description' => ''], ['errorCode' => 'HSMIntanceNotActived.Error', 'errorMessage' => 'hsm intance is not actived', 'description' => ''], ['errorCode' => 'WhiteListMaxCount.Error', 'errorMessage' => 'whilte list is more than max count', 'description' => ''], ['errorCode' => 'ClusterIdIsNotExists.Error', 'errorMessage' => 'cluster ID non-exists', 'description' => ''], ['errorCode' => 'InstanceListIsEmpty.Error', 'errorMessage' => 'instance list is empty', 'description' => ''], ['errorCode' => 'InstanceIdIsEmpty.Error', 'errorMessage' => 'instance id is empty', 'description' => ''], ['errorCode' => 'InstanceIsNotExistsInCluster.Error', 'errorMessage' => 'cluster has no such instance', 'description' => ''], ['errorCode' => 'InstanceIsExistsInCluster.Error', 'errorMessage' => 'instance already in the cluster', 'description' => ''], ['errorCode' => 'RegionNoEmpty.Error', 'errorMessage' => 'region no. is empty', 'description' => ''], ['errorCode' => 'ClusterNameEmpty.Error', 'errorMessage' => 'empty cluster name not allowed', 'description' => ''], ['errorCode' => 'ClusterNameIsExists.Error', 'errorMessage' => 'the cluster name is already taken', 'description' => ''], ['errorCode' => 'IpNotValid.Error', 'errorMessage' => 'ip not valid', 'description' => ''], ['errorCode' => 'ClusterIsEmpty.Error', 'errorMessage' => 'cluster is empty', 'description' => ''], ['errorCode' => 'NoMasterFoundInCluster.Error', 'errorMessage' => 'cluster has no master instance', 'description' => ''], ['errorCode' => 'HsmInstanceIdNotFound.Error', 'errorMessage' => 'no such instance', 'description' => ''], ['errorCode' => 'NoInstanceFoundInCluster.Error', 'errorMessage' => 'cluster is empty', 'description' => ''], ['errorCode' => 'Whitelist.Invalid', 'errorMessage' => 'Whitelist blocks not in CIDR format.', 'description' => ''], ['errorCode' => 'Whitelist.TooLong', 'errorMessage' => 'Whitelist too long, exceeds 10 CIDR blocks.', 'description' => ''], ], 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'Caller has no permission on the resource.', 'description' => ''], ['errorCode' => 'InstanceNotPaused', 'errorMessage' => 'Please pause the instance before reset.', 'description' => ''], ], [ ['errorCode' => 'Resource.NotFound', 'errorMessage' => 'Resource not found.', 'description' => ''], ], [ ['errorCode' => 'ClusterAPI.NotSupported', 'errorMessage' => 'ClusterAPI not supported in this region.', 'description' => ''], ], 409 => [ ['errorCode' => 'SwitchMaster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'Cluster.Conflict', 'errorMessage' => 'The cluster is being updated by a previous request. Please try again later.', 'description' => ''], ['errorCode' => 'SyncCluster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'LeaveCluster.InstanceInvalid', 'errorMessage' => 'The instance is not in the cluster.', 'description' => ''], ['errorCode' => 'DeleteCluster.IncorrectState', 'errorMessage' => 'Cluster not empty, please remove all instances first.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceVSwitchNotInCluster', 'errorMessage' => 'Instance\'s vSwitch is not in cluster config, please change instance\'s vSwitch first.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceInitialized', 'errorMessage' => 'Initialized instance can not join a cluster.', 'description' => ''], ['errorCode' => 'JoinCluster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'InitializeCluster.InstanceNotInitialized', 'errorMessage' => 'Cluster master instance not initialized, please initialize cluster master instance first.', 'description' => ''], ['errorCode' => 'InitializeCluster.IncorrectConfig', 'errorMessage' => 'Cluster subnet not configured, please config cluster subnet first.', 'description' => ''], ['errorCode' => 'InitializeCluster.IncorrectState', 'errorMessage' => 'Cluster initialized, do not re-initialize.', 'description' => ''], ['errorCode' => 'Cluster.CN.ActionForbidden', 'errorMessage' => 'This API is forbidden for non-international site cluster.', 'description' => ''], ['errorCode' => 'Cluster.INTL.ActionForbidden', 'errorMessage' => 'This API is forbidden for international site cluster.', 'description' => ''], ['errorCode' => 'ConfigClusterCertificate.IncorrectState', 'errorMessage' => 'Cluster initialized or certificates already configured.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.InvalidVpcId', 'errorMessage' => 'VPC Id invalid. Cluster VPC is the same as cluster master\'s VPC.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.InvalidVSwitchId', 'errorMessage' => 'VSwitch Id invalid. VSwitches should contain all current cluster vSwitches.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.IncorrectState', 'errorMessage' => 'Cluster not in NEW state, can not config cluster subnet.', 'description' => ''], ['errorCode' => 'ClusterName.Exist', 'errorMessage' => 'Cluster name already exists, please use another name.', 'description' => ''], ['errorCode' => 'Conflict', 'errorMessage' => 'Resource is being updated by a previous request. Current request is redundant.', 'description' => ''], ['errorCode' => 'ConfigIp.IncorrectState', 'errorMessage' => 'Instance not in pending or active state, can not config IP address.', 'description' => ''], ], 500 => [ ['errorCode' => 'ConfigWhitelistFailed.Error', 'errorMessage' => 'config white list error', 'description' => ''], ['errorCode' => 'ActionFailed.Error', 'errorMessage' => 'internal error, please try again', 'description' => ''], ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => 'Unknown error caused request processing to fail.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ConfigInstanceRemark', 'summary' => 'Modifies the remark of an instance.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:ConfigInstanceRemark', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C467B38-3910-447D-87BC-AC049166F216\\"\\n}","type":"json"}]', ], 'ConfigInstanceWhitelist' => [ 'summary' => 'Modifies the whitelist for an instance.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREhsmV7VE3Y', 'FEATUREhsm01FLNB', 'FEATUREhsmGIFYCG', 'FEATUREhsmLBBV5W'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the HSM instance.', 'type' => 'string', 'required' => true, 'example' => 'hsm-cn-vj30bil8****', 'title' => ''], ], [ 'name' => 'Whitelist', 'in' => 'formData', 'schema' => ['description' => 'The list of IP addresses to add to the whitelist. Separate multiple IP addresses with spaces or commas (,).', 'type' => 'string', 'required' => true, 'example' => '18.68.XX.XX,18.68.XX.XX', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'BaseResult', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request. Alibaba Cloud generates a unique ID for each request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '4C467B38-3910-447D-87BC-AC049166F216', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'SwitchMaster.InstanceInvalid', 'errorMessage' => 'Instance not in the cluster.', 'description' => ''], ['errorCode' => 'LeaveCluster.MasterLast', 'errorMessage' => 'Master instance can not leave a cluster until all other instances are left.', 'description' => ''], ['errorCode' => 'Certificate.ChainInvalid', 'errorMessage' => 'Certificate chain invalid. Please make sure issuer certificate is the trust anchor and cluster certificate is signed by issuer certificate.', 'description' => ''], ['errorCode' => 'Certificate.FormatInvalid', 'errorMessage' => 'Certificate format invalid. Cluster/Issuer certificate must be in PEM format.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.DuplicateZone', 'errorMessage' => 'VSwitches should not contain duplicate zones.', 'description' => ''], ['errorCode' => 'InvalidApiParam.Error', 'errorMessage' => 'api param is invalid', 'description' => ''], ['errorCode' => 'InvalidClusterName', 'errorMessage' => 'Invalid parameter clusterName.', 'description' => ''], ['errorCode' => 'InvalidPageSize', 'errorMessage' => 'Invalid parameter pageSize.', 'description' => ''], ['errorCode' => 'InvalidCurrentPage', 'errorMessage' => 'Invalid parameter currentPage.', 'description' => ''], ['errorCode' => 'InvalidRegionId', 'errorMessage' => 'Invalid parameter regionId.', 'description' => ''], ['errorCode' => 'InvalidVSwitch', 'errorMessage' => 'Invalid parameter vSwitch.', 'description' => ''], ['errorCode' => 'InvalidVpc', 'errorMessage' => 'Invalid parameter vpcId.', 'description' => ''], ['errorCode' => 'InvalidIp', 'errorMessage' => 'Invalid parameter IP.', 'description' => ''], ['errorCode' => 'InvalidAliuid', 'errorMessage' => 'Invalid parameter aliuid.', 'description' => ''], ['errorCode' => 'InvalidClusterId', 'errorMessage' => 'Invalid parameter clusterId.', 'description' => ''], ['errorCode' => 'InvalidInstanceId', 'errorMessage' => 'Invalid parameter instanceId.', 'description' => ''], ['errorCode' => 'InvalidBackupId', 'errorMessage' => 'Invalid parameter backupId.', 'description' => ''], ['errorCode' => 'InvalidImageId', 'errorMessage' => 'Invalid parameter imageId.', 'description' => ''], ['errorCode' => 'HsmInstanceNotExist.Error', 'errorMessage' => 'hsm instance not exist', 'description' => ''], ['errorCode' => 'HSMIntanceNotActived.Error', 'errorMessage' => 'hsm intance is not actived', 'description' => ''], ['errorCode' => 'WhiteListMaxCount.Error', 'errorMessage' => 'whilte list is more than max count', 'description' => ''], ['errorCode' => 'ClusterIdIsNotExists.Error', 'errorMessage' => 'cluster ID non-exists', 'description' => ''], ['errorCode' => 'InstanceListIsEmpty.Error', 'errorMessage' => 'instance list is empty', 'description' => ''], ['errorCode' => 'InstanceIdIsEmpty.Error', 'errorMessage' => 'instance id is empty', 'description' => ''], ['errorCode' => 'InstanceIsNotExistsInCluster.Error', 'errorMessage' => 'cluster has no such instance', 'description' => ''], ['errorCode' => 'InstanceIsExistsInCluster.Error', 'errorMessage' => 'instance already in the cluster', 'description' => ''], ['errorCode' => 'RegionNoEmpty.Error', 'errorMessage' => 'region no. is empty', 'description' => ''], ['errorCode' => 'ClusterNameEmpty.Error', 'errorMessage' => 'empty cluster name not allowed', 'description' => ''], ['errorCode' => 'ClusterNameIsExists.Error', 'errorMessage' => 'the cluster name is already taken', 'description' => ''], ['errorCode' => 'IpNotValid.Error', 'errorMessage' => 'ip not valid', 'description' => ''], ['errorCode' => 'ClusterIsEmpty.Error', 'errorMessage' => 'cluster is empty', 'description' => ''], ['errorCode' => 'NoMasterFoundInCluster.Error', 'errorMessage' => 'cluster has no master instance', 'description' => ''], ['errorCode' => 'HsmInstanceIdNotFound.Error', 'errorMessage' => 'no such instance', 'description' => ''], ['errorCode' => 'NoInstanceFoundInCluster.Error', 'errorMessage' => 'cluster is empty', 'description' => ''], ['errorCode' => 'Whitelist.Invalid', 'errorMessage' => 'Whitelist blocks not in CIDR format.', 'description' => ''], ['errorCode' => 'Whitelist.TooLong', 'errorMessage' => 'Whitelist too long, exceeds 10 CIDR blocks.', 'description' => ''], ], 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'Caller has no permission on the resource.', 'description' => ''], ['errorCode' => 'InstanceNotPaused', 'errorMessage' => 'Please pause the instance before reset.', 'description' => ''], ['errorCode' => 'InstanceNotActive', 'errorMessage' => 'Instance is not active.', 'description' => ''], ['errorCode' => 'ConfigIp.IncorrectState', 'errorMessage' => 'Instance not in pending or active state, can not config IP address.', 'description' => ''], ['errorCode' => 'SwitchMaster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'SyncCluster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'LeaveCluster.InstanceInvalid', 'errorMessage' => 'The instance is not in the cluster.', 'description' => ''], ['errorCode' => 'DeleteCluster.IncorrectState', 'errorMessage' => 'Cluster not empty, please remove all instances first.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceVSwitchNotInCluster', 'errorMessage' => 'Instance\'s vSwitch is not in cluster config, please change instance\'s vSwitch first.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceInitialized', 'errorMessage' => 'Initialized instance can not join a cluster.', 'description' => ''], ['errorCode' => 'JoinCluster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'InitializeCluster.InstanceNotInitialized', 'errorMessage' => 'Cluster master instance not initialized, please initialize cluster master instance first.', 'description' => ''], ['errorCode' => 'InitializeCluster.IncorrectConfig', 'errorMessage' => 'Cluster subnet not configured, please config cluster subnet first.', 'description' => ''], ['errorCode' => 'InitializeCluster.IncorrectState', 'errorMessage' => 'Cluster initialized, do not re-initialize.', 'description' => ''], ['errorCode' => 'Cluster.CN.ActionForbidden', 'errorMessage' => 'This API is forbidden for non-international site cluster.', 'description' => ''], ['errorCode' => 'Cluster.INTL.ActionForbidden', 'errorMessage' => 'This API is forbidden for international site cluster.', 'description' => ''], ['errorCode' => 'ConfigClusterCertificate.IncorrectState', 'errorMessage' => 'Cluster initialized or certificates already configured.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.InvalidVpcId', 'errorMessage' => 'VPC Id invalid. Cluster VPC is the same as cluster master\'s VPC.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.InvalidVSwitchId', 'errorMessage' => 'VSwitch Id invalid. VSwitches should contain all current cluster vSwitches.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.IncorrectState', 'errorMessage' => 'Cluster not in NEW state, can not config cluster subnet.', 'description' => ''], ['errorCode' => 'ClusterName.Exist', 'errorMessage' => 'Cluster name already exists, please use another name.', 'description' => ''], ['errorCode' => 'Whitelist.InstanceInCluster', 'errorMessage' => 'Whitelist.InstanceInCluster', 'description' => ''], ], [ ['errorCode' => 'Resource.NotFound', 'errorMessage' => 'Resource not found.', 'description' => ''], ], [ ['errorCode' => 'ClusterAPI.NotSupported', 'errorMessage' => 'ClusterAPI not supported in this region.', 'description' => ''], ], 409 => [ ['errorCode' => 'Conflict', 'errorMessage' => 'Resource is being updated by a previous request. Current request is redundant.', 'description' => ''], ['errorCode' => 'Cluster.Conflict', 'errorMessage' => 'The cluster is being updated by a previous request. Please try again later.', 'description' => ''], ], 500 => [ ['errorCode' => 'ConfigWhitelistFailed.Error', 'errorMessage' => 'config white list error', 'description' => ''], ['errorCode' => 'ActionFailed.Error', 'errorMessage' => 'internal error, please try again', 'description' => ''], ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => 'Unknown error caused request processing to fail.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ConfigInstanceWhitelist', 'description' => 'You can configure the whitelist for an HSM instance if the instance has not joined a cluster and is in the Active status.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:ConfigInstanceWhitelist', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C467B38-3910-447D-87BC-AC049166F216\\"\\n}","type":"json"}]', ], 'CopyImage' => [ 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '218511', 'abilityTreeNodes' => ['FEATUREhsmQEGDGS'], ], 'parameters' => [ [ 'name' => 'ImageUid', 'in' => 'formData', 'schema' => ['description' => 'The image ID.', 'type' => 'string', 'required' => false, 'example' => 'image-hafiudfahdd****', 'title' => ''], ], [ 'name' => 'TargetRegionId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the destination region.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The details of the job.', 'type' => 'object', 'properties' => [ 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => 'job-202401250936hze747fd7e0007005', 'title' => ''], 'Type' => ['description' => 'The operation type.'."\n" ."\n" .'- create: Creates a job.'."\n" ."\n" .'- cancel: Cancels a job.', 'type' => 'string', 'example' => 'create', 'title' => ''], 'Completed' => ['description' => 'Indicates whether the job is complete.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'CreateTime' => ['description' => 'The time when the job was created. This is a UNIX timestamp that is accurate to the millisecond.', 'type' => 'string', 'example' => '1724379766191', 'title' => ''], 'Status' => ['description' => 'The status of the job.', 'type' => 'string', 'example' => 'running', 'title' => ''], 'Response' => ['description' => 'The response information returned after the job is successful.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Error' => ['description' => 'The error message returned if the job fails.', 'type' => 'string', 'example' => 'OperationTimeout', 'title' => ''], 'Progress' => ['description' => 'The progress of the job. Unit: percent.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request. This is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '4C467B38-3910-447D-87BC-AC049166F216', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'SwitchMaster.InstanceInvalid', 'errorMessage' => 'Instance not in the cluster.', 'description' => ''], ['errorCode' => 'LeaveCluster.MasterLast', 'errorMessage' => 'Master instance can not leave a cluster until all other instances are left.', 'description' => ''], ['errorCode' => 'Certificate.ChainInvalid', 'errorMessage' => 'Certificate chain invalid. Please make sure issuer certificate is the trust anchor and cluster certificate is signed by issuer certificate.', 'description' => ''], ['errorCode' => 'Certificate.FormatInvalid', 'errorMessage' => 'Certificate format invalid. Cluster/Issuer certificate must be in PEM format.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.DuplicateZone', 'errorMessage' => 'VSwitches should not contain duplicate zones.', 'description' => ''], ['errorCode' => 'InvalidApiParam.Error', 'errorMessage' => 'api param is invalid', 'description' => ''], ['errorCode' => 'InvalidClusterName', 'errorMessage' => 'Invalid parameter clusterName.', 'description' => ''], ['errorCode' => 'InvalidPageSize', 'errorMessage' => 'Invalid parameter pageSize.', 'description' => ''], ['errorCode' => 'InvalidCurrentPage', 'errorMessage' => 'Invalid parameter currentPage.', 'description' => ''], ['errorCode' => 'InvalidRegionId', 'errorMessage' => 'Invalid parameter regionId.', 'description' => ''], ['errorCode' => 'InvalidZoneId', 'errorMessage' => 'Invalid parameter zoneId.', 'description' => ''], ['errorCode' => 'InvalidVSwitch', 'errorMessage' => 'Invalid parameter vSwitch.', 'description' => ''], ['errorCode' => 'InvalidVpc', 'errorMessage' => 'Invalid parameter vpcId.', 'description' => ''], ['errorCode' => 'InvalidVsmType', 'errorMessage' => 'Invalid parameter vsmType.', 'description' => ''], ['errorCode' => 'InvalidIp', 'errorMessage' => 'Invalid parameter IP.', 'description' => ''], ['errorCode' => 'InvalidAliuid', 'errorMessage' => 'Invalid parameter aliuid.', 'description' => ''], ['errorCode' => 'InvalidClusterId', 'errorMessage' => 'Invalid parameter clusterId.', 'description' => ''], ['errorCode' => 'InvalidInstanceId', 'errorMessage' => 'Invalid parameter instanceId.', 'description' => ''], ['errorCode' => 'InvalidBackupId', 'errorMessage' => 'Invalid parameter backupId.', 'description' => ''], ['errorCode' => 'InvalidImageId', 'errorMessage' => 'Invalid parameter imageId.', 'description' => ''], ['errorCode' => 'HsmInstanceNotExist.Error', 'errorMessage' => 'hsm instance not exist', 'description' => ''], ['errorCode' => 'HSMIntanceNotActived.Error', 'errorMessage' => 'hsm intance is not actived', 'description' => ''], ['errorCode' => 'WhiteListMaxCount.Error', 'errorMessage' => 'whilte list is more than max count', 'description' => ''], ['errorCode' => 'ClusterIdIsNotExists.Error', 'errorMessage' => 'cluster ID non-exists', 'description' => ''], ['errorCode' => 'InstanceListIsEmpty.Error', 'errorMessage' => 'instance list is empty', 'description' => ''], ['errorCode' => 'InstanceIdIsEmpty.Error', 'errorMessage' => 'instance id is empty', 'description' => ''], ['errorCode' => 'InstanceIsNotExistsInCluster.Error', 'errorMessage' => 'cluster has no such instance', 'description' => ''], ['errorCode' => 'InstanceIsExistsInCluster.Error', 'errorMessage' => 'instance already in the cluster', 'description' => ''], ['errorCode' => 'RegionNoEmpty.Error', 'errorMessage' => 'region no. is empty', 'description' => ''], ['errorCode' => 'ClusterNameEmpty.Error', 'errorMessage' => 'empty cluster name not allowed', 'description' => ''], ['errorCode' => 'ClusterNameIsExists.Error', 'errorMessage' => 'the cluster name is already taken', 'description' => ''], ['errorCode' => 'IpNotValid.Error', 'errorMessage' => 'ip not valid', 'description' => ''], ['errorCode' => 'ClusterIsEmpty.Error', 'errorMessage' => 'cluster is empty', 'description' => ''], ['errorCode' => 'NoMasterFoundInCluster.Error', 'errorMessage' => 'cluster has no master instance', 'description' => ''], ['errorCode' => 'HsmInstanceIdNotFound.Error', 'errorMessage' => 'no such instance', 'description' => ''], ['errorCode' => 'NoInstanceFoundInCluster.Error', 'errorMessage' => 'cluster is empty', 'description' => ''], ['errorCode' => 'Whitelist.Invalid', 'errorMessage' => 'Whitelist blocks not in CIDR format.', 'description' => ''], ['errorCode' => 'Whitelist.TooLong', 'errorMessage' => 'Whitelist too long, exceeds 10 CIDR blocks.', 'description' => ''], ], 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'User has no permission to access this resource.', 'description' => ''], ['errorCode' => 'Trial.Forbidden', 'errorMessage' => 'Current user is not allowed for trials!', 'description' => ''], ['errorCode' => 'Forbidden.InstanceInCluster', 'errorMessage' => 'This API is forbidden for instances in cluster.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceIncorrectState', 'errorMessage' => 'Instance not in Active/Pending state.', 'description' => ''], ['errorCode' => 'InstanceNotPaused', 'errorMessage' => 'Please pause the instance before reset.', 'description' => ''], ['errorCode' => 'InstanceNotActive', 'errorMessage' => 'Instance is not active.', 'description' => ''], ['errorCode' => 'ConfigIp.IncorrectState', 'errorMessage' => 'Instance not in pending or active state, can not config IP address.', 'description' => ''], ['errorCode' => 'SwitchMaster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'SyncCluster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'LeaveCluster.InstanceInvalid', 'errorMessage' => 'The instance is not in the cluster.', 'description' => ''], ['errorCode' => 'DeleteCluster.IncorrectState', 'errorMessage' => 'Cluster not empty, please remove all instances first.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceVSwitchNotInCluster', 'errorMessage' => 'Instance\'s vSwitch is not in cluster config, please change instance\'s vSwitch first.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceInitialized', 'errorMessage' => 'Initialized instance can not join a cluster.', 'description' => ''], ['errorCode' => 'JoinCluster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'InitializeCluster.InstanceNotInitialized', 'errorMessage' => 'Cluster master instance not initialized, please initialize cluster master instance first.', 'description' => ''], ['errorCode' => 'InitializeCluster.IncorrectConfig', 'errorMessage' => 'Cluster subnet not configured, please config cluster subnet first.', 'description' => ''], ['errorCode' => 'InitializeCluster.IncorrectState', 'errorMessage' => 'Cluster initialized, do not re-initialize.', 'description' => ''], ['errorCode' => 'Cluster.CN.ActionForbidden', 'errorMessage' => 'This API is forbidden for non-international site cluster.', 'description' => ''], ['errorCode' => 'Cluster.INTL.ActionForbidden', 'errorMessage' => 'This API is forbidden for international site cluster.', 'description' => ''], ['errorCode' => 'ConfigClusterCertificate.IncorrectState', 'errorMessage' => 'Cluster initialized or certificates already configured.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.InvalidVpcId', 'errorMessage' => 'VPC Id invalid. Cluster VPC is the same as cluster master\'s VPC.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.InvalidVSwitchId', 'errorMessage' => 'VSwitch Id invalid. VSwitches should contain all current cluster vSwitches.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.IncorrectState', 'errorMessage' => 'Cluster not in NEW state, can not config cluster subnet.', 'description' => ''], ['errorCode' => 'ClusterName.Exist', 'errorMessage' => 'Cluster name already exists, please use another name.', 'description' => ''], ['errorCode' => 'Image.ImageStatusInValid', 'errorMessage' => 'Image status is invalid.', 'description' => ''], ['errorCode' => 'CopyImage.ImageAlreadyCopied', 'errorMessage' => 'Image already copied, secondary copy is not supported.', 'description' => ''], ['errorCode' => 'Image.ActionForbiddenINTL', 'errorMessage' => 'This API is forbidden for international site.', 'description' => ''], ['errorCode' => 'Image.ActionForbiddenCN', 'errorMessage' => 'This API is forbidden for non-international site.', 'description' => ''], ['errorCode' => 'CopyImage.RegionInvalid', 'errorMessage' => 'Source region or target region invalid.', 'description' => ''], ['errorCode' => 'Backup.ActionForbiddenINTL', 'errorMessage' => 'This API is forbidden for international site.', 'description' => ''], ['errorCode' => 'CopyImage.TargetRegionImageAlreadyExists', 'errorMessage' => 'Target region has the same digest image.', 'description' => ''], ], [ ['errorCode' => 'Resource.NotFound', 'errorMessage' => 'Resource not found.', 'description' => ''], ], [ ['errorCode' => 'ClusterAPI.NotSupported', 'errorMessage' => 'ClusterAPI not supported in this region.', 'description' => ''], ], 409 => [ ['errorCode' => 'Conflict.InstanceModifying', 'errorMessage' => 'Instance is being modified by a previous request. Please try again later.', 'description' => ''], ['errorCode' => 'Conflict', 'errorMessage' => 'Resource is being updated by a previous request. Current request is redundant.', 'description' => ''], ['errorCode' => 'Cluster.Conflict', 'errorMessage' => 'The cluster is being updated by a previous request. Please try again later.', 'description' => ''], ], 500 => [ ['errorCode' => 'ConfigWhitelistFailed.Error', 'errorMessage' => 'config white list error', 'description' => ''], ['errorCode' => 'ActionFailed.Error', 'errorMessage' => 'internal error, please try again', 'description' => ''], ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => 'Unknown error caused request processing to fail.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CopyImage', 'summary' => 'Copies an image to another region.', 'description' => 'The destination region cannot contain an identical image. This API call is supported only by HSMs outside the Chinese mainland.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:CopyImage', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"JobId\\": \\"job-202401250936hze747fd7e0007005\\",\\n \\"Type\\": \\"create\\",\\n \\"Completed\\": true,\\n \\"CreateTime\\": \\"1724379766191\\",\\n \\"Status\\": \\"running\\",\\n \\"Response\\": \\"success\\",\\n \\"Error\\": \\"OperationTimeout\\",\\n \\"Progress\\": 100,\\n \\"RequestId\\": \\"4C467B38-3910-447D-87BC-AC049166F216\\"\\n}","type":"json"}]', ], 'CreateCluster' => [ 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREhsmV7VE3Y', 'FEATUREhsm01FLNB', 'FEATUREhsmGIFYCG', 'FEATUREhsmLBBV5W'], ], 'parameters' => [ [ 'name' => 'ClusterName', 'in' => 'formData', 'schema' => ['description' => 'The name of the cluster.', 'type' => 'string', 'required' => true, 'example' => 'cluster_on****', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'formData', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'MasterInstanceId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the master HSM instance.', 'type' => 'string', 'required' => true, 'example' => 'hsm_intl-sg-uz63ixak****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'PlainResult', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request. Alibaba Cloud generates a unique ID for each request. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '5F58413E-8F57-585B-BE48-64CC1E31133C', 'title' => ''], 'ClusterId' => ['description' => 'The ID of the cluster.', 'type' => 'string', 'example' => 'cluster-729dm40FG****', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'SwitchMaster.InstanceInvalid', 'errorMessage' => 'Instance not in the cluster.', 'description' => ''], ['errorCode' => 'LeaveCluster.MasterLast', 'errorMessage' => 'Master instance can not leave a cluster until all other instances are left.', 'description' => ''], ['errorCode' => 'Certificate.ChainInvalid', 'errorMessage' => 'Certificate chain invalid. Please make sure issuer certificate is the trust anchor and cluster certificate is signed by issuer certificate.', 'description' => ''], ['errorCode' => 'Certificate.FormatInvalid', 'errorMessage' => 'Certificate format invalid. Cluster/Issuer certificate must be in PEM format.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.DuplicateZone', 'errorMessage' => 'VSwitches should not contain duplicate zones.', 'description' => ''], ['errorCode' => 'InvalidApiParam.Error', 'errorMessage' => 'api param is invalid', 'description' => ''], ['errorCode' => 'InvalidClusterName', 'errorMessage' => 'Invalid parameter clusterName.', 'description' => ''], ['errorCode' => 'InvalidPageSize', 'errorMessage' => 'Invalid parameter pageSize.', 'description' => ''], ['errorCode' => 'InvalidCurrentPage', 'errorMessage' => 'Invalid parameter currentPage.', 'description' => ''], ['errorCode' => 'InvalidRegionId', 'errorMessage' => 'Invalid parameter regionId.', 'description' => ''], ['errorCode' => 'InvalidVSwitch', 'errorMessage' => 'Invalid parameter vSwitch.', 'description' => ''], ['errorCode' => 'InvalidVpc', 'errorMessage' => 'Invalid parameter vpcId.', 'description' => ''], ['errorCode' => 'InvalidIp', 'errorMessage' => 'Invalid parameter IP.', 'description' => ''], ['errorCode' => 'InvalidAliuid', 'errorMessage' => 'Invalid parameter aliuid.', 'description' => ''], ['errorCode' => 'InvalidClusterId', 'errorMessage' => 'Invalid parameter clusterId.', 'description' => ''], ['errorCode' => 'InvalidInstanceId', 'errorMessage' => 'Invalid parameter instanceId.', 'description' => ''], ['errorCode' => 'InvalidBackupId', 'errorMessage' => 'Invalid parameter backupId.', 'description' => ''], ['errorCode' => 'InvalidImageId', 'errorMessage' => 'Invalid parameter imageId.', 'description' => ''], ['errorCode' => 'HsmInstanceNotExist.Error', 'errorMessage' => 'hsm instance not exist', 'description' => ''], ['errorCode' => 'HSMIntanceNotActived.Error', 'errorMessage' => 'hsm intance is not actived', 'description' => ''], ['errorCode' => 'WhiteListMaxCount.Error', 'errorMessage' => 'whilte list is more than max count', 'description' => ''], ['errorCode' => 'ClusterIdIsNotExists.Error', 'errorMessage' => 'cluster ID non-exists', 'description' => ''], ['errorCode' => 'InstanceListIsEmpty.Error', 'errorMessage' => 'instance list is empty', 'description' => ''], ['errorCode' => 'InstanceIdIsEmpty.Error', 'errorMessage' => 'instance id is empty', 'description' => ''], ['errorCode' => 'InstanceIsNotExistsInCluster.Error', 'errorMessage' => 'cluster has no such instance', 'description' => ''], ['errorCode' => 'InstanceIsExistsInCluster.Error', 'errorMessage' => 'instance already in the cluster', 'description' => ''], ['errorCode' => 'RegionNoEmpty.Error', 'errorMessage' => 'region no. is empty', 'description' => ''], ['errorCode' => 'ClusterNameEmpty.Error', 'errorMessage' => 'empty cluster name not allowed', 'description' => ''], ['errorCode' => 'ClusterNameIsExists.Error', 'errorMessage' => 'the cluster name is already taken', 'description' => ''], ['errorCode' => 'IpNotValid.Error', 'errorMessage' => 'ip not valid', 'description' => ''], ['errorCode' => 'ClusterIsEmpty.Error', 'errorMessage' => 'cluster is empty', 'description' => ''], ['errorCode' => 'NoMasterFoundInCluster.Error', 'errorMessage' => 'cluster has no master instance', 'description' => ''], ['errorCode' => 'HsmInstanceIdNotFound.Error', 'errorMessage' => 'no such instance', 'description' => ''], ['errorCode' => 'NoInstanceFoundInCluster.Error', 'errorMessage' => 'cluster is empty', 'description' => ''], ['errorCode' => 'Whitelist.Invalid', 'errorMessage' => 'Whitelist blocks not in CIDR format.', 'description' => ''], ['errorCode' => 'Whitelist.TooLong', 'errorMessage' => 'Whitelist too long, exceeds 10 CIDR blocks.', 'description' => ''], ], 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'Caller has no permission on the resource.', 'description' => ''], ['errorCode' => 'InstanceNotPaused', 'errorMessage' => 'Please pause the instance before reset.', 'description' => ''], ['errorCode' => 'InstanceNotActive', 'errorMessage' => 'Instance is not active.', 'description' => ''], ['errorCode' => 'ConfigIp.IncorrectState', 'errorMessage' => 'Instance not in pending or active state, can not config IP address.', 'description' => ''], ['errorCode' => 'SwitchMaster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'SyncCluster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'LeaveCluster.InstanceInvalid', 'errorMessage' => 'The instance is not in the cluster.', 'description' => ''], ['errorCode' => 'DeleteCluster.IncorrectState', 'errorMessage' => 'Cluster not empty, please remove all instances first.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceVSwitchNotInCluster', 'errorMessage' => 'Instance\'s vSwitch is not in cluster config, please change instance\'s vSwitch first.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceInitialized', 'errorMessage' => 'Initialized instance can not join a cluster.', 'description' => ''], ['errorCode' => 'JoinCluster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'InitializeCluster.InstanceNotInitialized', 'errorMessage' => 'Cluster master instance not initialized, please initialize cluster master instance first.', 'description' => ''], ['errorCode' => 'InitializeCluster.IncorrectConfig', 'errorMessage' => 'Cluster subnet not configured, please config cluster subnet first.', 'description' => ''], ['errorCode' => 'InitializeCluster.IncorrectState', 'errorMessage' => 'Cluster initialized, do not re-initialize.', 'description' => ''], ['errorCode' => 'Cluster.CN.ActionForbidden', 'errorMessage' => 'This API is forbidden for non-international site cluster.', 'description' => ''], ['errorCode' => 'Cluster.INTL.ActionForbidden', 'errorMessage' => 'This API is forbidden for international site cluster.', 'description' => ''], ['errorCode' => 'ConfigClusterCertificate.IncorrectState', 'errorMessage' => 'Cluster initialized or certificates already configured.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.InvalidVpcId', 'errorMessage' => 'VPC Id invalid. Cluster VPC is the same as cluster master\'s VPC.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.InvalidVSwitchId', 'errorMessage' => 'VSwitch Id invalid. VSwitches should contain all current cluster vSwitches.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.IncorrectState', 'errorMessage' => 'Cluster not in NEW state, can not config cluster subnet.', 'description' => ''], ['errorCode' => 'ClusterName.Exist', 'errorMessage' => 'Cluster name already exists, please use another name.', 'description' => ''], ['errorCode' => 'Whitelist.InstanceInCluster', 'errorMessage' => 'Whitelist.InstanceInCluster', 'description' => ''], ], [ ['errorCode' => 'Resource.NotFound', 'errorMessage' => 'Resource not found.', 'description' => ''], ], [ ['errorCode' => 'ClusterAPI.NotSupported', 'errorMessage' => 'ClusterAPI not supported in this region.', 'description' => ''], ], 409 => [ ['errorCode' => 'Conflict', 'errorMessage' => 'Resource is being updated by a previous request. Current request is redundant.', 'description' => ''], ['errorCode' => 'Cluster.Conflict', 'errorMessage' => 'The cluster is being updated by a previous request. Please try again later.', 'description' => ''], ], 500 => [ ['errorCode' => 'ConfigWhitelistFailed.Error', 'errorMessage' => 'config white list error', 'description' => ''], ['errorCode' => 'ActionFailed.Error', 'errorMessage' => 'internal error, please try again', 'description' => ''], ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => 'Unknown error caused request processing to fail.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CreateCluster', 'summary' => 'Creates a cluster by designating an HSM instance as the master HSM.', 'description' => 'The HSM instance that you select to create the cluster must be in the Active state.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'yundun-hsm:CreateCluster', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5F58413E-8F57-585B-BE48-64CC1E31133C\\",\\n \\"ClusterId\\": \\"cluster-729dm40FG****\\"\\n}","type":"json"}]', ], 'DeleteCluster' => [ 'summary' => 'Deletes the specified cluster.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREhsmV7VE3Y', 'FEATUREhsm01FLNB', 'FEATUREhsmGIFYCG', 'FEATUREhsmLBBV5W'], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'formData', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'cluster-NZB9Oj5Yfd8Y****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'BaseResult', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID. Alibaba Cloud generates a unique ID for each request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '4C467B38-3910-447D-87BC-AC049166F216', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'SwitchMaster.InstanceInvalid', 'errorMessage' => 'Instance not in the cluster.', 'description' => ''], ['errorCode' => 'LeaveCluster.MasterLast', 'errorMessage' => 'Master instance can not leave a cluster until all other instances are left.', 'description' => ''], ['errorCode' => 'Certificate.ChainInvalid', 'errorMessage' => 'Certificate chain invalid. Please make sure issuer certificate is the trust anchor and cluster certificate is signed by issuer certificate.', 'description' => ''], ['errorCode' => 'Certificate.FormatInvalid', 'errorMessage' => 'Certificate format invalid. Cluster/Issuer certificate must be in PEM format.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.DuplicateZone', 'errorMessage' => 'VSwitches should not contain duplicate zones.', 'description' => ''], ['errorCode' => 'InvalidApiParam.Error', 'errorMessage' => 'api param is invalid', 'description' => ''], ['errorCode' => 'InvalidClusterName', 'errorMessage' => 'Invalid parameter clusterName.', 'description' => ''], ['errorCode' => 'InvalidPageSize', 'errorMessage' => 'Invalid parameter pageSize.', 'description' => ''], ['errorCode' => 'InvalidCurrentPage', 'errorMessage' => 'Invalid parameter currentPage.', 'description' => ''], ['errorCode' => 'InvalidRegionId', 'errorMessage' => 'Invalid parameter regionId.', 'description' => ''], ['errorCode' => 'InvalidVSwitch', 'errorMessage' => 'Invalid parameter vSwitch.', 'description' => ''], ['errorCode' => 'InvalidVpc', 'errorMessage' => 'Invalid parameter vpcId.', 'description' => ''], ['errorCode' => 'InvalidIp', 'errorMessage' => 'Invalid parameter IP.', 'description' => ''], ['errorCode' => 'InvalidAliuid', 'errorMessage' => 'Invalid parameter aliuid.', 'description' => ''], ['errorCode' => 'InvalidClusterId', 'errorMessage' => 'Invalid parameter clusterId.', 'description' => ''], ['errorCode' => 'InvalidInstanceId', 'errorMessage' => 'Invalid parameter instanceId.', 'description' => ''], ['errorCode' => 'InvalidBackupId', 'errorMessage' => 'Invalid parameter backupId.', 'description' => ''], ['errorCode' => 'InvalidImageId', 'errorMessage' => 'Invalid parameter imageId.', 'description' => ''], ['errorCode' => 'HsmInstanceNotExist.Error', 'errorMessage' => 'hsm instance not exist', 'description' => ''], ['errorCode' => 'HSMIntanceNotActived.Error', 'errorMessage' => 'hsm intance is not actived', 'description' => ''], ['errorCode' => 'WhiteListMaxCount.Error', 'errorMessage' => 'whilte list is more than max count', 'description' => ''], ['errorCode' => 'ClusterIdIsNotExists.Error', 'errorMessage' => 'cluster ID non-exists', 'description' => ''], ['errorCode' => 'InstanceListIsEmpty.Error', 'errorMessage' => 'instance list is empty', 'description' => ''], ['errorCode' => 'InstanceIdIsEmpty.Error', 'errorMessage' => 'instance id is empty', 'description' => ''], ['errorCode' => 'InstanceIsNotExistsInCluster.Error', 'errorMessage' => 'cluster has no such instance', 'description' => ''], ['errorCode' => 'InstanceIsExistsInCluster.Error', 'errorMessage' => 'instance already in the cluster', 'description' => ''], ['errorCode' => 'RegionNoEmpty.Error', 'errorMessage' => 'region no. is empty', 'description' => ''], ['errorCode' => 'ClusterNameEmpty.Error', 'errorMessage' => 'empty cluster name not allowed', 'description' => ''], ['errorCode' => 'ClusterNameIsExists.Error', 'errorMessage' => 'the cluster name is already taken', 'description' => ''], ['errorCode' => 'IpNotValid.Error', 'errorMessage' => 'ip not valid', 'description' => ''], ['errorCode' => 'ClusterIsEmpty.Error', 'errorMessage' => 'cluster is empty', 'description' => ''], ['errorCode' => 'NoMasterFoundInCluster.Error', 'errorMessage' => 'cluster has no master instance', 'description' => ''], ['errorCode' => 'HsmInstanceIdNotFound.Error', 'errorMessage' => 'no such instance', 'description' => ''], ['errorCode' => 'NoInstanceFoundInCluster.Error', 'errorMessage' => 'cluster is empty', 'description' => ''], ['errorCode' => 'Whitelist.Invalid', 'errorMessage' => 'Whitelist blocks not in CIDR format.', 'description' => ''], ['errorCode' => 'Whitelist.TooLong', 'errorMessage' => 'Whitelist too long, exceeds 10 CIDR blocks.', 'description' => ''], ], 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'Caller has no permission on the resource.', 'description' => ''], ['errorCode' => 'InstanceNotPaused', 'errorMessage' => 'Please pause the instance before reset.', 'description' => ''], ['errorCode' => 'InstanceNotActive', 'errorMessage' => 'Instance is not active.', 'description' => ''], ['errorCode' => 'ConfigIp.IncorrectState', 'errorMessage' => 'Instance not in pending or active state, can not config IP address.', 'description' => ''], ['errorCode' => 'SwitchMaster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'SyncCluster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'LeaveCluster.InstanceInvalid', 'errorMessage' => 'The instance is not in the cluster.', 'description' => ''], ['errorCode' => 'DeleteCluster.IncorrectState', 'errorMessage' => 'Cluster not empty, please remove all instances first.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceVSwitchNotInCluster', 'errorMessage' => 'Instance\'s vSwitch is not in cluster config, please change instance\'s vSwitch first.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceInitialized', 'errorMessage' => 'Initialized instance can not join a cluster.', 'description' => ''], ['errorCode' => 'JoinCluster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'InitializeCluster.InstanceNotInitialized', 'errorMessage' => 'Cluster master instance not initialized, please initialize cluster master instance first.', 'description' => ''], ['errorCode' => 'InitializeCluster.IncorrectConfig', 'errorMessage' => 'Cluster subnet not configured, please config cluster subnet first.', 'description' => ''], ['errorCode' => 'InitializeCluster.IncorrectState', 'errorMessage' => 'Cluster initialized, do not re-initialize.', 'description' => ''], ['errorCode' => 'Cluster.CN.ActionForbidden', 'errorMessage' => 'This API is forbidden for non-international site cluster.', 'description' => ''], ['errorCode' => 'Cluster.INTL.ActionForbidden', 'errorMessage' => 'This API is forbidden for international site cluster.', 'description' => ''], ['errorCode' => 'ConfigClusterCertificate.IncorrectState', 'errorMessage' => 'Cluster initialized or certificates already configured.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.InvalidVpcId', 'errorMessage' => 'VPC Id invalid. Cluster VPC is the same as cluster master\'s VPC.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.InvalidVSwitchId', 'errorMessage' => 'VSwitch Id invalid. VSwitches should contain all current cluster vSwitches.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.IncorrectState', 'errorMessage' => 'Cluster not in NEW state, can not config cluster subnet.', 'description' => ''], ['errorCode' => 'ClusterName.Exist', 'errorMessage' => 'Cluster name already exists, please use another name.', 'description' => ''], ['errorCode' => 'Whitelist.InstanceInCluster', 'errorMessage' => 'Whitelist.InstanceInCluster', 'description' => ''], ], [ ['errorCode' => 'Resource.NotFound', 'errorMessage' => 'Resource not found.', 'description' => ''], ], [ ['errorCode' => 'ClusterAPI.NotSupported', 'errorMessage' => 'ClusterAPI not supported in this region.', 'description' => ''], ], 409 => [ ['errorCode' => 'Conflict', 'errorMessage' => 'Resource is being updated by a previous request. Current request is redundant.', 'description' => ''], ['errorCode' => 'Cluster.Conflict', 'errorMessage' => 'The cluster is being updated by a previous request. Please try again later.', 'description' => ''], ], 500 => [ ['errorCode' => 'ConfigWhitelistFailed.Error', 'errorMessage' => 'config white list error', 'description' => ''], ['errorCode' => 'ActionFailed.Error', 'errorMessage' => 'internal error, please try again', 'description' => ''], ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => 'Unknown error caused request processing to fail.'], ], ], 'title' => 'DeleteCluster', 'description' => 'You can delete a cluster only if it contains no HSM instances.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'yundun-hsm:DeleteCluster', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C467B38-3910-447D-87BC-AC049166F216\\"\\n}","type":"json"}]', ], 'DescribeRegions' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '203661', 'abilityTreeNodes' => ['FEATUREhsmV7VE3Y'], ], 'parameters' => [ [ 'name' => 'AcceptLanguage', 'in' => 'query', 'schema' => [ 'description' => 'The language of the query results. Valid values:'."\n" ."\n" .'- zh: Chinese'."\n" .'- en: English.', 'enumValueTitles' => [], 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID. Alibaba Cloud generates a unique identifier for each request. You can use the request ID to troubleshoot issues.', 'type' => 'string', 'example' => '4C467B38-3910-447D-87BC-AC049166F216', 'title' => ''], 'Regions' => [ 'description' => 'The list of regions.', 'type' => 'array', 'items' => [ 'description' => 'The region information.', 'type' => 'object', 'properties' => [ 'LocalName' => ['description' => 'The region name.', 'type' => 'string', 'example' => 'China (Hangzhou)', 'title' => ''], 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'Zones' => [ 'description' => 'The list of zones.', 'type' => 'array', 'items' => [ 'description' => 'The zone information.', 'type' => 'object', 'properties' => [ 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-a', 'title' => ''], 'LocalName' => ['description' => 'The zone name.', 'type' => 'string', 'example' => 'Hangzhou Zone A', 'title' => ''], 'Cluster' => ['description' => 'Indicates whether clusters are supported. Valid values:'."\n" ."\n" .'- yes: Supported.'."\n" .'- no: Not supported.', 'type' => 'string', 'example' => 'yes', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidApiParam.Error', 'errorMessage' => 'api param is invalid', 'description' => ''], ], 403 => [ ['errorCode' => 'NoPermission.Error', 'errorMessage' => 'caller has no permission', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => 'Unknown error caused request processing to fail.'], ], ], 'title' => 'Query regions that support cloudHSM', 'summary' => 'Queries the regions that support Cloud Hardware Security Module (CloudHSM).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'yundun-hsm:DescribeRegions', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C467B38-3910-447D-87BC-AC049166F216\\",\\n \\"Regions\\": [\\n {\\n \\"LocalName\\": \\"China (Hangzhou)\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Zones\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-a\\",\\n \\"LocalName\\": \\"Hangzhou Zone A\\",\\n \\"Cluster\\": \\"yes\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', ], 'DownloadClusterManagedCert' => [ 'summary' => 'Download cluster managed certificate.', 'description' => 'Only certificate-managed clusters in China regions on the China site are supported.', 'path' => '/', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREhsmV7VE3Y', 'FEATUREhsm01FLNB'], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'cluster-001***hui'], ], ], 'responses' => [ 200 => [ 'description' => '成功响应', 'schema' => [ 'title' => '', 'description' => 'Response.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '4C467B38-3910-447D-87BC-AC049166F216', 'title' => ''], 'Content' => ['description' => 'A base64-encoded zip compressed file. Decode with base64 to obtain the original zip file content, then decompress the zip to obtain the certificate files.', 'type' => 'string', 'example' => 'emhlbmdza****W5qaWFuYmlhbm1hY2VzaGk=', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Cluster.ClusterManagedCertDownload.NotSupport', 'errorMessage' => 'download cluster managed cert not support.', 'description' => ''], ['errorCode' => 'Cluster.CertsManageNotFinished', 'errorMessage' => 'cluster certs manage not finished.', 'description' => ''], ], 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'caller has no permission', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => 'Unknown error caused request processing to fail.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Download Cluster Managed Certificate', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'yundun-hsm:DownloadClusterManagedCert', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C467B38-3910-447D-87BC-AC049166F216\\",\\n \\"Content\\": \\"emhlbmdza****W5qaWFuYmlhbm1hY2VzaGk=\\"\\n}","type":"json"}]', ], 'EnableBackup' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '203669', 'abilityTreeNodes' => ['FEATUREhsmQEGDGS'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the HSM instance.', 'type' => 'string', 'required' => true, 'example' => 'hsm-cn-mp90fxef****', 'title' => ''], ], [ 'name' => 'BackupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup.', 'type' => 'string', 'required' => true, 'example' => 'backup-1736207****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID. Alibaba Cloud generates a unique ID for each request. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '4C467B38-3910-447D-87BC-AC049166F216', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidApiParam.Error', 'errorMessage' => 'api param is invalid', 'description' => ''], ], 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'caller has no permission', 'description' => ''], ['errorCode' => 'Backup.ActionForbidden', 'errorMessage' => 'This API is forbidden for this backup type.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => 'Unknown error caused request processing to fail.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'EnableBackup', 'summary' => 'Enables backup for a specified instance.', 'description' => 'This operation is available for backup calls only in the Chinese mainland.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:EnableBackup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C467B38-3910-447D-87BC-AC049166F216\\"\\n}","type":"json"}]', ], 'ExportImage' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '203656', 'abilityTreeNodes' => ['FEATUREhsmV7VE3Y', 'FEATUREhsm01FLNB', 'FEATUREhsmGIFYCG', 'FEATUREhsmLBBV5W'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The Encryption Service instance ID.', 'type' => 'string', 'required' => true, 'example' => 'hsm-cn-vj30bil8****', 'title' => ''], ], [ 'name' => 'ImageId', 'in' => 'query', 'schema' => ['description' => 'The image ID.', 'type' => 'string', 'required' => true, 'example' => 'image-8vbdd5uc6v10ecn5****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response information.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID. Alibaba Cloud generates a unique identifier for each request. You can use the request ID to troubleshoot issues.', 'type' => 'string', 'example' => '4C467B38-3910-447D-87BC-AC049166F216'], 'Job' => [ 'description' => 'The asynchronous task information.', 'type' => 'object', 'properties' => [ 'JobId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'b1748ca6-6b55-49f4-a6d4-2d694a9f3693', 'title' => ''], 'Type' => ['description' => 'The task operation type. Valid values:'."\n" ."\n" .'- create: Create task.'."\n" ."\n" .'- cancel: Cancel task.', 'type' => 'string', 'example' => 'create', 'title' => ''], 'Completed' => ['description' => 'Indicates whether the task is completed. Valid values:'."\n" ."\n" .'- true: Completed.'."\n" ."\n" .'- false: Not completed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Status' => [ 'description' => 'The task status. Valid values:'."\n" .'- running: Running.'."\n" ."\n" .'- cancel: Canceled.'."\n" .'- fail: Failed. '."\n" .'- success: Succeeded.', 'enumValueTitles' => ['running' => 'Running.', 'cancel' => 'Canceled.', 'fail' => 'Failed.', 'success' => 'Succeeded.'], 'type' => 'string', 'enum' => ['running', 'success', 'fail', 'cancel'], 'example' => 'running', 'title' => '', ], 'Response' => ['description' => 'The response information returned after the operation succeeds.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Error' => ['description' => 'The error message returned when the operation is failed or a fault occurs.', 'type' => 'string', 'example' => 'Job.Canceled', 'title' => ''], 'Process' => ['description' => 'The task execution progress. Unit: percentage.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidApiParam.Error', 'errorMessage' => 'api param is invalid', 'description' => ''], ], 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'User has no permission to access this resource.', 'description' => ''], ['errorCode' => 'Backup.ActionForbidden', 'errorMessage' => 'This API is forbidden for this backup type.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => 'Unknown error caused request processing to fail.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Export image', 'summary' => 'Exports an image of a specified Encryption Service instance.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'yundun-hsm:ExportImage', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C467B38-3910-447D-87BC-AC049166F216\\",\\n \\"Job\\": {\\n \\"JobId\\": \\"b1748ca6-6b55-49f4-a6d4-2d694a9f3693\\",\\n \\"Type\\": \\"create\\",\\n \\"Completed\\": true,\\n \\"Status\\": \\"running\\",\\n \\"Response\\": \\"success\\",\\n \\"Error\\": \\"Job.Canceled\\",\\n \\"Process\\": 100\\n }\\n}","type":"json"}]', ], 'GetAuditLogStatus' => [ 'summary' => 'Queries the status of the audit log feature in the current region.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '203664', 'abilityTreeNodes' => ['FEATUREhsmVF2KT5'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the region.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'GetOssBucket', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to obtain the list of OSS buckets that can be used to store audit logs. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4C467B38-3910-447D-87BC-AC049166F216', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request is successful. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'RegionId' => ['description' => 'The ID of the region.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'AuditLogStatus' => [ 'description' => 'Indicates whether the audit log feature is enabled. Valid values:'."\n" ."\n" .'- enable'."\n" ."\n" .'- disable', 'enumValueTitles' => [], 'type' => 'string', 'enum' => ['enable', 'disable'], 'example' => 'enable', 'title' => '', ], 'GrantedServiceAccess' => ['description' => 'Indicates whether Cloud Hardware Security Module is authorized to deliver logs. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'AuditOssBucket' => ['description' => 'The bucket that stores audit logs.', 'type' => 'string', 'example' => 'bucket-test', 'title' => ''], 'OssBuckets' => [ 'description' => 'A list of buckets that can be used to store audit logs.', 'type' => 'array', 'items' => ['description' => 'The name of the bucket.', 'type' => 'string', 'example' => 'bucket-test', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'OSSPermissionDenied.Error', 'errorMessage' => '获取对应OSS bucket权限失败，请检查OSS权限设置: %s', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => 'Unknown error caused request processing to fail.'], ], ], 'title' => 'GetAuditLogStatus', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'yundun-hsm:GetAuditLogStatus', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C467B38-3910-447D-87BC-AC049166F216\\",\\n \\"Success\\": true,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"AuditLogStatus\\": \\"enable\\",\\n \\"GrantedServiceAccess\\": true,\\n \\"AuditOssBucket\\": \\"bucket-test\\",\\n \\"OssBuckets\\": [\\n \\"bucket-test\\"\\n ]\\n}","type":"json"}]', ], 'GetBackup' => [ 'summary' => 'Retrieves information about a specific backup.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '203668', 'abilityTreeNodes' => ['FEATUREhsmQEGDGS'], ], 'parameters' => [ [ 'name' => 'BackupId', 'in' => 'query', 'schema' => ['description' => 'The backup ID.', 'type' => 'string', 'required' => false, 'example' => 'backup-fdb897sdf****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request. This ID is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '4C467B38-3910-447D-87BC-AC049166F216', 'title' => ''], 'Backup' => [ 'description' => 'The backup information.', 'type' => 'object', 'properties' => [ 'BackupId' => ['description' => 'The backup ID.', 'type' => 'string', 'example' => 'backup-fdb897sdf****', 'title' => ''], 'CreateTime' => ['description' => 'The time when the backup was created. This is a UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1682417553781', 'title' => ''], 'ExpireTime' => ['description' => 'The time when the backup expires. This is a UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1682417553781', 'title' => ''], 'InstanceId' => ['description' => 'The ID of the HSM instance that is associated with the backup.', 'type' => 'string', 'example' => 'hsm-cn-5yd35431****', 'title' => ''], 'Name' => ['description' => 'The backup name.', 'type' => 'string', 'example' => 'backup-te****', 'title' => ''], 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'Remark' => ['description' => 'The backup remarks.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'Status' => [ 'description' => 'The backup status.'."\n" ."\n" .'- NEW: The backup is not enabled.'."\n" ."\n" .'- EXPIRED: The backup has expired.'."\n" ."\n" .'- ENABLED: The backup is enabled.', 'enumValueTitles' => [], 'type' => 'string', 'enum' => ['EXPIRED', 'ENABLED', 'NEW'], 'example' => 'NEW', 'title' => '', ], 'MaxImageCount' => ['description' => 'The maximum number of images.', 'type' => 'string', 'example' => '3', 'title' => ''], 'Type' => [ 'description' => 'The backup type.'."\n" ."\n" .'- DEFAULT: The default backup.'."\n" ."\n" .'- NORMAL: The normal backup.', 'enumValueTitles' => [], 'type' => 'string', 'enum' => ['DEFAULT', 'NORMAL'], 'example' => 'DEFAULT', 'title' => '', ], 'BackupPeriod' => ['description' => 'The automatic backup cycle in days.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], 'NextImageCreateTime' => ['description' => 'The time when the next image will be created. This is a UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1682417553781', 'title' => ''], 'BackupHourInDay' => ['description' => 'The backup time. This is an integer on the hour in a 24-hour format.', 'type' => 'string', 'example' => '10', 'title' => ''], 'SpInstanceId' => ['description' => 'The backup ID in the sales domain. This property is available only for backups of HSM instances in the Chinese mainland.', 'type' => 'string', 'example' => 'backup-fdb897sdfg53****', 'title' => ''], 'AutoImageCount' => ['description' => 'The number of automatic backup images.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'OwnerInstanceId' => ['description' => 'The ID of the HSM instance to which the backup belongs. This property is available only for backups of HSM instances outside the Chinese mainland and has the same value as InstanceId.', 'type' => 'string', 'example' => 'hsm-cn-huoahd****', 'title' => ''], 'ReleaseTime' => ['description' => 'The time when the backup was released. This is a UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1641275680000', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'caller has no permission', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'GetBackup', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'yundun-hsm:GetBackup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C467B38-3910-447D-87BC-AC049166F216\\",\\n \\"Backup\\": {\\n \\"BackupId\\": \\"backup-fdb897sdf****\\",\\n \\"CreateTime\\": 1682417553781,\\n \\"ExpireTime\\": 1682417553781,\\n \\"InstanceId\\": \\"hsm-cn-5yd35431****\\",\\n \\"Name\\": \\"backup-te****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Remark\\": \\"test\\",\\n \\"Status\\": \\"NEW\\",\\n \\"MaxImageCount\\": \\"3\\",\\n \\"Type\\": \\"DEFAULT\\",\\n \\"BackupPeriod\\": 3,\\n \\"NextImageCreateTime\\": 1682417553781,\\n \\"BackupHourInDay\\": \\"10\\",\\n \\"SpInstanceId\\": \\"backup-fdb897sdfg53****\\",\\n \\"AutoImageCount\\": 1,\\n \\"OwnerInstanceId\\": \\"hsm-cn-huoahd****\\",\\n \\"ReleaseTime\\": 1641275680000\\n }\\n}","type":"json"}]', ], 'GetCluster' => [ 'summary' => 'Queries information about a specified cluster.', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREhsmV7VE3Y', 'FEATUREhsm01FLNB', 'FEATUREhsmGIFYCG', 'FEATUREhsmLBBV5W'], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'formData', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'cluster-p94y1dud9ts****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'PlainResult', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID. Alibaba Cloud generates a unique identifier for each request. You can use the request ID to troubleshoot issues.', 'type' => 'string', 'example' => '4C467B38-3910-447D-87BC-AC049166F216', 'title' => ''], 'Cluster' => [ 'description' => 'The cluster information.', 'type' => 'object', 'properties' => [ 'ClusterId' => ['title' => '', 'description' => 'The cluster ID.', 'type' => 'string', 'example' => 'cluster-p94y1dud9ts****'], 'ClusterName' => ['description' => 'The cluster name.', 'type' => 'string', 'example' => 'cluster_polar_****', 'title' => ''], 'Status' => ['description' => 'The cluster status. Valid values:'."\n" ."\n" .'- NEW: not initialized'."\n" ."\n" .'- INITIALIZED: initialized'."\n" ."\n" .'- DELETED: deleted'."\n" ."\n" .'- SYNCHRONIZING: synchronizing'."\n" ."\n" .'- TO_DELETE: pending deletion.', 'type' => 'string', 'example' => 'NEW', 'title' => ''], 'CreateTime' => ['title' => '', 'description' => 'The time when the cluster was created, in milliseconds. The value is a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1641275680000'], 'RegionId' => ['title' => '', 'description' => 'The region ID of the cluster.', 'type' => 'string', 'example' => 'cn-hangzhou'], 'VpcId' => ['title' => '', 'description' => 'The ID of the VPC to which the cluster belongs.', 'type' => 'string', 'example' => 'vpc-8vbt0fjdm29hofvbo****'], 'Whitelist' => ['description' => 'The access whitelist of the cluster.', 'type' => 'string', 'example' => '130.176.XX.XX', 'title' => ''], 'Zones' => [ 'description' => 'The zones of the cluster.', 'type' => 'array', 'items' => [ 'description' => 'The zone.', 'type' => 'object', 'properties' => [ 'VSwitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-uf61s651p69bdgmki****', 'title' => ''], 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-j', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'DeviceType' => ['title' => '', 'description' => 'The device type.', 'type' => 'string', 'example' => 'jnta'], 'ClusterCsr' => ['title' => '', 'description' => 'The certificate signing request (CSR) file of the cluster.', 'type' => 'string', 'example' => '-----BEGIN CERTIFICATE REQUEST-----\\nMIIC5TCCAc0CAQAwgZ8xWTAJBgNVBAYTAlVTMAkGA1UECAwCQ0EwDQYDVQQKDAZD\\nYXZpdW0wDQYDVQQLDAZOM0ZJUFMwDgYDVQQHDAdTYW5Kb3NlMBMGA1UdEQwMMTk****'."\n" .'-----END CERTIFICATE REQUEST-----'], 'ClusterCertificate' => ['description' => 'The cluster certificate.', 'type' => 'string', 'example' => '-----BEGIN CERTIFICATE-----'."\n" .'MIIDfTCCAmWgAwIBAgIJAMRqQMr5if66MA0GCSqGSIb3DQEBCwUAMFUxCzAJBgNV'."\n" .'BAYTAmNuMQswCQYDVQQIDAJ6ajELMAkGA1UEBwwCaHoxFjAUBgNVBAoMDUFsaWJh'."\n" .'YmEgQ2xvdWQxFDA****'."\n" .'-----END CERTIFICATE-----', 'title' => ''], 'ClusterOwnerCertificate' => ['description' => 'The self-signed certificate of the cluster.', 'type' => 'string', 'example' => '----BEGIN CERTIFICATE-----'."\n" .'MIIDaTCCAlECAQEwDQYJKoZIhvcNAQELBQAwVTELMAkGA1UEBhMCY24xCzAJBgNV'."\n" .'BAgMAnpqMQswCQYDVQQHDAJoejEWMBQGA1UECgwNQWxpYmFiYSBDbG91ZDEUMBIG'."\n" .'A1UECwwLU2VjQ2xvdWRIc20wHhcNMjQwNzAzM****'."\n" .'-----END CERTIFICATE-----', 'title' => ''], 'Size' => ['title' => '', 'description' => 'The number of instances in the cluster.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], 'Instances' => [ 'description' => 'The instances in the cluster.', 'type' => 'array', 'items' => [ 'description' => 'The Encryption Service instance information.', 'type' => 'object', 'properties' => [ 'InstanceId' => ['title' => '', 'description' => 'The Encryption Service instance ID.', 'type' => 'string', 'example' => 'hsm-cn-g6z3v0uf****'], 'NodeId' => ['title' => '', 'description' => 'The node ID of the Encryption Service instance in the cluster.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'Master' => ['description' => 'Indicates whether the instance is the primary Encryption Service instance. Valid values:'."\n" ."\n" .'- true: The instance is the primary Encryption Service instance.'."\n" ."\n" .'- false: The instance is not the primary Encryption Service instance.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'ClusterMode' => ['description' => 'The cluster mode.'."\n" ."\n" .''."\n" ."\n" .'- 0: manual synchronization cluster'."\n" .'- 1: automatic synchronization cluster (Encryption Service cluster in the Chinese mainland)'."\n" .'- 2: automatic synchronization cluster (Encryption Service cluster outside the Chinese mainland)'."\n" ."\n" .''."\n" ."\n\n" .''."\n" .'2: automatic synchronization cluster'."\n" .'.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], 'EntityCertExpireTime' => ['description' => 'The expiration time of the managed certificate of the cluster, in milliseconds. The value is a UNIX timestamp.'."\n" .'This value is meaningful only when CertManaged is set to true.', 'type' => 'string', 'example' => '1641275680000', 'title' => ''], 'CertManaged' => ['description' => 'Indicates whether the cluster certificate is managed. Valid values:'."\n" ."\n" .'- true: The cluster certificate is managed.'."\n" ."\n" .'- false: The cluster certificate is not managed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'KmsInstanceId' => ['title' => '', 'type' => 'string', 'example' => 'kst-xxx', 'description' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'SwitchMaster.InstanceInvalid', 'errorMessage' => 'Instance not in the cluster.', 'description' => ''], ['errorCode' => 'LeaveCluster.MasterLast', 'errorMessage' => 'Master instance can not leave a cluster until all other instances are left.', 'description' => ''], ['errorCode' => 'Certificate.ChainInvalid', 'errorMessage' => 'Certificate chain invalid. Please make sure issuer certificate is the trust anchor and cluster certificate is signed by issuer certificate.', 'description' => ''], ['errorCode' => 'Certificate.FormatInvalid', 'errorMessage' => 'Certificate format invalid. Cluster/Issuer certificate must be in PEM format.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.DuplicateZone', 'errorMessage' => 'VSwitches should not contain duplicate zones.', 'description' => ''], ['errorCode' => 'InvalidApiParam.Error', 'errorMessage' => 'api param is invalid', 'description' => ''], ['errorCode' => 'InvalidClusterName', 'errorMessage' => 'Invalid parameter clusterName.', 'description' => ''], ['errorCode' => 'InvalidPageSize', 'errorMessage' => 'Invalid parameter pageSize.', 'description' => ''], ['errorCode' => 'InvalidCurrentPage', 'errorMessage' => 'Invalid parameter currentPage.', 'description' => ''], ['errorCode' => 'InvalidRegionId', 'errorMessage' => 'Invalid parameter regionId.', 'description' => ''], ['errorCode' => 'InvalidVSwitch', 'errorMessage' => 'Invalid parameter vSwitch.', 'description' => ''], ['errorCode' => 'InvalidVpc', 'errorMessage' => 'Invalid parameter vpcId.', 'description' => ''], ['errorCode' => 'InvalidIp', 'errorMessage' => 'Invalid parameter IP.', 'description' => ''], ['errorCode' => 'InvalidAliuid', 'errorMessage' => 'Invalid parameter aliuid.', 'description' => ''], ['errorCode' => 'InvalidClusterId', 'errorMessage' => 'Invalid parameter clusterId.', 'description' => ''], ['errorCode' => 'InvalidInstanceId', 'errorMessage' => 'Invalid parameter instanceId.', 'description' => ''], ['errorCode' => 'InvalidBackupId', 'errorMessage' => 'Invalid parameter backupId.', 'description' => ''], ['errorCode' => 'InvalidImageId', 'errorMessage' => 'Invalid parameter imageId.', 'description' => ''], ['errorCode' => 'HsmInstanceNotExist.Error', 'errorMessage' => 'hsm instance not exist', 'description' => ''], ['errorCode' => 'HSMIntanceNotActived.Error', 'errorMessage' => 'hsm intance is not actived', 'description' => ''], ['errorCode' => 'WhiteListMaxCount.Error', 'errorMessage' => 'whilte list is more than max count', 'description' => ''], ['errorCode' => 'ClusterIdIsNotExists.Error', 'errorMessage' => 'cluster ID non-exists', 'description' => ''], ['errorCode' => 'InstanceListIsEmpty.Error', 'errorMessage' => 'instance list is empty', 'description' => ''], ['errorCode' => 'InstanceIdIsEmpty.Error', 'errorMessage' => 'instance id is empty', 'description' => ''], ['errorCode' => 'InstanceIsNotExistsInCluster.Error', 'errorMessage' => 'cluster has no such instance', 'description' => ''], ['errorCode' => 'InstanceIsExistsInCluster.Error', 'errorMessage' => 'instance already in the cluster', 'description' => ''], ['errorCode' => 'RegionNoEmpty.Error', 'errorMessage' => 'region no. is empty', 'description' => ''], ['errorCode' => 'ClusterNameEmpty.Error', 'errorMessage' => 'empty cluster name not allowed', 'description' => ''], ['errorCode' => 'ClusterNameIsExists.Error', 'errorMessage' => 'the cluster name is already taken', 'description' => ''], ['errorCode' => 'IpNotValid.Error', 'errorMessage' => 'ip not valid', 'description' => ''], ['errorCode' => 'ClusterIsEmpty.Error', 'errorMessage' => 'cluster is empty', 'description' => ''], ['errorCode' => 'NoMasterFoundInCluster.Error', 'errorMessage' => 'cluster has no master instance', 'description' => ''], ['errorCode' => 'HsmInstanceIdNotFound.Error', 'errorMessage' => 'no such instance', 'description' => ''], ['errorCode' => 'NoInstanceFoundInCluster.Error', 'errorMessage' => 'cluster is empty', 'description' => ''], ['errorCode' => 'Whitelist.Invalid', 'errorMessage' => 'Whitelist blocks not in CIDR format.', 'description' => ''], ['errorCode' => 'Whitelist.TooLong', 'errorMessage' => 'Whitelist too long, exceeds 10 CIDR blocks.', 'description' => ''], ], 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'Caller has no permission on the resource.', 'description' => ''], ['errorCode' => 'InstanceNotPaused', 'errorMessage' => 'Please pause the instance before reset.', 'description' => ''], ['errorCode' => 'InstanceNotActive', 'errorMessage' => 'Instance is not active.', 'description' => ''], ['errorCode' => 'ConfigIp.IncorrectState', 'errorMessage' => 'Instance not in pending or active state, can not config IP address.', 'description' => ''], ['errorCode' => 'SwitchMaster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'SyncCluster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'LeaveCluster.InstanceInvalid', 'errorMessage' => 'The instance is not in the cluster.', 'description' => ''], ['errorCode' => 'DeleteCluster.IncorrectState', 'errorMessage' => 'Cluster not empty, please remove all instances first.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceVSwitchNotInCluster', 'errorMessage' => 'Instance\'s vSwitch is not in cluster config, please change instance\'s vSwitch first.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceInitialized', 'errorMessage' => 'Initialized instance can not join a cluster.', 'description' => ''], ['errorCode' => 'JoinCluster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'InitializeCluster.InstanceNotInitialized', 'errorMessage' => 'Cluster master instance not initialized, please initialize cluster master instance first.', 'description' => ''], ['errorCode' => 'InitializeCluster.IncorrectConfig', 'errorMessage' => 'Cluster subnet not configured, please config cluster subnet first.', 'description' => ''], ['errorCode' => 'InitializeCluster.IncorrectState', 'errorMessage' => 'Cluster initialized, do not re-initialize.', 'description' => ''], ['errorCode' => 'Cluster.CN.ActionForbidden', 'errorMessage' => 'This API is forbidden for non-international site cluster.', 'description' => ''], ['errorCode' => 'Cluster.INTL.ActionForbidden', 'errorMessage' => 'This API is forbidden for international site cluster.', 'description' => ''], ['errorCode' => 'ConfigClusterCertificate.IncorrectState', 'errorMessage' => 'Cluster initialized or certificates already configured.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.InvalidVpcId', 'errorMessage' => 'VPC Id invalid. Cluster VPC is the same as cluster master\'s VPC.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.InvalidVSwitchId', 'errorMessage' => 'VSwitch Id invalid. VSwitches should contain all current cluster vSwitches.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.IncorrectState', 'errorMessage' => 'Cluster not in NEW state, can not config cluster subnet.', 'description' => ''], ['errorCode' => 'ClusterName.Exist', 'errorMessage' => 'Cluster name already exists, please use another name.', 'description' => ''], ['errorCode' => 'Whitelist.InstanceInCluster', 'errorMessage' => 'Whitelist.InstanceInCluster', 'description' => ''], ], [ ['errorCode' => 'Resource.NotFound', 'errorMessage' => 'Resource not found.', 'description' => ''], ], [ ['errorCode' => 'ClusterAPI.NotSupported', 'errorMessage' => 'ClusterAPI not supported in this region.', 'description' => ''], ], 409 => [ ['errorCode' => 'Conflict', 'errorMessage' => 'Resource is being updated by a previous request. Current request is redundant.', 'description' => ''], ['errorCode' => 'Cluster.Conflict', 'errorMessage' => 'The cluster is being updated by a previous request. Please try again later.', 'description' => ''], ], 500 => [ ['errorCode' => 'ConfigWhitelistFailed.Error', 'errorMessage' => 'config white list error', 'description' => ''], ['errorCode' => 'ActionFailed.Error', 'errorMessage' => 'internal error, please try again', 'description' => ''], ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => 'Unknown error caused request processing to fail.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Query cluster information', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'yundun-hsm:GetCluster', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C467B38-3910-447D-87BC-AC049166F216\\",\\n \\"Cluster\\": {\\n \\"ClusterId\\": \\"cluster-p94y1dud9ts****\\",\\n \\"ClusterName\\": \\"cluster_polar_****\\",\\n \\"Status\\": \\"NEW\\",\\n \\"CreateTime\\": 1641275680000,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"VpcId\\": \\"vpc-8vbt0fjdm29hofvbo****\\",\\n \\"Whitelist\\": \\"130.176.XX.XX\\",\\n \\"Zones\\": [\\n {\\n \\"VSwitchId\\": \\"vsw-uf61s651p69bdgmki****\\",\\n \\"ZoneId\\": \\"cn-hangzhou-j\\"\\n }\\n ],\\n \\"DeviceType\\": \\"jnta\\",\\n \\"ClusterCsr\\": \\"-----BEGIN CERTIFICATE REQUEST-----\\\\\\\\nMIIC5TCCAc0CAQAwgZ8xWTAJBgNVBAYTAlVTMAkGA1UECAwCQ0EwDQYDVQQKDAZD\\\\\\\\nYXZpdW0wDQYDVQQLDAZOM0ZJUFMwDgYDVQQHDAdTYW5Kb3NlMBMGA1UdEQwMMTk****\\\\n-----END CERTIFICATE REQUEST-----\\",\\n \\"ClusterCertificate\\": \\"-----BEGIN CERTIFICATE-----\\\\nMIIDfTCCAmWgAwIBAgIJAMRqQMr5if66MA0GCSqGSIb3DQEBCwUAMFUxCzAJBgNV\\\\nBAYTAmNuMQswCQYDVQQIDAJ6ajELMAkGA1UEBwwCaHoxFjAUBgNVBAoMDUFsaWJh\\\\nYmEgQ2xvdWQxFDA****\\\\n-----END CERTIFICATE-----\\",\\n \\"ClusterOwnerCertificate\\": \\"----BEGIN CERTIFICATE-----\\\\nMIIDaTCCAlECAQEwDQYJKoZIhvcNAQELBQAwVTELMAkGA1UEBhMCY24xCzAJBgNV\\\\nBAgMAnpqMQswCQYDVQQHDAJoejEWMBQGA1UECgwNQWxpYmFiYSBDbG91ZDEUMBIG\\\\nA1UECwwLU2VjQ2xvdWRIc20wHhcNMjQwNzAzM****\\\\n-----END CERTIFICATE-----\\",\\n \\"Size\\": 2,\\n \\"Instances\\": [\\n {\\n \\"InstanceId\\": \\"hsm-cn-g6z3v0uf****\\",\\n \\"NodeId\\": 1,\\n \\"Master\\": true\\n }\\n ],\\n \\"ClusterMode\\": 2,\\n \\"EntityCertExpireTime\\": \\"1641275680000\\",\\n \\"CertManaged\\": true,\\n \\"KmsInstanceId\\": \\"kst-xxx\\"\\n }\\n}","type":"json"}]', ], 'GetImage' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '203665', 'abilityTreeNodes' => ['FEATUREhsmQEGDGS'], ], 'parameters' => [ [ 'name' => 'ImageId', 'in' => 'query', 'schema' => ['description' => 'The image ID.', 'type' => 'string', 'required' => true, 'example' => 'image-wz9c5ths5dfuwx47****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request. Alibaba Cloud generates a unique ID for each request. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '4C467B38-3910-447D-87BC-AC049166F216', 'title' => ''], 'Image' => [ 'description' => 'The information about the image.', 'type' => 'object', 'properties' => [ 'BackupId' => ['description' => 'The backup ID.', 'type' => 'string', 'example' => 'backup-1618017313', 'title' => ''], 'ExportTime' => ['description' => 'The time when the image was created. This is a UNIX timestamp that is accurate to the millisecond.', 'type' => 'integer', 'format' => 'int64', 'example' => '1786776567788', 'title' => ''], 'ImageId' => ['description' => 'The image ID.', 'type' => 'string', 'example' => 'image-wz9c5ths5dfuwx47****', 'title' => ''], 'InstanceId' => ['description' => 'The ID of the HSM instance.', 'type' => 'string', 'example' => 'hsm-cn-9lb32vll****', 'title' => ''], 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'Remark' => ['description' => 'The remarks of the backup.', 'type' => 'string', 'example' => 'hsm-test', 'title' => ''], 'Status' => [ 'description' => 'The status of the image.'."\n" ."\n" .'- NEW: The image is not enabled.'."\n" ."\n" .'- DELETED: The image is deleted.'."\n" ."\n" .'- CREATING: The image is being created.'."\n" ."\n" .'- NORMAL: The image is created.', 'enumValueTitles' => [], 'type' => 'string', 'enum' => ['CREATING', 'NEW', 'NORMAL', 'DELETED'], 'example' => 'NEW', 'title' => '', ], 'Mode' => [ 'description' => 'The image creation mode.'."\n" ."\n" .'- PERIODIC: The image is created automatically.'."\n" ."\n" .'- MANUAL: The image is created manually.', 'enumValueTitles' => [], 'type' => 'string', 'enum' => ['MANUAL', 'PERIODIC'], 'example' => 'MANUAL', 'title' => '', ], 'VsmDigest' => ['description' => 'The summary of the HSM instance.', 'type' => 'string', 'example' => '3kGeHnmQzXwSsfF0Jk9eJYhe2gP6An0/HlYIiZh1****', 'title' => ''], 'SourceImageUid' => ['description' => 'The source image ID.', 'type' => 'string', 'example' => 'image-kklhhhh****', 'title' => ''], 'SourceRegionId' => ['description' => 'The region ID of the source image.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], 'SourceBackupUid' => ['description' => 'The source backup ID.', 'type' => 'string', 'example' => 'backup-gfuiasdfa****', 'title' => ''], 'SourceInstanceId' => ['description' => 'The source instance ID.', 'type' => 'string', 'example' => 'hsm-wz9fnmvx190shfbk****', 'title' => ''], 'CopyTime' => ['description' => 'The time when the image was copied. This is a UNIX timestamp that is accurate to the millisecond.', 'type' => 'integer', 'format' => 'int64', 'example' => '1641275680000', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'caller has no permission', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'GetImage', 'summary' => 'Retrieves information about a specified image.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'yundun-hsm:GetImage', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C467B38-3910-447D-87BC-AC049166F216\\",\\n \\"Image\\": {\\n \\"BackupId\\": \\"backup-1618017313\\",\\n \\"ExportTime\\": 1786776567788,\\n \\"ImageId\\": \\"image-wz9c5ths5dfuwx47****\\",\\n \\"InstanceId\\": \\"hsm-cn-9lb32vll****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Remark\\": \\"hsm-test\\",\\n \\"Status\\": \\"NEW\\",\\n \\"Mode\\": \\"MANUAL\\",\\n \\"VsmDigest\\": \\"3kGeHnmQzXwSsfF0Jk9eJYhe2gP6An0/HlYIiZh1****\\",\\n \\"SourceImageUid\\": \\"image-kklhhhh****\\",\\n \\"SourceRegionId\\": \\"cn-beijing\\",\\n \\"SourceBackupUid\\": \\"backup-gfuiasdfa****\\",\\n \\"SourceInstanceId\\": \\"hsm-wz9fnmvx190shfbk****\\",\\n \\"CopyTime\\": 1641275680000\\n }\\n}","type":"json"}]', ], 'GetInstance' => [ 'summary' => 'Queries information about a specified instance.', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '209071', 'abilityTreeNodes' => ['FEATUREhsmV7VE3Y', 'FEATUREhsmUNBCOF', 'FEATUREhsm01FLNB', 'FEATUREhsmGIFYCG', 'FEATUREhsmLBBV5W'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The instance ID of the Encryption Service instance.', 'type' => 'string', 'example' => 'hsm-cn-vj30bil****', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'PlainResult', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID. Alibaba Cloud generates a unique identifier for each API request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '4C467B38-3910-447D-87BC-AC049166F216'], 'Instance' => [ 'title' => '', 'description' => 'The instance information.', 'type' => 'object', 'properties' => [ 'InstanceId' => ['title' => '', 'description' => 'The instance ID of the Encryption Service instance.', 'type' => 'string', 'example' => 'hsm-cn-g4t3jwsc****'], 'Remark' => ['title' => '', 'description' => 'The remarks.', 'type' => 'string', 'example' => 'hsmOnline'], 'RegionId' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou'], 'ZoneId' => ['title' => '', 'description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-b'], 'Vendor' => ['title' => '', 'description' => 'The vendor information.', 'type' => 'string', 'example' => 'jnta'], 'DeviceType' => ['title' => '', 'description' => 'The device type.', 'type' => 'string', 'example' => 'jnta.SJJ1528-G'], 'PqcEnabled' => [ 'title' => '', 'description' => 'Indicates whether the Post-Quantum Cryptography (PQC) feature is enabled for the instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'enum' => ['1', '0'], ], 'TpsEnabled' => [ 'description' => 'Indicates whether TPS monitoring is supported for the instance.', 'enumValueTitles' => ['Not supported.', 'Supported.'], 'type' => 'integer', 'format' => 'int32', 'enum' => ['0', '1'], 'example' => '1', 'title' => '', ], 'TenantIsolationType' => ['title' => '', 'description' => 'The hardware isolation type of the HSM. Valid values:'."\n" .'- vsm: virtual HSM.'."\n" .'- hostedHsm: hosted hardware HSM.', 'type' => 'string', 'example' => 'hostedHsm'], 'OrderId' => ['title' => '', 'description' => 'The order ID.', 'type' => 'string', 'example' => '23576634952****'], 'IsTrial' => ['title' => '', 'description' => 'Indicates whether the instance is a free trial instance. Valid values:'."\n" ."\n" .'- true: The instance is a free trial instance.'."\n" ."\n" .'- false: The instance is not a free trial instance.', 'type' => 'boolean', 'example' => 'false'], 'VpcId' => ['title' => '', 'description' => 'The ID of the VPC to which the instance belongs.', 'type' => 'string', 'example' => 'vpc-uf69i66j9kmoko52p****'], 'VSwitchId' => ['title' => '', 'description' => 'The ID of the vSwitch configured for the Encryption Service instance.', 'type' => 'string', 'example' => 'vsw-bp1mvfs31ltt0wyhf****'], 'Ip' => ['title' => '', 'description' => 'The IP address of the Encryption Service instance in the VPC.', 'type' => 'string', 'example' => '10.192.XX.XX'], 'Whitelist' => ['title' => '', 'description' => 'The IP whitelist.', 'type' => 'string', 'example' => '18.68.XX.XX'], 'CreateTime' => ['title' => '', 'description' => 'The time when the instance was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1699515963000'], 'ExpireTime' => ['title' => '', 'description' => 'The time when the instance expires.', 'type' => 'integer', 'format' => 'int64', 'example' => '1699496389720'], 'ClusterId' => ['title' => '', 'description' => 'The ID of the cluster to which the instance belongs.', 'type' => 'string', 'example' => 'cluster-w3G9vOJI2****'], 'ClusterName' => ['title' => '', 'description' => 'The cluster name.', 'type' => 'string', 'example' => 'cluster_online'], 'Master' => ['title' => '', 'description' => 'Indicates whether the instance is the primary HSM. Valid values: '."\n" ."\n" .'- true: The instance is the primary HSM.'."\n" ."\n" .'- false: The instance is a secondary HSM.', 'type' => 'boolean', 'example' => 'true'], 'Status' => ['title' => '', 'description' => 'The instance status. Valid values: '."\n" ."\n" .'- PENDING: Not activated.'."\n" ."\n" .'- ACTIVE: Activated.'."\n" ."\n" .'- EXPIRED: Expired.'."\n" ."\n" .'- INVALID: Invalidated.'."\n" ."\n" .'- FAILURE: Production failed.'."\n" ."\n" .'- RESET: Being reset.'."\n" ."\n" .'- PAUSED: Suspended.'."\n" ."\n" .'- MODIFYING: Being modified.', 'type' => 'string', 'example' => 'EXPIRED'], 'CertificationUrl' => ['description' => 'The download URL of the HSM qualification certificate.', 'type' => 'string', 'example' => 'https://xxxxxx', 'title' => ''], 'KmsInstanceId' => ['title' => '', 'type' => 'string', 'example' => 'kst-xxxxx', 'description' => ''], ], 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'SwitchMaster.InstanceInvalid', 'errorMessage' => 'Instance not in the cluster.', 'description' => ''], ['errorCode' => 'LeaveCluster.MasterLast', 'errorMessage' => 'Master instance can not leave a cluster until all other instances are left.', 'description' => ''], ['errorCode' => 'Certificate.ChainInvalid', 'errorMessage' => 'Certificate chain invalid. Please make sure issuer certificate is the trust anchor and cluster certificate is signed by issuer certificate.', 'description' => ''], ['errorCode' => 'Certificate.FormatInvalid', 'errorMessage' => 'Certificate format invalid. Cluster/Issuer certificate must be in PEM format.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.DuplicateZone', 'errorMessage' => 'VSwitches should not contain duplicate zones.', 'description' => ''], ['errorCode' => 'InvalidApiParam.Error', 'errorMessage' => 'api param is invalid', 'description' => ''], ['errorCode' => 'InvalidClusterName', 'errorMessage' => 'Invalid parameter clusterName.', 'description' => ''], ['errorCode' => 'InvalidPageSize', 'errorMessage' => 'Invalid parameter pageSize.', 'description' => ''], ['errorCode' => 'InvalidCurrentPage', 'errorMessage' => 'Invalid parameter currentPage.', 'description' => ''], ['errorCode' => 'InvalidRegionId', 'errorMessage' => 'Invalid parameter regionId.', 'description' => ''], ['errorCode' => 'InvalidVSwitch', 'errorMessage' => 'Invalid parameter vSwitch.', 'description' => ''], ['errorCode' => 'InvalidVpc', 'errorMessage' => 'Invalid parameter vpcId.', 'description' => ''], ['errorCode' => 'InvalidIp', 'errorMessage' => 'Invalid parameter IP.', 'description' => ''], ['errorCode' => 'InvalidAliuid', 'errorMessage' => 'Invalid parameter aliuid.', 'description' => ''], ['errorCode' => 'InvalidClusterId', 'errorMessage' => 'Invalid parameter clusterId.', 'description' => ''], ['errorCode' => 'InvalidInstanceId', 'errorMessage' => 'Invalid parameter instanceId.', 'description' => ''], ['errorCode' => 'InvalidBackupId', 'errorMessage' => 'Invalid parameter backupId.', 'description' => ''], ['errorCode' => 'InvalidImageId', 'errorMessage' => 'Invalid parameter imageId.', 'description' => ''], ['errorCode' => 'HsmInstanceNotExist.Error', 'errorMessage' => 'hsm instance not exist', 'description' => ''], ['errorCode' => 'HSMIntanceNotActived.Error', 'errorMessage' => 'hsm intance is not actived', 'description' => ''], ['errorCode' => 'WhiteListMaxCount.Error', 'errorMessage' => 'whilte list is more than max count', 'description' => ''], ['errorCode' => 'ClusterIdIsNotExists.Error', 'errorMessage' => 'cluster ID non-exists', 'description' => ''], ['errorCode' => 'InstanceListIsEmpty.Error', 'errorMessage' => 'instance list is empty', 'description' => ''], ['errorCode' => 'InstanceIdIsEmpty.Error', 'errorMessage' => 'instance id is empty', 'description' => ''], ['errorCode' => 'InstanceIsNotExistsInCluster.Error', 'errorMessage' => 'cluster has no such instance', 'description' => ''], ['errorCode' => 'InstanceIsExistsInCluster.Error', 'errorMessage' => 'instance already in the cluster', 'description' => ''], ['errorCode' => 'RegionNoEmpty.Error', 'errorMessage' => 'region no. is empty', 'description' => ''], ['errorCode' => 'ClusterNameEmpty.Error', 'errorMessage' => 'empty cluster name not allowed', 'description' => ''], ['errorCode' => 'ClusterNameIsExists.Error', 'errorMessage' => 'the cluster name is already taken', 'description' => ''], ['errorCode' => 'IpNotValid.Error', 'errorMessage' => 'ip not valid', 'description' => ''], ['errorCode' => 'ClusterIsEmpty.Error', 'errorMessage' => 'cluster is empty', 'description' => ''], ['errorCode' => 'NoMasterFoundInCluster.Error', 'errorMessage' => 'cluster has no master instance', 'description' => ''], ['errorCode' => 'HsmInstanceIdNotFound.Error', 'errorMessage' => 'no such instance', 'description' => ''], ['errorCode' => 'NoInstanceFoundInCluster.Error', 'errorMessage' => 'cluster is empty', 'description' => ''], ['errorCode' => 'Whitelist.Invalid', 'errorMessage' => 'Whitelist blocks not in CIDR format.', 'description' => ''], ['errorCode' => 'Whitelist.TooLong', 'errorMessage' => 'Whitelist too long, exceeds 10 CIDR blocks.', 'description' => ''], ], 403 => [ ['errorCode' => 'Forbidden.InstanceInCluster', 'errorMessage' => 'This API is forbidden for instances in cluster.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceIncorrectState', 'errorMessage' => 'Instance not in Active/Pending state.', 'description' => ''], ['errorCode' => 'NoPermission', 'errorMessage' => 'Caller has no permission on the resource.', 'description' => ''], ['errorCode' => 'InstanceNotPaused', 'errorMessage' => 'Please pause the instance before reset.', 'description' => ''], ['errorCode' => 'InstanceNotActive', 'errorMessage' => 'Instance is not active.', 'description' => ''], ['errorCode' => 'ConfigIp.IncorrectState', 'errorMessage' => 'Instance not in pending or active state, can not config IP address.', 'description' => ''], ['errorCode' => 'SwitchMaster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'SyncCluster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'LeaveCluster.InstanceInvalid', 'errorMessage' => 'The instance is not in the cluster.', 'description' => ''], ['errorCode' => 'DeleteCluster.IncorrectState', 'errorMessage' => 'Cluster not empty, please remove all instances first.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceVSwitchNotInCluster', 'errorMessage' => 'Instance\'s vSwitch is not in cluster config, please change instance\'s vSwitch first.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceInitialized', 'errorMessage' => 'Initialized instance can not join a cluster.', 'description' => ''], ['errorCode' => 'JoinCluster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'InitializeCluster.InstanceNotInitialized', 'errorMessage' => 'Cluster master instance not initialized, please initialize cluster master instance first.', 'description' => ''], ['errorCode' => 'InitializeCluster.IncorrectConfig', 'errorMessage' => 'Cluster subnet not configured, please config cluster subnet first.', 'description' => ''], ['errorCode' => 'InitializeCluster.IncorrectState', 'errorMessage' => 'Cluster initialized, do not re-initialize.', 'description' => ''], ['errorCode' => 'Cluster.CN.ActionForbidden', 'errorMessage' => 'This API is forbidden for non-international site cluster.', 'description' => ''], ['errorCode' => 'Cluster.INTL.ActionForbidden', 'errorMessage' => 'This API is forbidden for international site cluster.', 'description' => ''], ['errorCode' => 'ConfigClusterCertificate.IncorrectState', 'errorMessage' => 'Cluster initialized or certificates already configured.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.InvalidVpcId', 'errorMessage' => 'VPC Id invalid. Cluster VPC is the same as cluster master\'s VPC.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.InvalidVSwitchId', 'errorMessage' => 'VSwitch Id invalid. VSwitches should contain all current cluster vSwitches.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.IncorrectState', 'errorMessage' => 'Cluster not in NEW state, can not config cluster subnet.', 'description' => ''], ['errorCode' => 'ClusterName.Exist', 'errorMessage' => 'Cluster name already exists, please use another name.', 'description' => ''], ], [ ['errorCode' => 'Resource.NotFound', 'errorMessage' => 'Resource not found.', 'description' => ''], ], [ ['errorCode' => 'ClusterAPI.NotSupported', 'errorMessage' => 'ClusterAPI not supported in this region.', 'description' => ''], ], 409 => [ ['errorCode' => 'Conflict.InstanceModifying', 'errorMessage' => 'Instance is being modified by a previous request. Please try again later.', 'description' => ''], ['errorCode' => 'Conflict', 'errorMessage' => 'Resource is being updated by a previous request. Current request is redundant.', 'description' => ''], ['errorCode' => 'Cluster.Conflict', 'errorMessage' => 'The cluster is being updated by a previous request. Please try again later.', 'description' => ''], ], 500 => [ ['errorCode' => 'ConfigWhitelistFailed.Error', 'errorMessage' => 'config white list error', 'description' => ''], ['errorCode' => 'ActionFailed.Error', 'errorMessage' => 'internal error, please try again', 'description' => ''], ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => 'Unknown error caused request processing to fail.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'Query instance information', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'yundun-hsm:GetInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C467B38-3910-447D-87BC-AC049166F216\\",\\n \\"Instance\\": {\\n \\"InstanceId\\": \\"hsm-cn-g4t3jwsc****\\",\\n \\"Remark\\": \\"hsmOnline\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ZoneId\\": \\"cn-hangzhou-b\\",\\n \\"Vendor\\": \\"jnta\\",\\n \\"DeviceType\\": \\"jnta.SJJ1528-G\\",\\n \\"PqcEnabled\\": 1,\\n \\"TpsEnabled\\": 1,\\n \\"TenantIsolationType\\": \\"hostedHsm\\",\\n \\"OrderId\\": \\"23576634952****\\",\\n \\"IsTrial\\": false,\\n \\"VpcId\\": \\"vpc-uf69i66j9kmoko52p****\\",\\n \\"VSwitchId\\": \\"vsw-bp1mvfs31ltt0wyhf****\\",\\n \\"Ip\\": \\"10.192.XX.XX\\",\\n \\"Whitelist\\": \\"18.68.XX.XX\\",\\n \\"CreateTime\\": 1699515963000,\\n \\"ExpireTime\\": 1699496389720,\\n \\"ClusterId\\": \\"cluster-w3G9vOJI2****\\",\\n \\"ClusterName\\": \\"cluster_online\\",\\n \\"Master\\": true,\\n \\"Status\\": \\"EXPIRED\\",\\n \\"CertificationUrl\\": \\"https://xxxxxx\\",\\n \\"KmsInstanceId\\": \\"kst-xxxxx\\"\\n }\\n}","type":"json"}]', ], 'GetJob' => [ 'summary' => 'Retrieves the details of an asynchronous task.', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '201995', 'abilityTreeNodes' => ['FEATUREhsm01FLNB', 'FEATUREhsmV7VE3Y', 'FEATUREhsmGIFYCG'], ], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The ID of the task.', 'type' => 'string', 'required' => true, 'example' => 'job-202401250936hze747fd7e0007005', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '4C467B38-3910-447D-87BC-AC049166F216'], 'Job' => [ 'description' => 'The details of the task.', 'type' => 'object', 'properties' => [ 'JobId' => ['description' => 'The ID of the task.', 'type' => 'string', 'example' => 'job-202401250936hze747fd7e0007005', 'title' => ''], 'Type' => ['description' => 'The operation type. Valid values:'."\n" ."\n" .'- create'."\n" ."\n" .'- cancel', 'type' => 'string', 'example' => 'create', 'title' => ''], 'Completed' => ['description' => 'Indicates whether the task is complete. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Status' => ['description' => 'The task status. Valid values:'."\n" ."\n" .'- success'."\n" ."\n" .'- running'."\n" ."\n" .'- fail'."\n" ."\n" .'- cancel', 'type' => 'string', 'example' => 'fail', 'title' => ''], 'Response' => ['description' => 'The response returned after the task succeeds.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Error' => ['description' => 'The error message returned if the task fails.', 'type' => 'string', 'example' => 'OperationTimeout', 'title' => ''], 'Progress' => ['description' => 'The progress of the task. Unit: percent (%).', 'type' => 'integer', 'format' => 'int64', 'example' => '95', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'GetJob', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'yundun-hsm:GetJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C467B38-3910-447D-87BC-AC049166F216\\",\\n \\"Job\\": {\\n \\"JobId\\": \\"job-202401250936hze747fd7e0007005\\",\\n \\"Type\\": \\"create\\",\\n \\"Completed\\": true,\\n \\"Status\\": \\"fail\\",\\n \\"Response\\": \\"success\\",\\n \\"Error\\": \\"OperationTimeout\\",\\n \\"Progress\\": 95\\n }\\n}","type":"json"}]', ], 'InitializeAuditLog' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREhsmVF2KT5'], ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request. The ID is a unique identifier that Alibaba Cloud generates for the request. You can use the ID to troubleshoot issues.', 'type' => 'string', 'example' => '4FE969D9-E1C7-5274-BE7D-8C3534587605', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'CreateServiceLinkedRole.Error %s', 'errorMessage' => 'sdfsfa %s', 'description' => ''], ], 404 => [ ['errorCode' => 'EntityNotExist.Service', 'errorMessage' => '服务不存在: %s', 'description' => ''], ['errorCode' => 'EntityNotExist.User', 'errorMessage' => '角色不存在: %s', 'description' => ''], ['errorCode' => 'NoPermission.Client', 'errorMessage' => '当前账户无创建服务角色权限！', 'description' => ''], ], 409 => [ ['errorCode' => 'EntityAlreadyExists.Role', 'errorMessage' => '服务角色已存在，请勿重复创建！', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => 'Unknown error caused request processing to fail.'], ], ], 'title' => 'Initialize audit logging', 'summary' => 'Authorizes the Encryption Service instance to deliver logs.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:InitializeAuditLog', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4FE969D9-E1C7-5274-BE7D-8C3534587605\\"\\n}","type":"json"}]', ], 'InitializeCluster' => [ 'summary' => 'Initializes a cluster.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREhsmV7VE3Y', 'FEATUREhsm01FLNB', 'FEATUREhsmGIFYCG', 'FEATUREhsmLBBV5W'], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the cluster.', 'type' => 'string', 'required' => true, 'example' => 'cluster-p94y1dud9****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'BaseResult', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4C467B38-3910-447D-87BC-AC049366F216', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'SwitchMaster.InstanceInvalid', 'errorMessage' => 'Instance not in the cluster.', 'description' => ''], ['errorCode' => 'LeaveCluster.MasterLast', 'errorMessage' => 'Master instance can not leave a cluster until all other instances are left.', 'description' => ''], ['errorCode' => 'Certificate.ChainInvalid', 'errorMessage' => 'Certificate chain invalid. Please make sure issuer certificate is the trust anchor and cluster certificate is signed by issuer certificate.', 'description' => ''], ['errorCode' => 'Certificate.FormatInvalid', 'errorMessage' => 'Certificate format invalid. Cluster/Issuer certificate must be in PEM format.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.DuplicateZone', 'errorMessage' => 'VSwitches should not contain duplicate zones.', 'description' => ''], ['errorCode' => 'InvalidApiParam.Error', 'errorMessage' => 'api param is invalid', 'description' => ''], ['errorCode' => 'InvalidClusterName', 'errorMessage' => 'Invalid parameter clusterName.', 'description' => ''], ['errorCode' => 'InvalidPageSize', 'errorMessage' => 'Invalid parameter pageSize.', 'description' => ''], ['errorCode' => 'InvalidCurrentPage', 'errorMessage' => 'Invalid parameter currentPage.', 'description' => ''], ['errorCode' => 'InvalidRegionId', 'errorMessage' => 'Invalid parameter regionId.', 'description' => ''], ['errorCode' => 'InvalidVSwitch', 'errorMessage' => 'Invalid parameter vSwitch.', 'description' => ''], ['errorCode' => 'InvalidVpc', 'errorMessage' => 'Invalid parameter vpcId.', 'description' => ''], ['errorCode' => 'InvalidIp', 'errorMessage' => 'Invalid parameter IP.', 'description' => ''], ['errorCode' => 'InvalidAliuid', 'errorMessage' => 'Invalid parameter aliuid.', 'description' => ''], ['errorCode' => 'InvalidClusterId', 'errorMessage' => 'Invalid parameter clusterId.', 'description' => ''], ['errorCode' => 'InvalidInstanceId', 'errorMessage' => 'Invalid parameter instanceId.', 'description' => ''], ['errorCode' => 'InvalidBackupId', 'errorMessage' => 'Invalid parameter backupId.', 'description' => ''], ['errorCode' => 'InvalidImageId', 'errorMessage' => 'Invalid parameter imageId.', 'description' => ''], ['errorCode' => 'HsmInstanceNotExist.Error', 'errorMessage' => 'hsm instance not exist', 'description' => ''], ['errorCode' => 'HSMIntanceNotActived.Error', 'errorMessage' => 'hsm intance is not actived', 'description' => ''], ['errorCode' => 'WhiteListMaxCount.Error', 'errorMessage' => 'whilte list is more than max count', 'description' => ''], ['errorCode' => 'ClusterIdIsNotExists.Error', 'errorMessage' => 'cluster ID non-exists', 'description' => ''], ['errorCode' => 'InstanceListIsEmpty.Error', 'errorMessage' => 'instance list is empty', 'description' => ''], ['errorCode' => 'InstanceIdIsEmpty.Error', 'errorMessage' => 'instance id is empty', 'description' => ''], ['errorCode' => 'InstanceIsNotExistsInCluster.Error', 'errorMessage' => 'cluster has no such instance', 'description' => ''], ['errorCode' => 'InstanceIsExistsInCluster.Error', 'errorMessage' => 'instance already in the cluster', 'description' => ''], ['errorCode' => 'RegionNoEmpty.Error', 'errorMessage' => 'region no. is empty', 'description' => ''], ['errorCode' => 'ClusterNameEmpty.Error', 'errorMessage' => 'empty cluster name not allowed', 'description' => ''], ['errorCode' => 'ClusterNameIsExists.Error', 'errorMessage' => 'the cluster name is already taken', 'description' => ''], ['errorCode' => 'IpNotValid.Error', 'errorMessage' => 'ip not valid', 'description' => ''], ['errorCode' => 'ClusterIsEmpty.Error', 'errorMessage' => 'cluster is empty', 'description' => ''], ['errorCode' => 'NoMasterFoundInCluster.Error', 'errorMessage' => 'cluster has no master instance', 'description' => ''], ['errorCode' => 'HsmInstanceIdNotFound.Error', 'errorMessage' => 'no such instance', 'description' => ''], ['errorCode' => 'NoInstanceFoundInCluster.Error', 'errorMessage' => 'cluster is empty', 'description' => ''], ['errorCode' => 'Whitelist.Invalid', 'errorMessage' => 'Whitelist blocks not in CIDR format.', 'description' => ''], ['errorCode' => 'Whitelist.TooLong', 'errorMessage' => 'Whitelist too long, exceeds 10 CIDR blocks.', 'description' => ''], ], 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'Caller has no permission on the resource.', 'description' => ''], ['errorCode' => 'InstanceNotPaused', 'errorMessage' => 'Please pause the instance before reset.', 'description' => ''], ['errorCode' => 'InstanceNotActive', 'errorMessage' => 'Instance is not active.', 'description' => ''], ['errorCode' => 'ConfigIp.IncorrectState', 'errorMessage' => 'Instance not in pending or active state, can not config IP address.', 'description' => ''], ['errorCode' => 'SwitchMaster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'SyncCluster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'LeaveCluster.InstanceInvalid', 'errorMessage' => 'The instance is not in the cluster.', 'description' => ''], ['errorCode' => 'DeleteCluster.IncorrectState', 'errorMessage' => 'Cluster not empty, please remove all instances first.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceVSwitchNotInCluster', 'errorMessage' => 'Instance\'s vSwitch is not in cluster config, please change instance\'s vSwitch first.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceInitialized', 'errorMessage' => 'Initialized instance can not join a cluster.', 'description' => ''], ['errorCode' => 'JoinCluster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'InitializeCluster.InstanceNotInitialized', 'errorMessage' => 'Cluster master instance not initialized, please initialize cluster master instance first.', 'description' => ''], ['errorCode' => 'InitializeCluster.IncorrectConfig', 'errorMessage' => 'Cluster subnet not configured, please config cluster subnet first.', 'description' => ''], ['errorCode' => 'InitializeCluster.IncorrectState', 'errorMessage' => 'Cluster initialized, do not re-initialize.', 'description' => ''], ['errorCode' => 'Cluster.CN.ActionForbidden', 'errorMessage' => 'This API is forbidden for non-international site cluster.', 'description' => ''], ['errorCode' => 'Cluster.INTL.ActionForbidden', 'errorMessage' => 'This API is forbidden for international site cluster.', 'description' => ''], ['errorCode' => 'ConfigClusterCertificate.IncorrectState', 'errorMessage' => 'Cluster initialized or certificates already configured.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.InvalidVpcId', 'errorMessage' => 'VPC Id invalid. Cluster VPC is the same as cluster master\'s VPC.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.InvalidVSwitchId', 'errorMessage' => 'VSwitch Id invalid. VSwitches should contain all current cluster vSwitches.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.IncorrectState', 'errorMessage' => 'Cluster not in NEW state, can not config cluster subnet.', 'description' => ''], ['errorCode' => 'ClusterName.Exist', 'errorMessage' => 'Cluster name already exists, please use another name.', 'description' => ''], ['errorCode' => 'Whitelist.InstanceInCluster', 'errorMessage' => 'Whitelist.InstanceInCluster', 'description' => ''], ], [ ['errorCode' => 'Resource.NotFound', 'errorMessage' => 'Resource not found.', 'description' => ''], ], [ ['errorCode' => 'ClusterAPI.NotSupported', 'errorMessage' => 'ClusterAPI not supported in this region.', 'description' => ''], ], 409 => [ ['errorCode' => 'Conflict', 'errorMessage' => 'Resource is being updated by a previous request. Current request is redundant.', 'description' => ''], ['errorCode' => 'Cluster.Conflict', 'errorMessage' => 'The cluster is being updated by a previous request. Please try again later.', 'description' => ''], ], 500 => [ ['errorCode' => 'ConfigWhitelistFailed.Error', 'errorMessage' => 'config white list error', 'description' => ''], ['errorCode' => 'ActionFailed.Error', 'errorMessage' => 'internal error, please try again', 'description' => ''], ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => 'Unknown error caused request processing to fail.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'InitializeCluster', 'description' => '- The cluster is not initialized, but the master hardware security module (HSM) of the cluster is initialized.'."\n" ."\n" .'- Two or more vSwitches are configured for the cluster.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:InitializeCluster', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C467B38-3910-447D-87BC-AC049366F216\\"\\n}","type":"json"}]', ], 'JoinCluster' => [ 'summary' => 'Add an HSM instance outside the cluster to the current cluster.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREhsmV7VE3Y', 'FEATUREhsm01FLNB', 'FEATUREhsmGIFYCG', 'FEATUREhsmLBBV5W'], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'cluster-NZB9Oj5Yfd8Y****'], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The ID of the HSM instance to be added to the cluster.', 'type' => 'string', 'required' => true, 'example' => 'hsm-cn-vj30bil8****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'PlainResult', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID, which is a unique identifier generated by Alibaba Cloud for the request. It can be used for troubleshooting.', 'type' => 'string', 'example' => '4C467B38-3910-447D-87BC-AC049166F216'], 'Job' => [ 'description' => 'Job details.', 'type' => 'object', 'properties' => [ 'JobId' => ['title' => '', 'description' => 'Job ID.', 'type' => 'string', 'example' => 'job-202401250936hze747fd7e0007005'], 'Type' => ['title' => '', 'description' => 'Operation type.'."\n" ."\n" .'- create: Create a job.'."\n" ."\n" .'- cancel: Cancel a job.', 'type' => 'string', 'example' => 'create'], 'Completed' => ['title' => '', 'description' => 'Indicates whether the job is completed.'."\n" ."\n" .'- true: Yes.'."\n" ."\n" .'- false: No.', 'type' => 'boolean', 'example' => 'true'], 'CreateTime' => ['title' => '', 'description' => 'The time when the job was created, accurate to milliseconds. Timestamp format.', 'type' => 'string', 'example' => '1711764127000'], 'Status' => ['title' => '', 'description' => 'Job status.'."\n" ."\n" .'- success: The job succeeded.'."\n" ."\n" .'- running: The job is in progress.'."\n" ."\n" .'- cancel: The job is canceled.'."\n" ."\n" .'- fail: The job failed.', 'type' => 'string', 'example' => 'running'], 'Response' => ['title' => '', 'description' => 'The response information returned after the job succeeds.', 'type' => 'string', 'example' => 'success'], 'Error' => ['title' => '', 'description' => 'The error message returned when the job fails.', 'type' => 'string', 'example' => 'OperationTimeout'], 'Progress' => ['title' => '', 'description' => 'The job execution progress. Unit: percentage.', 'type' => 'integer', 'format' => 'int32', 'example' => '86'], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'SwitchMaster.InstanceInvalid', 'errorMessage' => 'Instance not in the cluster.', 'description' => ''], ['errorCode' => 'LeaveCluster.MasterLast', 'errorMessage' => 'Master instance can not leave a cluster until all other instances are left.', 'description' => ''], ['errorCode' => 'Certificate.ChainInvalid', 'errorMessage' => 'Certificate chain invalid. Please make sure issuer certificate is the trust anchor and cluster certificate is signed by issuer certificate.', 'description' => ''], ['errorCode' => 'Certificate.FormatInvalid', 'errorMessage' => 'Certificate format invalid. Cluster/Issuer certificate must be in PEM format.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.DuplicateZone', 'errorMessage' => 'VSwitches should not contain duplicate zones.', 'description' => ''], ['errorCode' => 'InvalidApiParam.Error', 'errorMessage' => 'api param is invalid', 'description' => ''], ['errorCode' => 'InvalidClusterName', 'errorMessage' => 'Invalid parameter clusterName.', 'description' => ''], ['errorCode' => 'InvalidPageSize', 'errorMessage' => 'Invalid parameter pageSize.', 'description' => ''], ['errorCode' => 'InvalidCurrentPage', 'errorMessage' => 'Invalid parameter currentPage.', 'description' => ''], ['errorCode' => 'InvalidRegionId', 'errorMessage' => 'Invalid parameter regionId.', 'description' => ''], ['errorCode' => 'InvalidVSwitch', 'errorMessage' => 'Invalid parameter vSwitch.', 'description' => ''], ['errorCode' => 'InvalidVpc', 'errorMessage' => 'Invalid parameter vpcId.', 'description' => ''], ['errorCode' => 'InvalidIp', 'errorMessage' => 'Invalid parameter IP.', 'description' => ''], ['errorCode' => 'InvalidAliuid', 'errorMessage' => 'Invalid parameter aliuid.', 'description' => ''], ['errorCode' => 'InvalidClusterId', 'errorMessage' => 'Invalid parameter clusterId.', 'description' => ''], ['errorCode' => 'InvalidInstanceId', 'errorMessage' => 'Invalid parameter instanceId.', 'description' => ''], ['errorCode' => 'InvalidBackupId', 'errorMessage' => 'Invalid parameter backupId.', 'description' => ''], ['errorCode' => 'InvalidImageId', 'errorMessage' => 'Invalid parameter imageId.', 'description' => ''], ['errorCode' => 'HsmInstanceNotExist.Error', 'errorMessage' => 'hsm instance not exist', 'description' => ''], ['errorCode' => 'HSMIntanceNotActived.Error', 'errorMessage' => 'hsm intance is not actived', 'description' => ''], ['errorCode' => 'WhiteListMaxCount.Error', 'errorMessage' => 'whilte list is more than max count', 'description' => ''], ['errorCode' => 'ClusterIdIsNotExists.Error', 'errorMessage' => 'cluster ID non-exists', 'description' => ''], ['errorCode' => 'InstanceListIsEmpty.Error', 'errorMessage' => 'instance list is empty', 'description' => ''], ['errorCode' => 'InstanceIdIsEmpty.Error', 'errorMessage' => 'instance id is empty', 'description' => ''], ['errorCode' => 'InstanceIsNotExistsInCluster.Error', 'errorMessage' => 'cluster has no such instance', 'description' => ''], ['errorCode' => 'InstanceIsExistsInCluster.Error', 'errorMessage' => 'instance already in the cluster', 'description' => ''], ['errorCode' => 'RegionNoEmpty.Error', 'errorMessage' => 'region no. is empty', 'description' => ''], ['errorCode' => 'ClusterNameEmpty.Error', 'errorMessage' => 'empty cluster name not allowed', 'description' => ''], ['errorCode' => 'ClusterNameIsExists.Error', 'errorMessage' => 'the cluster name is already taken', 'description' => ''], ['errorCode' => 'IpNotValid.Error', 'errorMessage' => 'ip not valid', 'description' => ''], ['errorCode' => 'ClusterIsEmpty.Error', 'errorMessage' => 'cluster is empty', 'description' => ''], ['errorCode' => 'NoMasterFoundInCluster.Error', 'errorMessage' => 'cluster has no master instance', 'description' => ''], ['errorCode' => 'HsmInstanceIdNotFound.Error', 'errorMessage' => 'no such instance', 'description' => ''], ['errorCode' => 'NoInstanceFoundInCluster.Error', 'errorMessage' => 'cluster is empty', 'description' => ''], ['errorCode' => 'Whitelist.Invalid', 'errorMessage' => 'Whitelist blocks not in CIDR format.', 'description' => ''], ['errorCode' => 'Whitelist.TooLong', 'errorMessage' => 'Whitelist too long, exceeds 10 CIDR blocks.', 'description' => ''], ], 403 => [ ['errorCode' => 'JoinCluster.InvalidDeviceVersion', 'errorMessage' => 'Instance version is lower than the master in the cluster.', 'description' => ''], ['errorCode' => 'Cluster.CN.ClusterModeInvalid', 'errorMessage' => 'This API is forbidden for current cluster mode.', 'description' => ''], ['errorCode' => 'NoPermission', 'errorMessage' => 'Caller has no permission on the resource.', 'description' => ''], ['errorCode' => 'InstanceNotPaused', 'errorMessage' => 'Please pause the instance before reset.', 'description' => ''], ['errorCode' => 'InstanceNotActive', 'errorMessage' => 'Instance is not active.', 'description' => ''], ['errorCode' => 'ConfigIp.IncorrectState', 'errorMessage' => 'Instance not in pending or active state, can not config IP address.', 'description' => ''], ['errorCode' => 'SwitchMaster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'SyncCluster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'LeaveCluster.InstanceInvalid', 'errorMessage' => 'The instance is not in the cluster.', 'description' => ''], ['errorCode' => 'DeleteCluster.IncorrectState', 'errorMessage' => 'Cluster not empty, please remove all instances first.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceVSwitchNotInCluster', 'errorMessage' => 'Instance\'s vSwitch is not in cluster config, please change instance\'s vSwitch first.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceInitialized', 'errorMessage' => 'Initialized instance can not join a cluster.', 'description' => ''], ['errorCode' => 'JoinCluster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'InitializeCluster.InstanceNotInitialized', 'errorMessage' => 'Cluster master instance not initialized, please initialize cluster master instance first.', 'description' => ''], ['errorCode' => 'InitializeCluster.IncorrectConfig', 'errorMessage' => 'Cluster subnet not configured, please config cluster subnet first.', 'description' => ''], ['errorCode' => 'InitializeCluster.IncorrectState', 'errorMessage' => 'Cluster initialized, do not re-initialize.', 'description' => ''], ['errorCode' => 'Cluster.CN.ActionForbidden', 'errorMessage' => 'This API is forbidden for non-international site cluster.', 'description' => ''], ['errorCode' => 'Cluster.INTL.ActionForbidden', 'errorMessage' => 'This API is forbidden for international site cluster.', 'description' => ''], ['errorCode' => 'ConfigClusterCertificate.IncorrectState', 'errorMessage' => 'Cluster initialized or certificates already configured.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.InvalidVpcId', 'errorMessage' => 'VPC Id invalid. Cluster VPC is the same as cluster master\'s VPC.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.InvalidVSwitchId', 'errorMessage' => 'VSwitch Id invalid. VSwitches should contain all current cluster vSwitches.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.IncorrectState', 'errorMessage' => 'Cluster not in NEW state, can not config cluster subnet.', 'description' => ''], ['errorCode' => 'ClusterName.Exist', 'errorMessage' => 'Cluster name already exists, please use another name.', 'description' => ''], ['errorCode' => 'Whitelist.InstanceInCluster', 'errorMessage' => 'Whitelist.InstanceInCluster', 'description' => ''], ['errorCode' => 'JoinCluster.InvalidDeviceType', 'errorMessage' => 'Instance device type mismatches with the cluster\'s.', 'description' => ''], ['errorCode' => 'JoinCluster.InvalidPqcStatus', 'errorMessage' => 'Instance pqc status mismatches with the cluster\'s.', 'description' => ''], ], [ ['errorCode' => 'Resource.NotFound', 'errorMessage' => 'Resource not found.', 'description' => ''], ], [ ['errorCode' => 'ClusterAPI.NotSupported', 'errorMessage' => 'ClusterAPI not supported in this region.', 'description' => ''], ], 409 => [ ['errorCode' => 'Conflict', 'errorMessage' => 'Resource is being updated by a previous request. Current request is redundant.', 'description' => ''], ['errorCode' => 'Cluster.Conflict', 'errorMessage' => 'The cluster is being updated by a previous request. Please try again later.', 'description' => ''], ], 500 => [ ['errorCode' => 'ConfigWhitelistFailed.Error', 'errorMessage' => 'config white list error', 'description' => ''], ['errorCode' => 'ActionFailed.Error', 'errorMessage' => 'internal error, please try again', 'description' => ''], ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => 'Unknown error caused request processing to fail.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'JoinCluster', 'description' => '- Only clusters in the initialized (INITIALIZED) state can have new HSM instances added.'."\n" .'- The HSM instance to be added to the cluster must be in the enabled or disabled state and must not be initialized.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:JoinCluster', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C467B38-3910-447D-87BC-AC049166F216\\",\\n \\"Job\\": {\\n \\"JobId\\": \\"job-202401250936hze747fd7e0007005\\",\\n \\"Type\\": \\"create\\",\\n \\"Completed\\": true,\\n \\"CreateTime\\": \\"1711764127000\\",\\n \\"Status\\": \\"running\\",\\n \\"Response\\": \\"success\\",\\n \\"Error\\": \\"OperationTimeout\\",\\n \\"Progress\\": 86\\n }\\n}","type":"json"}]', ], 'LeaveCluster' => [ 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREhsmV7VE3Y', 'FEATUREhsm01FLNB', 'FEATUREhsmGIFYCG', 'FEATUREhsmLBBV5W'], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the cluster.', 'type' => 'string', 'required' => true, 'example' => 'cluster-729dm40FG****', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the HSM.', 'type' => 'string', 'required' => true, 'example' => 'hsm-cn-mp90fxef****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'BaseResult', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4C467B38-3910-447D-87BC-AC049166F216', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'SwitchMaster.InstanceInvalid', 'errorMessage' => 'Instance not in the cluster.', 'description' => ''], ['errorCode' => 'LeaveCluster.MasterLast', 'errorMessage' => 'Master instance can not leave a cluster until all other instances are left.', 'description' => ''], ['errorCode' => 'Certificate.ChainInvalid', 'errorMessage' => 'Certificate chain invalid. Please make sure issuer certificate is the trust anchor and cluster certificate is signed by issuer certificate.', 'description' => ''], ['errorCode' => 'Certificate.FormatInvalid', 'errorMessage' => 'Certificate format invalid. Cluster/Issuer certificate must be in PEM format.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.DuplicateZone', 'errorMessage' => 'VSwitches should not contain duplicate zones.', 'description' => ''], ['errorCode' => 'InvalidApiParam.Error', 'errorMessage' => 'api param is invalid', 'description' => ''], ['errorCode' => 'InvalidClusterName', 'errorMessage' => 'Invalid parameter clusterName.', 'description' => ''], ['errorCode' => 'InvalidPageSize', 'errorMessage' => 'Invalid parameter pageSize.', 'description' => ''], ['errorCode' => 'InvalidCurrentPage', 'errorMessage' => 'Invalid parameter currentPage.', 'description' => ''], ['errorCode' => 'InvalidRegionId', 'errorMessage' => 'Invalid parameter regionId.', 'description' => ''], ['errorCode' => 'InvalidVSwitch', 'errorMessage' => 'Invalid parameter vSwitch.', 'description' => ''], ['errorCode' => 'InvalidVpc', 'errorMessage' => 'Invalid parameter vpcId.', 'description' => ''], ['errorCode' => 'InvalidIp', 'errorMessage' => 'Invalid parameter IP.', 'description' => ''], ['errorCode' => 'InvalidAliuid', 'errorMessage' => 'Invalid parameter aliuid.', 'description' => ''], ['errorCode' => 'InvalidClusterId', 'errorMessage' => 'Invalid parameter clusterId.', 'description' => ''], ['errorCode' => 'InvalidInstanceId', 'errorMessage' => 'Invalid parameter instanceId.', 'description' => ''], ['errorCode' => 'InvalidBackupId', 'errorMessage' => 'Invalid parameter backupId.', 'description' => ''], ['errorCode' => 'InvalidImageId', 'errorMessage' => 'Invalid parameter imageId.', 'description' => ''], ['errorCode' => 'HsmInstanceNotExist.Error', 'errorMessage' => 'hsm instance not exist', 'description' => ''], ['errorCode' => 'HSMIntanceNotActived.Error', 'errorMessage' => 'hsm intance is not actived', 'description' => ''], ['errorCode' => 'WhiteListMaxCount.Error', 'errorMessage' => 'whilte list is more than max count', 'description' => ''], ['errorCode' => 'ClusterIdIsNotExists.Error', 'errorMessage' => 'cluster ID non-exists', 'description' => ''], ['errorCode' => 'InstanceListIsEmpty.Error', 'errorMessage' => 'instance list is empty', 'description' => ''], ['errorCode' => 'InstanceIdIsEmpty.Error', 'errorMessage' => 'instance id is empty', 'description' => ''], ['errorCode' => 'InstanceIsNotExistsInCluster.Error', 'errorMessage' => 'cluster has no such instance', 'description' => ''], ['errorCode' => 'InstanceIsExistsInCluster.Error', 'errorMessage' => 'instance already in the cluster', 'description' => ''], ['errorCode' => 'RegionNoEmpty.Error', 'errorMessage' => 'region no. is empty', 'description' => ''], ['errorCode' => 'ClusterNameEmpty.Error', 'errorMessage' => 'empty cluster name not allowed', 'description' => ''], ['errorCode' => 'ClusterNameIsExists.Error', 'errorMessage' => 'the cluster name is already taken', 'description' => ''], ['errorCode' => 'IpNotValid.Error', 'errorMessage' => 'ip not valid', 'description' => ''], ['errorCode' => 'ClusterIsEmpty.Error', 'errorMessage' => 'cluster is empty', 'description' => ''], ['errorCode' => 'NoMasterFoundInCluster.Error', 'errorMessage' => 'cluster has no master instance', 'description' => ''], ['errorCode' => 'HsmInstanceIdNotFound.Error', 'errorMessage' => 'no such instance', 'description' => ''], ['errorCode' => 'NoInstanceFoundInCluster.Error', 'errorMessage' => 'cluster is empty', 'description' => ''], ['errorCode' => 'Whitelist.Invalid', 'errorMessage' => 'Whitelist blocks not in CIDR format.', 'description' => ''], ['errorCode' => 'Whitelist.TooLong', 'errorMessage' => 'Whitelist too long, exceeds 10 CIDR blocks.', 'description' => ''], ], 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'Caller has no permission on the resource.', 'description' => ''], ['errorCode' => 'InstanceNotPaused', 'errorMessage' => 'Please pause the instance before reset.', 'description' => ''], ['errorCode' => 'InstanceNotActive', 'errorMessage' => 'Instance is not active.', 'description' => ''], ['errorCode' => 'ConfigIp.IncorrectState', 'errorMessage' => 'Instance not in pending or active state, can not config IP address.', 'description' => ''], ['errorCode' => 'SwitchMaster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'SyncCluster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'LeaveCluster.InstanceInvalid', 'errorMessage' => 'The instance is not in the cluster.', 'description' => ''], ['errorCode' => 'DeleteCluster.IncorrectState', 'errorMessage' => 'Cluster not empty, please remove all instances first.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceVSwitchNotInCluster', 'errorMessage' => 'Instance\'s vSwitch is not in cluster config, please change instance\'s vSwitch first.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceInitialized', 'errorMessage' => 'Initialized instance can not join a cluster.', 'description' => ''], ['errorCode' => 'JoinCluster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'InitializeCluster.InstanceNotInitialized', 'errorMessage' => 'Cluster master instance not initialized, please initialize cluster master instance first.', 'description' => ''], ['errorCode' => 'InitializeCluster.IncorrectConfig', 'errorMessage' => 'Cluster subnet not configured, please config cluster subnet first.', 'description' => ''], ['errorCode' => 'InitializeCluster.IncorrectState', 'errorMessage' => 'Cluster initialized, do not re-initialize.', 'description' => ''], ['errorCode' => 'Cluster.CN.ActionForbidden', 'errorMessage' => 'This API is forbidden for non-international site cluster.', 'description' => ''], ['errorCode' => 'Cluster.INTL.ActionForbidden', 'errorMessage' => 'This API is forbidden for international site cluster.', 'description' => ''], ['errorCode' => 'ConfigClusterCertificate.IncorrectState', 'errorMessage' => 'Cluster initialized or certificates already configured.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.InvalidVpcId', 'errorMessage' => 'VPC Id invalid. Cluster VPC is the same as cluster master\'s VPC.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.InvalidVSwitchId', 'errorMessage' => 'VSwitch Id invalid. VSwitches should contain all current cluster vSwitches.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.IncorrectState', 'errorMessage' => 'Cluster not in NEW state, can not config cluster subnet.', 'description' => ''], ['errorCode' => 'ClusterName.Exist', 'errorMessage' => 'Cluster name already exists, please use another name.', 'description' => ''], ['errorCode' => 'Whitelist.InstanceInCluster', 'errorMessage' => 'Whitelist.InstanceInCluster', 'description' => ''], ], [ ['errorCode' => 'Resource.NotFound', 'errorMessage' => 'Resource not found.', 'description' => ''], ], [ ['errorCode' => 'ClusterAPI.NotSupported', 'errorMessage' => 'ClusterAPI not supported in this region.', 'description' => ''], ], 409 => [ ['errorCode' => 'Conflict', 'errorMessage' => 'Resource is being updated by a previous request. Current request is redundant.', 'description' => ''], ['errorCode' => 'Cluster.Conflict', 'errorMessage' => 'The cluster is being updated by a previous request. Please try again later.', 'description' => ''], ], 500 => [ ['errorCode' => 'ConfigWhitelistFailed.Error', 'errorMessage' => 'config white list error', 'description' => ''], ['errorCode' => 'ActionFailed.Error', 'errorMessage' => 'internal error, please try again', 'description' => ''], ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => 'Unknown error caused request processing to fail.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'LeaveCluster', 'summary' => 'Removes a hardware security module (HSM) from the current cluster.', 'description' => '- If non-master HSMs exist in a cluster, the master HSM cannot be removed from the cluster.'."\n" ."\n" .'- After the master HSM is removed from a cluster, the cluster enters the TO\\_DELETE state and cannot be restored to the available state. Proceed with caution.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:LeaveCluster', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C467B38-3910-447D-87BC-AC049166F216\\"\\n}","type":"json"}]', ], 'ListBackups' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '203775', 'abilityTreeNodes' => ['FEATUREhsmQEGDGS'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of backups to return on each page. Valid values: 1 to 1000.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '20', 'title' => ''], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'The name of the backup.', 'type' => 'string', 'required' => false, 'example' => 'hsm-te****', 'title' => ''], ], [ 'name' => 'BackupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup.', 'type' => 'string', 'required' => false, 'example' => 'backup-1648438****', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the Hardware Security Module (HSM) instance.', 'type' => 'string', 'required' => false, 'example' => 'hsm-cn-vj30bil8****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '4C467B38-3910-447D-87BC-AC049166F216', 'title' => ''], 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], 'PageSize' => ['description' => 'The number of backups returned on each page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], 'CurrentPage' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Backups' => [ 'description' => 'The list of returned backups.', 'type' => 'array', 'items' => [ 'description' => 'The details of a backup.', 'type' => 'object', 'properties' => [ 'BackupId' => ['description' => 'The ID of the backup.', 'type' => 'string', 'example' => 'backup-1648438****', 'title' => ''], 'CreateTime' => ['description' => 'The time when the backup was created. This is a timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1637229596000', 'title' => ''], 'ExpireTime' => ['description' => 'The time when the backup expires. This is a timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1682417553781'."\n", 'title' => ''], 'InstanceId' => ['description' => 'The ID of the HSM instance that is associated with the backup.', 'type' => 'string', 'example' => 'hsm-cn-vj30bil8****', 'title' => ''], 'Name' => ['description' => 'The name of the backup.', 'type' => 'string', 'example' => 'backup-te****', 'title' => ''], 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'ap-southeast-1', 'title' => ''], 'Remark' => ['description' => 'The remarks of the backup.', 'type' => 'string', 'example' => 'normal backup', 'title' => ''], 'Status' => [ 'description' => 'The status of the backup.'."\n" ."\n" .'- NEW: Not enabled'."\n" ."\n" .'- EXPIRED: Expired'."\n" ."\n" .'- ENABLED: Enabled', 'enumValueTitles' => [], 'type' => 'string', 'enum' => ['NEW', 'ENABLED', 'EXPIRED'], 'example' => 'ENABLED', 'title' => '', ], 'MaxImageCount' => ['description' => 'The number of images.', 'type' => 'string', 'example' => '3', 'title' => ''], 'Type' => [ 'description' => 'The type of the backup.'."\n" ."\n" .'- DEFAULT: Default backup'."\n" ."\n" .'- NORMAL: Normal backup', 'enumValueTitles' => [], 'type' => 'string', 'enum' => ['NORMAL', 'DEFAULT'], 'example' => 'NORMAL', 'title' => '', ], 'BackupPeriod' => ['description' => 'The automatic backup cycle, in days.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], 'NextImageCreateTime' => ['description' => 'The time when the next image will be created. This is a timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1682417553781'."\n", 'title' => ''], 'AutoImageCount' => ['description' => 'The number of automatic backup images.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'BackupHourInDay' => ['description' => 'The hour of the day when the backup is performed. The time is in 24-hour format.', 'type' => 'string', 'example' => '13', 'title' => ''], 'SpInstanceId' => ['description' => 'The ID of the backup in the sales domain. This parameter is returned only for backups of HSM instances in the Chinese mainland.', 'type' => 'string', 'example' => 'backup-fdb897sdfg534-****', 'title' => ''], 'ReleaseTime' => ['description' => 'The time when the backup was released. This is a timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1641275680000', 'title' => ''], 'OwnerInstanceId' => ['description' => 'The ID of the HSM instance that owns the backup. This parameter is returned only for backups of HSM instances outside the Chinese mainland. Its value is the same as InstanceId.', 'type' => 'string', 'example' => 'hsm-cn-vj30bil8****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'caller has no permission', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ListBackups', 'summary' => 'Retrieves a list of backup sets that meet specified conditions.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'yundun-hsm:ListBackups', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C467B38-3910-447D-87BC-AC049166F216\\",\\n \\"TotalCount\\": 30,\\n \\"PageSize\\": 20,\\n \\"CurrentPage\\": 1,\\n \\"Backups\\": [\\n {\\n \\"BackupId\\": \\"backup-1648438****\\",\\n \\"CreateTime\\": 1637229596000,\\n \\"ExpireTime\\": 1682417553781,\\n \\"InstanceId\\": \\"hsm-cn-vj30bil8****\\",\\n \\"Name\\": \\"backup-te****\\",\\n \\"RegionId\\": \\"ap-southeast-1\\",\\n \\"Remark\\": \\"normal backup\\",\\n \\"Status\\": \\"ENABLED\\",\\n \\"MaxImageCount\\": \\"3\\",\\n \\"Type\\": \\"NORMAL\\",\\n \\"BackupPeriod\\": 3,\\n \\"NextImageCreateTime\\": 1682417553781,\\n \\"AutoImageCount\\": 1,\\n \\"BackupHourInDay\\": \\"13\\",\\n \\"SpInstanceId\\": \\"backup-fdb897sdfg534-****\\",\\n \\"ReleaseTime\\": 1641275680000,\\n \\"OwnerInstanceId\\": \\"hsm-cn-vj30bil8****\\"\\n }\\n ]\\n}","type":"json"}]', ], 'ListClusters' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREhsmV7VE3Y', 'FEATUREhsm01FLNB', 'FEATUREhsmGIFYCG', 'FEATUREhsmLBBV5W'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'formData', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'KmsInstanceId', 'in' => 'query', 'schema' => ['type' => 'string', 'example' => 'kst-xxxx', 'description' => '', 'title' => ''], ], [ 'name' => 'CurrentPage', 'in' => 'formData', 'schema' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => ['description' => 'The number of clusters to display per page. Valid values: 1 to 1000.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'OpenApiPageResult', 'type' => 'object', 'properties' => [ 'Total' => ['description' => 'The total number of clusters.', 'type' => 'integer', 'format' => 'int32', 'example' => '114', 'title' => ''], 'PageSize' => ['description' => 'The number of clusters displayed per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], 'CurrentPage' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request. The China Chinese Cloud generates a unique identifier for each request. You can use the ID to troubleshoot issues.', 'type' => 'string', 'example' => '4C467B38-3910-447D-87BC-AC049166F216', 'title' => ''], 'Clusters' => [ 'description' => 'The list of clusters.', 'type' => 'array', 'items' => [ 'description' => 'The cluster information.', 'type' => 'object', 'properties' => [ 'ClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'cluster-w3G9vOJI2****', 'title' => ''], 'Status' => ['description' => 'The cluster status. Valid values:'."\n" ."\n" .'- NEW: Not initialized.'."\n" ."\n" .'- INITIALIZED: Initialized.'."\n" ."\n" .'- DELETED: Deleted.'."\n" ."\n" .'- SYNCHRONIZING: Synchronizing.'."\n" ."\n" .'- TO_DELETE: Pending deletion.', 'type' => 'string', 'example' => 'INITIALIZED', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'SwitchMaster.InstanceInvalid', 'errorMessage' => 'Instance not in the cluster.', 'description' => ''], ['errorCode' => 'LeaveCluster.MasterLast', 'errorMessage' => 'Master instance can not leave a cluster until all other instances are left.', 'description' => ''], ['errorCode' => 'Certificate.ChainInvalid', 'errorMessage' => 'Certificate chain invalid. Please make sure issuer certificate is the trust anchor and cluster certificate is signed by issuer certificate.', 'description' => ''], ['errorCode' => 'Certificate.FormatInvalid', 'errorMessage' => 'Certificate format invalid. Cluster/Issuer certificate must be in PEM format.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.DuplicateZone', 'errorMessage' => 'VSwitches should not contain duplicate zones.', 'description' => ''], ['errorCode' => 'InvalidApiParam.Error', 'errorMessage' => 'api param is invalid', 'description' => ''], ['errorCode' => 'InvalidClusterName', 'errorMessage' => 'Invalid parameter clusterName.', 'description' => ''], ['errorCode' => 'InvalidPageSize', 'errorMessage' => 'Invalid parameter pageSize.', 'description' => ''], ['errorCode' => 'InvalidCurrentPage', 'errorMessage' => 'Invalid parameter currentPage.', 'description' => ''], ['errorCode' => 'InvalidRegionId', 'errorMessage' => 'Invalid parameter regionId.', 'description' => ''], ['errorCode' => 'InvalidVSwitch', 'errorMessage' => 'Invalid parameter vSwitch.', 'description' => ''], ['errorCode' => 'InvalidVpc', 'errorMessage' => 'Invalid parameter vpcId.', 'description' => ''], ['errorCode' => 'InvalidIp', 'errorMessage' => 'Invalid parameter IP.', 'description' => ''], ['errorCode' => 'InvalidAliuid', 'errorMessage' => 'Invalid parameter aliuid.', 'description' => ''], ['errorCode' => 'InvalidClusterId', 'errorMessage' => 'Invalid parameter clusterId.', 'description' => ''], ['errorCode' => 'InvalidInstanceId', 'errorMessage' => 'Invalid parameter instanceId.', 'description' => ''], ['errorCode' => 'InvalidBackupId', 'errorMessage' => 'Invalid parameter backupId.', 'description' => ''], ['errorCode' => 'InvalidImageId', 'errorMessage' => 'Invalid parameter imageId.', 'description' => ''], ['errorCode' => 'HsmInstanceNotExist.Error', 'errorMessage' => 'hsm instance not exist', 'description' => ''], ['errorCode' => 'HSMIntanceNotActived.Error', 'errorMessage' => 'hsm intance is not actived', 'description' => ''], ['errorCode' => 'WhiteListMaxCount.Error', 'errorMessage' => 'whilte list is more than max count', 'description' => ''], ['errorCode' => 'ClusterIdIsNotExists.Error', 'errorMessage' => 'cluster ID non-exists', 'description' => ''], ['errorCode' => 'InstanceListIsEmpty.Error', 'errorMessage' => 'instance list is empty', 'description' => ''], ['errorCode' => 'InstanceIdIsEmpty.Error', 'errorMessage' => 'instance id is empty', 'description' => ''], ['errorCode' => 'InstanceIsNotExistsInCluster.Error', 'errorMessage' => 'cluster has no such instance', 'description' => ''], ['errorCode' => 'InstanceIsExistsInCluster.Error', 'errorMessage' => 'instance already in the cluster', 'description' => ''], ['errorCode' => 'RegionNoEmpty.Error', 'errorMessage' => 'region no. is empty', 'description' => ''], ['errorCode' => 'ClusterNameEmpty.Error', 'errorMessage' => 'empty cluster name not allowed', 'description' => ''], ['errorCode' => 'ClusterNameIsExists.Error', 'errorMessage' => 'the cluster name is already taken', 'description' => ''], ['errorCode' => 'IpNotValid.Error', 'errorMessage' => 'ip not valid', 'description' => ''], ['errorCode' => 'ClusterIsEmpty.Error', 'errorMessage' => 'cluster is empty', 'description' => ''], ['errorCode' => 'NoMasterFoundInCluster.Error', 'errorMessage' => 'cluster has no master instance', 'description' => ''], ['errorCode' => 'HsmInstanceIdNotFound.Error', 'errorMessage' => 'no such instance', 'description' => ''], ['errorCode' => 'NoInstanceFoundInCluster.Error', 'errorMessage' => 'cluster is empty', 'description' => ''], ['errorCode' => 'Whitelist.Invalid', 'errorMessage' => 'Whitelist blocks not in CIDR format.', 'description' => ''], ['errorCode' => 'Whitelist.TooLong', 'errorMessage' => 'Whitelist too long, exceeds 10 CIDR blocks.', 'description' => ''], ], 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'Caller has no permission on the resource.', 'description' => ''], ['errorCode' => 'InstanceNotPaused', 'errorMessage' => 'Please pause the instance before reset.', 'description' => ''], ['errorCode' => 'InstanceNotActive', 'errorMessage' => 'Instance is not active.', 'description' => ''], ['errorCode' => 'ConfigIp.IncorrectState', 'errorMessage' => 'Instance not in pending or active state, can not config IP address.', 'description' => ''], ['errorCode' => 'SwitchMaster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'SyncCluster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'LeaveCluster.InstanceInvalid', 'errorMessage' => 'The instance is not in the cluster.', 'description' => ''], ['errorCode' => 'DeleteCluster.IncorrectState', 'errorMessage' => 'Cluster not empty, please remove all instances first.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceVSwitchNotInCluster', 'errorMessage' => 'Instance\'s vSwitch is not in cluster config, please change instance\'s vSwitch first.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceInitialized', 'errorMessage' => 'Initialized instance can not join a cluster.', 'description' => ''], ['errorCode' => 'JoinCluster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'InitializeCluster.InstanceNotInitialized', 'errorMessage' => 'Cluster master instance not initialized, please initialize cluster master instance first.', 'description' => ''], ['errorCode' => 'InitializeCluster.IncorrectConfig', 'errorMessage' => 'Cluster subnet not configured, please config cluster subnet first.', 'description' => ''], ['errorCode' => 'InitializeCluster.IncorrectState', 'errorMessage' => 'Cluster initialized, do not re-initialize.', 'description' => ''], ['errorCode' => 'Cluster.CN.ActionForbidden', 'errorMessage' => 'This API is forbidden for non-international site cluster.', 'description' => ''], ['errorCode' => 'Cluster.INTL.ActionForbidden', 'errorMessage' => 'This API is forbidden for international site cluster.', 'description' => ''], ['errorCode' => 'ConfigClusterCertificate.IncorrectState', 'errorMessage' => 'Cluster initialized or certificates already configured.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.InvalidVpcId', 'errorMessage' => 'VPC Id invalid. Cluster VPC is the same as cluster master\'s VPC.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.InvalidVSwitchId', 'errorMessage' => 'VSwitch Id invalid. VSwitches should contain all current cluster vSwitches.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.IncorrectState', 'errorMessage' => 'Cluster not in NEW state, can not config cluster subnet.', 'description' => ''], ['errorCode' => 'ClusterName.Exist', 'errorMessage' => 'Cluster name already exists, please use another name.', 'description' => ''], ['errorCode' => 'Whitelist.InstanceInCluster', 'errorMessage' => 'Whitelist.InstanceInCluster', 'description' => ''], ], [ ['errorCode' => 'Resource.NotFound', 'errorMessage' => 'Resource not found.', 'description' => ''], ], [ ['errorCode' => 'ClusterAPI.NotSupported', 'errorMessage' => 'ClusterAPI not supported in this region.', 'description' => ''], ], 409 => [ ['errorCode' => 'Conflict', 'errorMessage' => 'Resource is being updated by a previous request. Current request is redundant.', 'description' => ''], ['errorCode' => 'Cluster.Conflict', 'errorMessage' => 'The cluster is being updated by a previous request. Please try again later.', 'description' => ''], ], 500 => [ ['errorCode' => 'ConfigWhitelistFailed.Error', 'errorMessage' => 'config white list error', 'description' => ''], ['errorCode' => 'ActionFailed.Error', 'errorMessage' => 'internal error, please try again', 'description' => ''], ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => 'Unknown error caused request processing to fail.'], ], ], 'title' => 'Query cluster list', 'summary' => 'Retrieves clusters that match the specified query conditions.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'yundun-hsm:ListClusters', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Total\\": 114,\\n \\"PageSize\\": 20,\\n \\"CurrentPage\\": 1,\\n \\"RequestId\\": \\"4C467B38-3910-447D-87BC-AC049166F216\\",\\n \\"Clusters\\": [\\n {\\n \\"ClusterId\\": \\"cluster-w3G9vOJI2****\\",\\n \\"Status\\": \\"INITIALIZED\\"\\n }\\n ]\\n}","type":"json"}]', ], 'ListImages' => [ 'summary' => 'Queries the images that meet the specified conditions.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '203777', 'abilityTreeNodes' => ['FEATUREhsmQEGDGS'], ], 'parameters' => [ [ 'name' => 'BackupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup.', 'type' => 'string', 'required' => true, 'example' => 'backup-fdb897sdf****', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the region.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of images per page. Valid values: 1 to 1000.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', 'title' => ''], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'Mode', 'in' => 'query', 'schema' => [ 'description' => 'The image generation mode. Valid values:'."\n" ."\n" .'- PERIODIC: It is automatically generated.'."\n" ."\n" .'- MANUAL: It is manually generated.', 'enumValueTitles' => [], 'type' => 'string', 'enum' => ['MANUAL', 'PERIODIC'], 'required' => false, 'example' => 'MANUAL', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4C467B38-3910-447D-87BC-AC049166F216', 'title' => ''], 'TotalCount' => ['description' => 'The total number of images returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => ''], 'PageSize' => ['description' => 'The number of images per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], 'CurrentPage' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Images' => [ 'description' => 'The images returned.', 'type' => 'array', 'items' => [ 'description' => 'The image details.', 'type' => 'object', 'properties' => [ 'BackupId' => ['description' => 'The ID of the backup.', 'type' => 'string', 'example' => 'backup-fdb897sdf****', 'title' => ''], 'ExportTime' => ['description' => 'The time when the image was generated. Unit: milliseconds. The value is a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1782849566738', 'title' => ''], 'ImageId' => ['description' => 'The ID of the image.', 'type' => 'string', 'example' => 'image-d79x4k11pmg19****', 'title' => ''], 'InstanceId' => ['description' => 'The ID of the hardware security module (HSM).', 'type' => 'string', 'example' => 'hsm-cn-6ja1xknf****', 'title' => ''], 'RegionId' => ['description' => 'The ID of the region.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'Remark' => ['description' => 'The description of the backup.', 'type' => 'string', 'example' => 'hsm-test', 'title' => ''], 'Status' => [ 'description' => 'The status of the image. Valid values:'."\n" ."\n" .'- NEW: It is disabled.'."\n" ."\n" .'- DELETED: It is deleted.'."\n" ."\n" .'- CREATING: It is being created.'."\n" ."\n" .'- NORMAL: It is created.', 'enumValueTitles' => [], 'type' => 'string', 'enum' => ['NORMAL', 'NEW', 'DELETED', 'CREATING'], 'example' => 'CREATING', 'title' => '', ], 'Mode' => [ 'description' => 'The image generation mode. Valid values:'."\n" ."\n" .'- PERIODIC: It is automatically generated.'."\n" ."\n" .'- MANUAL: It is manually generated.', 'enumValueTitles' => [], 'type' => 'string', 'enum' => ['PERIODIC', 'MANUAL'], 'example' => 'MANUAL', 'title' => '', ], 'VsmDigest' => ['description' => 'The digest of the HSM.', 'type' => 'string', 'example' => '3kGeHnmQzXwSsfF0Jk9eJYhe2gP6An0/HlYIiZh1****', 'title' => ''], 'SourceImageUid' => ['description' => 'The ID of the source image.', 'type' => 'string', 'example' => 'image-ooopjygsn****', 'title' => ''], 'SourceBackupUid' => ['description' => 'The ID of the source backup.', 'type' => 'string', 'example' => 'backup-hodfhaol****', 'title' => ''], 'SourceRegionId' => ['description' => 'The ID of the region in which the source image resides.', 'type' => 'string', 'example' => 'cn-shanghai', 'title' => ''], 'SourceInstanceId' => ['description' => 'The ID of the source HSM.', 'type' => 'string', 'example' => 'hsm-cn-wz9i2dmefudfxtmb****', 'title' => ''], 'CopyTime' => ['description' => 'The time when the image was copied. Unit: milliseconds. The value is a UNIX timestamp.', 'type' => 'string', 'example' => '1641275680000', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'caller has no permission', 'description' => ''], ['errorCode' => 'Backup.Deleted', 'errorMessage' => 'Backup has been deleted.', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ListImages', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'yundun-hsm:ListImages', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C467B38-3910-447D-87BC-AC049166F216\\",\\n \\"TotalCount\\": 1000,\\n \\"PageSize\\": 20,\\n \\"CurrentPage\\": 1,\\n \\"Images\\": [\\n {\\n \\"BackupId\\": \\"backup-fdb897sdf****\\",\\n \\"ExportTime\\": 1782849566738,\\n \\"ImageId\\": \\"image-d79x4k11pmg19****\\",\\n \\"InstanceId\\": \\"hsm-cn-6ja1xknf****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Remark\\": \\"hsm-test\\",\\n \\"Status\\": \\"CREATING\\",\\n \\"Mode\\": \\"MANUAL\\",\\n \\"VsmDigest\\": \\"3kGeHnmQzXwSsfF0Jk9eJYhe2gP6An0/HlYIiZh1****\\",\\n \\"SourceImageUid\\": \\"image-ooopjygsn****\\",\\n \\"SourceBackupUid\\": \\"backup-hodfhaol****\\",\\n \\"SourceRegionId\\": \\"cn-shanghai\\",\\n \\"SourceInstanceId\\": \\"hsm-cn-wz9i2dmefudfxtmb****\\",\\n \\"CopyTime\\": \\"1641275680000\\"\\n }\\n ]\\n}","type":"json"}]', ], 'ListInstances' => [ 'summary' => 'Retrieves instances that match the specified query conditions.', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '209162', 'abilityTreeNodes' => ['FEATUREhsmV7VE3Y', 'FEATUREhsmUNBCOF', 'FEATUREhsm01FLNB', 'FEATUREhsmGIFYCG', 'FEATUREhsmLBBV5W'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'formData', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'KmsInstanceId', 'in' => 'query', 'schema' => ['title' => '', 'type' => 'string', 'example' => 'kst-xxx', 'description' => ''], ], [ 'name' => 'CurrentPage', 'in' => 'formData', 'schema' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => ['description' => 'The number of entries per page. Valid values: 1 to 1000.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', 'title' => ''], ], [ 'name' => 'TenantIsolationType', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The HSM hardware isolation type. Valid values:'."\n" .'- vsm: virtual HSM.'."\n" .'- hostedHsm: hosted HSM.', 'type' => 'string', 'required' => false, 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'OpenApiPageResult', 'type' => 'object', 'properties' => [ 'Total' => ['description' => 'The total number of instances.', 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], 'CurrentPage' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'RequestId' => ['description' => 'The request ID. Alibaba Cloud generates a unique identifier for each API request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '4C467B38-3910-447D-87BC-AC049166F216', 'title' => ''], 'Instances' => [ 'description' => 'The list of instances.', 'type' => 'array', 'items' => [ 'description' => 'The instance information.', 'type' => 'object', 'properties' => [ 'InstanceId' => ['description' => 'The HSM instance ID.', 'type' => 'string', 'example' => 'hsm-cn-vj30bil8****', 'title' => ''], 'Status' => ['description' => 'The instance status. Valid values:'."\n" .'- PENDING: Not activated.'."\n" .'- ACTIVE: Activated.'."\n" .'- EXPIRED: Expired.'."\n" .'- INVALID: Invalidated.'."\n" .'- FAILURE: Production failed.'."\n" .'- RESET: Being reset.'."\n" .'- PAUSED: Suspended.'."\n" .'- MODIFYING: Being modified.', 'type' => 'string', 'example' => 'ACTIVE', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidTenantIsolationType.Error', 'errorMessage' => 'Invalid parameter tenantIsolationType. It must be: null, hostedHsm, or vsm.', 'description' => ''], ['errorCode' => 'InvalidApiParam.Error', 'errorMessage' => 'api param is invalid', 'description' => ''], ['errorCode' => 'HsmInstanceNotExist.Error', 'errorMessage' => 'hsm instance not exist', 'description' => ''], ['errorCode' => 'HSMIntanceNotActived.Error', 'errorMessage' => 'hsm intance is not actived', 'description' => ''], ['errorCode' => 'WhiteListMaxCount.Error', 'errorMessage' => 'whilte list is more than max count', 'description' => ''], ['errorCode' => 'ClusterIdIsNotExists.Error', 'errorMessage' => 'cluster ID non-exists', 'description' => ''], ['errorCode' => 'InstanceListIsEmpty.Error', 'errorMessage' => 'instance list is empty', 'description' => ''], ['errorCode' => 'InstanceIdIsEmpty.Error', 'errorMessage' => 'instance id is empty', 'description' => ''], ['errorCode' => 'InstanceIsNotExistsInCluster.Error', 'errorMessage' => 'cluster has no such instance', 'description' => ''], ['errorCode' => 'InstanceIsExistsInCluster.Error', 'errorMessage' => 'instance already in the cluster', 'description' => ''], ['errorCode' => 'RegionNoEmpty.Error', 'errorMessage' => 'region no. is empty', 'description' => ''], ['errorCode' => 'ClusterNameEmpty.Error', 'errorMessage' => 'empty cluster name not allowed', 'description' => ''], ['errorCode' => 'ClusterNameIsExists.Error', 'errorMessage' => 'the cluster name is already taken', 'description' => ''], ['errorCode' => 'IpNotValid.Error', 'errorMessage' => 'ip not valid', 'description' => ''], ['errorCode' => 'ClusterIsEmpty.Error', 'errorMessage' => 'cluster is empty', 'description' => ''], ['errorCode' => 'NoMasterFoundInCluster.Error', 'errorMessage' => 'cluster has no master instance', 'description' => ''], ['errorCode' => 'HsmInstanceIdNotFound.Error', 'errorMessage' => 'no such instance', 'description' => ''], ['errorCode' => 'NoInstanceFoundInCluster.Error', 'errorMessage' => 'cluster is empty', 'description' => ''], ['errorCode' => 'Whitelist.Invalid', 'errorMessage' => 'Whitelist blocks not in CIDR format.', 'description' => ''], ['errorCode' => 'Whitelist.TooLong', 'errorMessage' => 'Whitelist too long, exceeds 10 CIDR blocks.', 'description' => ''], ['errorCode' => 'SwitchMaster.InstanceInvalid', 'errorMessage' => 'Instance not in the cluster.', 'description' => ''], ['errorCode' => 'LeaveCluster.MasterLast', 'errorMessage' => 'Master instance can not leave a cluster until all other instances are left.', 'description' => ''], ['errorCode' => 'Certificate.ChainInvalid', 'errorMessage' => 'Certificate chain invalid. Please make sure issuer certificate is the trust anchor and cluster certificate is signed by issuer certificate.', 'description' => ''], ['errorCode' => 'Certificate.FormatInvalid', 'errorMessage' => 'Certificate format invalid. Cluster/Issuer certificate must be in PEM format.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.DuplicateZone', 'errorMessage' => 'VSwitches should not contain duplicate zones.', 'description' => ''], ['errorCode' => 'InvalidClusterName', 'errorMessage' => 'Invalid parameter clusterName.', 'description' => ''], ['errorCode' => 'InvalidPageSize', 'errorMessage' => 'Invalid parameter pageSize.', 'description' => ''], ['errorCode' => 'InvalidCurrentPage', 'errorMessage' => 'Invalid parameter currentPage.', 'description' => ''], ['errorCode' => 'InvalidRegionId', 'errorMessage' => 'Invalid parameter regionId.', 'description' => ''], ['errorCode' => 'InvalidZoneId', 'errorMessage' => 'Invalid parameter zoneId.', 'description' => ''], ['errorCode' => 'InvalidVSwitch', 'errorMessage' => 'Invalid parameter vSwitch.', 'description' => ''], ['errorCode' => 'InvalidVpc', 'errorMessage' => 'Invalid parameter vpcId.', 'description' => ''], ['errorCode' => 'InvalidVsmType', 'errorMessage' => 'Invalid parameter vsmType.', 'description' => ''], ['errorCode' => 'InvalidIp', 'errorMessage' => 'Invalid parameter IP.', 'description' => ''], ['errorCode' => 'InvalidAliuid', 'errorMessage' => 'Invalid parameter aliuid.', 'description' => ''], ['errorCode' => 'InvalidClusterId', 'errorMessage' => 'Invalid parameter clusterId.', 'description' => ''], ['errorCode' => 'InvalidInstanceId', 'errorMessage' => 'Invalid parameter instanceId.', 'description' => ''], ['errorCode' => 'InvalidBackupId', 'errorMessage' => 'Invalid parameter backupId.', 'description' => ''], ['errorCode' => 'InvalidImageId', 'errorMessage' => 'Invalid parameter imageId.', 'description' => ''], ['errorCode' => 'HSMIntanceActived.Error', 'errorMessage' => 'actived hsm instance can not release', 'description' => ''], ['errorCode' => 'ConfigIp.IpAlreadyInUse', 'errorMessage' => 'Ip is in use, can not config IP address.', 'description' => ''], ['errorCode' => 'ConfigIp.VpcIpNotMatched', 'errorMessage' => 'Vpc Ip must be in vpc network segment.', 'description' => ''], ['errorCode' => 'ConfigIp.IpOverFlow', 'errorMessage' => 'Vpc ip last place can not be in [253-255].', 'description' => ''], ['errorCode' => 'CanRefund.InstanceIdEmpty', 'errorMessage' => 'InstanceId is empty.', 'description' => ''], ['errorCode' => 'CanRefund.InstanceNotFound', 'errorMessage' => 'Instance Not Exist.', 'description' => ''], ['errorCode' => 'CanRefund.InstanceAlreadyReleased', 'errorMessage' => 'Instance already released.', 'description' => ''], ['errorCode' => 'CanRefund.AliUidEmpty', 'errorMessage' => 'AliUid empty.', 'description' => ''], ['errorCode' => 'CanRefund.NoSupportRefundOnline', 'errorMessage' => 'No support refund online.', 'description' => ''], ], 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'Caller has no permission on the resource.', 'description' => ''], ['errorCode' => 'InstanceNotPaused', 'errorMessage' => 'Please pause the instance before reset.', 'description' => ''], ['errorCode' => 'Trial.Forbidden', 'errorMessage' => 'Current user is not allowed for trials!', 'description' => ''], ['errorCode' => 'Forbidden.InstanceInCluster', 'errorMessage' => 'This API is forbidden for instances in cluster.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceIncorrectState', 'errorMessage' => 'Instance not in Active/Pending state.', 'description' => ''], ['errorCode' => 'InstanceNotActive', 'errorMessage' => 'Instance is not active.', 'description' => ''], ['errorCode' => 'ConfigIp.IncorrectState', 'errorMessage' => 'Instance not in pending or active state, can not config IP address.', 'description' => ''], ['errorCode' => 'SwitchMaster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'SyncCluster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'LeaveCluster.InstanceInvalid', 'errorMessage' => 'The instance is not in the cluster.', 'description' => ''], ['errorCode' => 'DeleteCluster.IncorrectState', 'errorMessage' => 'Cluster not empty, please remove all instances first.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceVSwitchNotInCluster', 'errorMessage' => 'Instance\'s vSwitch is not in cluster config, please change instance\'s vSwitch first.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceInitialized', 'errorMessage' => 'Initialized instance can not join a cluster.', 'description' => ''], ['errorCode' => 'JoinCluster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'InitializeCluster.InstanceNotInitialized', 'errorMessage' => 'Cluster master instance not initialized, please initialize cluster master instance first.', 'description' => ''], ['errorCode' => 'InitializeCluster.IncorrectConfig', 'errorMessage' => 'Cluster subnet not configured, please config cluster subnet first.', 'description' => ''], ['errorCode' => 'InitializeCluster.IncorrectState', 'errorMessage' => 'Cluster initialized, do not re-initialize.', 'description' => ''], ['errorCode' => 'Cluster.CN.ActionForbidden', 'errorMessage' => 'This API is forbidden for non-international site cluster.', 'description' => ''], ['errorCode' => 'Cluster.INTL.ActionForbidden', 'errorMessage' => 'This API is forbidden for international site cluster.', 'description' => ''], ['errorCode' => 'ConfigClusterCertificate.IncorrectState', 'errorMessage' => 'Cluster initialized or certificates already configured.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.InvalidVpcId', 'errorMessage' => 'VPC Id invalid. Cluster VPC is the same as cluster master\'s VPC.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.InvalidVSwitchId', 'errorMessage' => 'VSwitch Id invalid. VSwitches should contain all current cluster vSwitches.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.IncorrectState', 'errorMessage' => 'Cluster not in NEW state, can not config cluster subnet.', 'description' => ''], ['errorCode' => 'ClusterName.Exist', 'errorMessage' => 'Cluster name already exists, please use another name.', 'description' => ''], ['errorCode' => 'Image.ImageStatusInValid', 'errorMessage' => 'Image status is invalid.', 'description' => ''], ['errorCode' => 'CopyImage.ImageAlreadyCopied', 'errorMessage' => 'Image already copied, secondary copy is not supported.', 'description' => ''], ['errorCode' => 'Image.ActionForbiddenINTL', 'errorMessage' => 'This API is forbidden for international site.', 'description' => ''], ['errorCode' => 'Image.ActionForbiddenCN', 'errorMessage' => 'This API is forbidden for non-international site.', 'description' => ''], ['errorCode' => 'CopyImage.RegionInvalid', 'errorMessage' => 'Source region or target region invalid.', 'description' => ''], ['errorCode' => 'Backup.ActionForbiddenINTL', 'errorMessage' => 'This API is forbidden for international site.', 'description' => ''], ['errorCode' => 'CopyImage.TargetRegionImageAlreadyExists', 'errorMessage' => 'Target region has the same digest image.', 'description' => ''], ], [ ['errorCode' => 'Resource.NotFound', 'errorMessage' => 'Resource not found.', 'description' => ''], ], [ ['errorCode' => 'ClusterAPI.NotSupported', 'errorMessage' => 'ClusterAPI not supported in this region.', 'description' => ''], ], 409 => [ ['errorCode' => 'Conflict', 'errorMessage' => 'Resource is being updated by a previous request. Current request is redundant.', 'description' => ''], ['errorCode' => 'ConfigIp.IncorrectState', 'errorMessage' => 'Instance not in pending or active state, can not config IP address.', 'description' => ''], ['errorCode' => 'Cluster.Conflict', 'errorMessage' => 'The cluster is being updated by a previous request. Please try again later.', 'description' => ''], ], 500 => [ ['errorCode' => 'ConfigWhitelistFailed.Error', 'errorMessage' => 'config white list error', 'description' => ''], ['errorCode' => 'ActionFailed.Error', 'errorMessage' => 'internal error, please try again', 'description' => ''], ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => 'Unknown error caused request processing to fail.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'Query instance list', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'yundun-hsm:ListInstances', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Total\\": 80,\\n \\"PageSize\\": 20,\\n \\"CurrentPage\\": 1,\\n \\"RequestId\\": \\"4C467B38-3910-447D-87BC-AC049166F216\\",\\n \\"Instances\\": [\\n {\\n \\"InstanceId\\": \\"hsm-cn-vj30bil8****\\",\\n \\"Status\\": \\"ACTIVE\\"\\n }\\n ]\\n}","type":"json"}]', ], 'MoveResourceGroup' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREhsmV7VE3Y', 'FEATUREhsm01FLNB', 'FEATUREhsmGIFYCG', 'FEATUREhsmLBBV5W'], ], 'parameters' => [ [ 'name' => 'ResourceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the hardware security module (HSM).'."\n", 'type' => 'string', 'required' => true, 'example' => 'hsm-2ze0qae64mjuc0ni****', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rg-aek2tsvbnfe****', 'title' => ''], ], [ 'name' => 'ResourceType', 'in' => 'query', 'schema' => ['description' => 'The type of the resource.'."\n", 'type' => 'string', 'required' => true, 'example' => 'instance', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '4C467B38-3910-447D-87BC-AC049166F216', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidApiParam.Error', 'errorMessage' => 'Parameter is invalid.', 'description' => 'Illegal parameter'], ], 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'caller has no permission.', 'description' => 'User does not have permission to use.'], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => 'Unknown error caused request processing to fail.'], ], ], 'title' => 'MoveResourceGroup', 'summary' => 'Moves a resource to a new resource group.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:MoveResourceGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C467B38-3910-447D-87BC-AC049166F216\\"\\n}","type":"json"}]', ], 'PauseInstance' => [ 'summary' => 'Disables a hardware security module (HSM).', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREhsmV7VE3Y', 'FEATUREhsm01FLNB', 'FEATUREhsmGIFYCG', 'FEATUREhsmLBBV5W'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the HSM.', 'type' => 'string', 'required' => true, 'example' => 'hsm-cn-vj30bil8****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'BaseResult', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4C467B38-3910-447D-87BC-AC049366F216', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'SwitchMaster.InstanceInvalid', 'errorMessage' => 'Instance not in the cluster.', 'description' => ''], ['errorCode' => 'LeaveCluster.MasterLast', 'errorMessage' => 'Master instance can not leave a cluster until all other instances are left.', 'description' => ''], ['errorCode' => 'Certificate.ChainInvalid', 'errorMessage' => 'Certificate chain invalid. Please make sure issuer certificate is the trust anchor and cluster certificate is signed by issuer certificate.', 'description' => ''], ['errorCode' => 'Certificate.FormatInvalid', 'errorMessage' => 'Certificate format invalid. Cluster/Issuer certificate must be in PEM format.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.DuplicateZone', 'errorMessage' => 'VSwitches should not contain duplicate zones.', 'description' => ''], ['errorCode' => 'InvalidApiParam.Error', 'errorMessage' => 'api param is invalid', 'description' => ''], ['errorCode' => 'InvalidClusterName', 'errorMessage' => 'Invalid parameter clusterName.', 'description' => ''], ['errorCode' => 'InvalidPageSize', 'errorMessage' => 'Invalid parameter pageSize.', 'description' => ''], ['errorCode' => 'InvalidCurrentPage', 'errorMessage' => 'Invalid parameter currentPage.', 'description' => ''], ['errorCode' => 'InvalidRegionId', 'errorMessage' => 'Invalid parameter regionId.', 'description' => ''], ['errorCode' => 'InvalidVSwitch', 'errorMessage' => 'Invalid parameter vSwitch.', 'description' => ''], ['errorCode' => 'InvalidVpc', 'errorMessage' => 'Invalid parameter vpcId.', 'description' => ''], ['errorCode' => 'InvalidIp', 'errorMessage' => 'Invalid parameter IP.', 'description' => ''], ['errorCode' => 'InvalidAliuid', 'errorMessage' => 'Invalid parameter aliuid.', 'description' => ''], ['errorCode' => 'InvalidClusterId', 'errorMessage' => 'Invalid parameter clusterId.', 'description' => ''], ['errorCode' => 'InvalidInstanceId', 'errorMessage' => 'Invalid parameter instanceId.', 'description' => ''], ['errorCode' => 'InvalidBackupId', 'errorMessage' => 'Invalid parameter backupId.', 'description' => ''], ['errorCode' => 'InvalidImageId', 'errorMessage' => 'Invalid parameter imageId.', 'description' => ''], ['errorCode' => 'HsmInstanceNotExist.Error', 'errorMessage' => 'hsm instance not exist', 'description' => ''], ['errorCode' => 'HSMIntanceNotActived.Error', 'errorMessage' => 'hsm intance is not actived', 'description' => ''], ['errorCode' => 'WhiteListMaxCount.Error', 'errorMessage' => 'whilte list is more than max count', 'description' => ''], ['errorCode' => 'ClusterIdIsNotExists.Error', 'errorMessage' => 'cluster ID non-exists', 'description' => ''], ['errorCode' => 'InstanceListIsEmpty.Error', 'errorMessage' => 'instance list is empty', 'description' => ''], ['errorCode' => 'InstanceIdIsEmpty.Error', 'errorMessage' => 'instance id is empty', 'description' => ''], ['errorCode' => 'InstanceIsNotExistsInCluster.Error', 'errorMessage' => 'cluster has no such instance', 'description' => ''], ['errorCode' => 'InstanceIsExistsInCluster.Error', 'errorMessage' => 'instance already in the cluster', 'description' => ''], ['errorCode' => 'RegionNoEmpty.Error', 'errorMessage' => 'region no. is empty', 'description' => ''], ['errorCode' => 'ClusterNameEmpty.Error', 'errorMessage' => 'empty cluster name not allowed', 'description' => ''], ['errorCode' => 'ClusterNameIsExists.Error', 'errorMessage' => 'the cluster name is already taken', 'description' => ''], ['errorCode' => 'IpNotValid.Error', 'errorMessage' => 'ip not valid', 'description' => ''], ['errorCode' => 'ClusterIsEmpty.Error', 'errorMessage' => 'cluster is empty', 'description' => ''], ['errorCode' => 'NoMasterFoundInCluster.Error', 'errorMessage' => 'cluster has no master instance', 'description' => ''], ['errorCode' => 'HsmInstanceIdNotFound.Error', 'errorMessage' => 'no such instance', 'description' => ''], ['errorCode' => 'NoInstanceFoundInCluster.Error', 'errorMessage' => 'cluster is empty', 'description' => ''], ['errorCode' => 'Whitelist.Invalid', 'errorMessage' => 'Whitelist blocks not in CIDR format.', 'description' => ''], ['errorCode' => 'Whitelist.TooLong', 'errorMessage' => 'Whitelist too long, exceeds 10 CIDR blocks.', 'description' => ''], ], 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'Caller has no permission on the resource.', 'description' => ''], ['errorCode' => 'InstanceNotPaused', 'errorMessage' => 'Please pause the instance before reset.', 'description' => ''], ], [ ['errorCode' => 'Resource.NotFound', 'errorMessage' => 'Resource not found.', 'description' => ''], ], [ ['errorCode' => 'ClusterAPI.NotSupported', 'errorMessage' => 'ClusterAPI not supported in this region.', 'description' => ''], ], 409 => [ ['errorCode' => 'SwitchMaster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'Cluster.Conflict', 'errorMessage' => 'The cluster is being updated by a previous request. Please try again later.', 'description' => ''], ['errorCode' => 'SyncCluster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'LeaveCluster.InstanceInvalid', 'errorMessage' => 'The instance is not in the cluster.', 'description' => ''], ['errorCode' => 'DeleteCluster.IncorrectState', 'errorMessage' => 'Cluster not empty, please remove all instances first.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceVSwitchNotInCluster', 'errorMessage' => 'Instance\'s vSwitch is not in cluster config, please change instance\'s vSwitch first.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceInitialized', 'errorMessage' => 'Initialized instance can not join a cluster.', 'description' => ''], ['errorCode' => 'JoinCluster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'InitializeCluster.InstanceNotInitialized', 'errorMessage' => 'Cluster master instance not initialized, please initialize cluster master instance first.', 'description' => ''], ['errorCode' => 'InitializeCluster.IncorrectConfig', 'errorMessage' => 'Cluster subnet not configured, please config cluster subnet first.', 'description' => ''], ['errorCode' => 'InitializeCluster.IncorrectState', 'errorMessage' => 'Cluster initialized, do not re-initialize.', 'description' => ''], ['errorCode' => 'Cluster.CN.ActionForbidden', 'errorMessage' => 'This API is forbidden for non-international site cluster.', 'description' => ''], ['errorCode' => 'Cluster.INTL.ActionForbidden', 'errorMessage' => 'This API is forbidden for international site cluster.', 'description' => ''], ['errorCode' => 'ConfigClusterCertificate.IncorrectState', 'errorMessage' => 'Cluster initialized or certificates already configured.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.InvalidVpcId', 'errorMessage' => 'VPC Id invalid. Cluster VPC is the same as cluster master\'s VPC.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.InvalidVSwitchId', 'errorMessage' => 'VSwitch Id invalid. VSwitches should contain all current cluster vSwitches.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.IncorrectState', 'errorMessage' => 'Cluster not in NEW state, can not config cluster subnet.', 'description' => ''], ['errorCode' => 'ClusterName.Exist', 'errorMessage' => 'Cluster name already exists, please use another name.', 'description' => ''], ['errorCode' => 'Conflict', 'errorMessage' => 'Resource is being updated by a previous request. Current request is redundant.', 'description' => ''], ['errorCode' => 'ConfigIp.IncorrectState', 'errorMessage' => 'Instance not in pending or active state, can not config IP address.', 'description' => ''], ], 500 => [ ['errorCode' => 'ConfigWhitelistFailed.Error', 'errorMessage' => 'config white list error', 'description' => ''], ['errorCode' => 'ActionFailed.Error', 'errorMessage' => 'internal error, please try again', 'description' => ''], ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => 'Unknown error caused request processing to fail.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'PauseInstance', 'description' => 'After you disable an HSM, the relevant service operations fail. Proceed with caution.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:PauseInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C467B38-3910-447D-87BC-AC049366F216\\"\\n}","type":"json"}]', ], 'QuickDeployCluster' => [ 'summary' => 'Deploys a cluster quickly.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREhsmV7VE3Y', 'FEATUREhsm01FLNB'], ], 'parameters' => [ [ 'name' => 'VSwitchIdList', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'array', 'items' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'required' => false, 'example' => 'vsw-2zeqkh8ar8yey5ejv****'."\n", 'title' => ''], 'required' => true, 'description' => 'The list of vSwitches for the cluster.', 'title' => '', 'example' => '', ], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => ['description' => 'The ID of the VPC to which the HSM instance belongs.', 'type' => 'string', 'required' => true, 'example' => 'vpc-7xvkh90cw39p0****', 'title' => ''], ], [ 'name' => 'WhiteList', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'array', 'items' => ['description' => 'The cluster access whitelist.', 'type' => 'string', 'required' => false, 'example' => '18.68.XX.XX'."\n", 'title' => ''], 'description' => 'The access whitelist for the cluster.', 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'InstanceList', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'array', 'items' => ['description' => 'The ID of the HSM instance.', 'type' => 'string', 'required' => false, 'example' => 'hsm-cn-vj30bil8****'."\n", 'title' => ''], 'required' => true, 'description' => 'The list of HSM instances.', 'title' => '', 'example' => '', ], ], [ 'name' => 'ClusterName', 'in' => 'query', 'schema' => ['description' => 'The cluster name.', 'type' => 'string', 'required' => true, 'example' => 'cluster_on****'."\n", 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'CertManaged', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to automatically generate a certificate.'."\n" ."\n" .'- true: Yes'."\n" .'- false: No', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4C467B38-3910-447D-87BC-AC049166F216', 'title' => ''], 'Job' => [ 'type' => 'object', 'properties' => [ 'JobId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'job-202401250936hze747fd7e0007005', 'title' => ''], 'Type' => ['description' => 'The operation type.'."\n" ."\n" .'- create: Creates a task.'."\n" .'- cancel: Cancels a task.', 'type' => 'string', 'example' => 'create', 'title' => ''], 'Completed' => ['description' => 'Indicates whether the task is complete.'."\n" ."\n" .'- true: Yes'."\n" .'- false: No', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'CreateTime' => ['description' => 'The time when the task was created. This is a UNIX timestamp in milliseconds.', 'type' => 'string', 'example' => '1653274407000', 'title' => ''], 'Status' => ['description' => 'The status of the task.'."\n" ."\n" .'- success: The task is successful.'."\n" .'- running: The task is in progress.'."\n" .'- cancel: The task is canceled.'."\n" .'- fail: The task failed.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Response' => ['description' => 'The response that is returned if the task is successful.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Error' => ['description' => 'The error message that is returned if the task fails.', 'type' => 'string', 'example' => 'OperationTimeout', 'title' => ''], 'Progress' => ['description' => 'The progress of the task. Unit: percent.', 'type' => 'integer', 'format' => 'int32', 'example' => '86', 'title' => ''], ], 'description' => 'The details of the task.', 'title' => '', 'example' => '', ], ], 'title' => '', 'description' => 'The return value.', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidApiParam.Error', 'errorMessage' => 'api param is invalid', 'description' => ''], ['errorCode' => 'InvalidVSwitch', 'errorMessage' => 'Invalid parameter vSwitch', 'description' => ''], ['errorCode' => 'Whitelist.TooLong', 'errorMessage' => 'Whitelist too long, exceeds 10 CIDR blocks.', 'description' => ''], ], 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'caller has no permission', 'description' => ''], ['errorCode' => 'QuickDeployCluster.InstanceAlreadyInitialized', 'errorMessage' => 'Instance already initialized.', 'description' => ''], ['errorCode' => 'QuickDeployCluster.InstanceIncorrectState', 'errorMessage' => 'Instance not in Enable/Pending state.', 'description' => ''], ['errorCode' => 'QuickDeployCluster.InstanceInvalidRegion', 'errorMessage' => 'Instance region invalid.', 'description' => ''], ['errorCode' => 'QuickDeployCluster.InstanceVersionInvalid', 'errorMessage' => 'Instance device version is invalid', 'description' => ''], ['errorCode' => 'QuickDeployCluster.InstanceListInvalid', 'errorMessage' => 'Cluster contains instances not in the instance list.', 'description' => ''], ['errorCode' => 'QuickDeployCluster.InstanceBelongsToOtherCluster', 'errorMessage' => 'Instance has been in other cluster.', 'description' => ''], ['errorCode' => 'QuickDeployCluster.InvalidVpcId', 'errorMessage' => 'The param vpcId is not the same as existed vpcId of cluster.', 'description' => ''], ['errorCode' => 'QuickDeployCluster.InvalidVSwitchIdCount', 'errorMessage' => 'VSwitch count is less than 2.', 'description' => ''], ['errorCode' => 'QuickDeployCluster.DuplicateZone', 'errorMessage' => 'VSwitches should not contain duplicate zones.', 'description' => ''], ['errorCode' => 'QuickDeployCluster.InstanceCountInvalid', 'errorMessage' => 'Instance number less than 2.', 'description' => ''], ['errorCode' => 'QuickDeployCluster.InstanceTypeInvalid', 'errorMessage' => 'Instance type invalid.', 'description' => ''], ['errorCode' => 'QuickDeployCluster.InstanceTypeNotSame', 'errorMessage' => 'Instance type not same.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => 'Unknown error caused request processing to fail.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'QuickDeployCluster', 'description' => '- You must select HSM instances from at least two zones.'."\n" .'- You must select at least two vSwitches from different zones.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'yundun-hsm:QuickDeployCluster', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C467B38-3910-447D-87BC-AC049166F216\\",\\n \\"Job\\": {\\n \\"JobId\\": \\"job-202401250936hze747fd7e0007005\\",\\n \\"Type\\": \\"create\\",\\n \\"Completed\\": true,\\n \\"CreateTime\\": \\"1653274407000\\",\\n \\"Status\\": \\"success\\",\\n \\"Response\\": \\"success\\",\\n \\"Error\\": \\"OperationTimeout\\",\\n \\"Progress\\": 86\\n }\\n}","type":"json"}]', ], 'QuickInitInstance' => [ 'summary' => 'Initializes an instance.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREhsmV7VE3Y', 'FEATUREhsm01FLNB', 'FEATUREhsmGIFYCG', 'FEATUREhsmLBBV5W'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the HSM instance.', 'type' => 'string', 'required' => true, 'example' => 'hsm-cn-mp90fxef****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'PlainResult', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request. Alibaba Cloud generates a unique ID for each request. You can use the request ID to troubleshoot issues.', 'type' => 'string', 'example' => '4C467B38-3910-447D-87BC-AC049366F216', 'title' => ''], 'Job' => [ 'description' => 'The details of the task.', 'type' => 'object', 'properties' => [ 'JobId' => ['description' => 'The ID of the task.', 'type' => 'string', 'example' => 'job-000fi9k1v2hclo321sal', 'title' => ''], 'Type' => [ 'description' => 'The type of the operation.'."\n" ."\n" .'- create: Creates a task.'."\n" ."\n" .'- cancel: Cancels a task.', 'enumValueTitles' => [], 'type' => 'string', 'example' => 'create', 'title' => '', ], 'Completed' => ['description' => 'Indicates whether the task is complete.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'CreateTime' => ['description' => 'The time when the task was created. This value is a UNIX timestamp. Unit: milliseconds.', 'type' => 'string', 'example' => '1699515963000', 'title' => ''], 'Status' => [ 'description' => 'The status of the task.'."\n" ."\n" .'- success: The task is successful.'."\n" ."\n" .'- running: The task is in progress.'."\n" ."\n" .'- canceled: The task is canceled.'."\n" ."\n" .'- fail: The task failed.', 'enumValueTitles' => [], 'type' => 'string', 'example' => 'success', 'title' => '', ], 'Response' => ['description' => 'The response returned after the task is successful.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Error' => ['description' => 'The error message returned if the task fails.', 'type' => 'string', 'example' => 'OperationTimeout', 'title' => ''], 'Progress' => ['description' => 'The progress of the task. Unit: percent.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'SwitchMaster.InstanceInvalid', 'errorMessage' => 'Instance not in the cluster.', 'description' => ''], ['errorCode' => 'LeaveCluster.MasterLast', 'errorMessage' => 'Master instance can not leave a cluster until all other instances are left.', 'description' => ''], ['errorCode' => 'Certificate.ChainInvalid', 'errorMessage' => 'Certificate chain invalid. Please make sure issuer certificate is the trust anchor and cluster certificate is signed by issuer certificate.', 'description' => ''], ['errorCode' => 'Certificate.FormatInvalid', 'errorMessage' => 'Certificate format invalid. Cluster/Issuer certificate must be in PEM format.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.DuplicateZone', 'errorMessage' => 'VSwitches should not contain duplicate zones.', 'description' => ''], ['errorCode' => 'InvalidApiParam.Error', 'errorMessage' => 'api param is invalid', 'description' => ''], ['errorCode' => 'InvalidClusterName', 'errorMessage' => 'Invalid parameter clusterName.', 'description' => ''], ['errorCode' => 'InvalidPageSize', 'errorMessage' => 'Invalid parameter pageSize.', 'description' => ''], ['errorCode' => 'InvalidCurrentPage', 'errorMessage' => 'Invalid parameter currentPage.', 'description' => ''], ['errorCode' => 'InvalidRegionId', 'errorMessage' => 'Invalid parameter regionId.', 'description' => ''], ['errorCode' => 'InvalidVSwitch', 'errorMessage' => 'Invalid parameter vSwitch.', 'description' => ''], ['errorCode' => 'InvalidVpc', 'errorMessage' => 'Invalid parameter vpcId.', 'description' => ''], ['errorCode' => 'InvalidIp', 'errorMessage' => 'Invalid parameter IP.', 'description' => ''], ['errorCode' => 'InvalidAliuid', 'errorMessage' => 'Invalid parameter aliuid.', 'description' => ''], ['errorCode' => 'InvalidClusterId', 'errorMessage' => 'Invalid parameter clusterId.', 'description' => ''], ['errorCode' => 'InvalidInstanceId', 'errorMessage' => 'Invalid parameter instanceId.', 'description' => ''], ['errorCode' => 'InvalidBackupId', 'errorMessage' => 'Invalid parameter backupId.', 'description' => ''], ['errorCode' => 'InvalidImageId', 'errorMessage' => 'Invalid parameter imageId.', 'description' => ''], ['errorCode' => 'HsmInstanceNotExist.Error', 'errorMessage' => 'hsm instance not exist', 'description' => ''], ['errorCode' => 'HSMIntanceNotActived.Error', 'errorMessage' => 'hsm intance is not actived', 'description' => ''], ['errorCode' => 'WhiteListMaxCount.Error', 'errorMessage' => 'whilte list is more than max count', 'description' => ''], ['errorCode' => 'ClusterIdIsNotExists.Error', 'errorMessage' => 'cluster ID non-exists', 'description' => ''], ['errorCode' => 'InstanceListIsEmpty.Error', 'errorMessage' => 'instance list is empty', 'description' => ''], ['errorCode' => 'InstanceIdIsEmpty.Error', 'errorMessage' => 'instance id is empty', 'description' => ''], ['errorCode' => 'InstanceIsNotExistsInCluster.Error', 'errorMessage' => 'cluster has no such instance', 'description' => ''], ['errorCode' => 'InstanceIsExistsInCluster.Error', 'errorMessage' => 'instance already in the cluster', 'description' => ''], ['errorCode' => 'RegionNoEmpty.Error', 'errorMessage' => 'region no. is empty', 'description' => ''], ['errorCode' => 'ClusterNameEmpty.Error', 'errorMessage' => 'empty cluster name not allowed', 'description' => ''], ['errorCode' => 'ClusterNameIsExists.Error', 'errorMessage' => 'the cluster name is already taken', 'description' => ''], ['errorCode' => 'IpNotValid.Error', 'errorMessage' => 'ip not valid', 'description' => ''], ['errorCode' => 'ClusterIsEmpty.Error', 'errorMessage' => 'cluster is empty', 'description' => ''], ['errorCode' => 'NoMasterFoundInCluster.Error', 'errorMessage' => 'cluster has no master instance', 'description' => ''], ['errorCode' => 'HsmInstanceIdNotFound.Error', 'errorMessage' => 'no such instance', 'description' => ''], ['errorCode' => 'NoInstanceFoundInCluster.Error', 'errorMessage' => 'cluster is empty', 'description' => ''], ['errorCode' => 'Whitelist.Invalid', 'errorMessage' => 'Whitelist blocks not in CIDR format.', 'description' => ''], ['errorCode' => 'Whitelist.TooLong', 'errorMessage' => 'Whitelist too long, exceeds 10 CIDR blocks.', 'description' => ''], ], 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'Caller has no permission on the resource.', 'description' => ''], ['errorCode' => 'InstanceNotPaused', 'errorMessage' => 'Please pause the instance before reset.', 'description' => ''], ['errorCode' => 'InstanceNotActive', 'errorMessage' => 'Instance is not active.', 'description' => ''], ['errorCode' => 'ConfigIp.IncorrectState', 'errorMessage' => 'Instance not in pending or active state, can not config IP address.', 'description' => ''], ['errorCode' => 'SwitchMaster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'SyncCluster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'LeaveCluster.InstanceInvalid', 'errorMessage' => 'The instance is not in the cluster.', 'description' => ''], ['errorCode' => 'DeleteCluster.IncorrectState', 'errorMessage' => 'Cluster not empty, please remove all instances first.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceVSwitchNotInCluster', 'errorMessage' => 'Instance\'s vSwitch is not in cluster config, please change instance\'s vSwitch first.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceInitialized', 'errorMessage' => 'Initialized instance can not join a cluster.', 'description' => ''], ['errorCode' => 'JoinCluster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'InitializeCluster.InstanceNotInitialized', 'errorMessage' => 'Cluster master instance not initialized, please initialize cluster master instance first.', 'description' => ''], ['errorCode' => 'InitializeCluster.IncorrectConfig', 'errorMessage' => 'Cluster subnet not configured, please config cluster subnet first.', 'description' => ''], ['errorCode' => 'InitializeCluster.IncorrectState', 'errorMessage' => 'Cluster initialized, do not re-initialize.', 'description' => ''], ['errorCode' => 'Cluster.CN.ActionForbidden', 'errorMessage' => 'This API is forbidden for non-international site cluster.', 'description' => ''], ['errorCode' => 'Cluster.INTL.ActionForbidden', 'errorMessage' => 'This API is forbidden for international site cluster.', 'description' => ''], ['errorCode' => 'ConfigClusterCertificate.IncorrectState', 'errorMessage' => 'Cluster initialized or certificates already configured.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.InvalidVpcId', 'errorMessage' => 'VPC Id invalid. Cluster VPC is the same as cluster master\'s VPC.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.InvalidVSwitchId', 'errorMessage' => 'VSwitch Id invalid. VSwitches should contain all current cluster vSwitches.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.IncorrectState', 'errorMessage' => 'Cluster not in NEW state, can not config cluster subnet.', 'description' => ''], ['errorCode' => 'ClusterName.Exist', 'errorMessage' => 'Cluster name already exists, please use another name.', 'description' => ''], ['errorCode' => 'Whitelist.InstanceInCluster', 'errorMessage' => 'Whitelist.InstanceInCluster', 'description' => ''], ], [ ['errorCode' => 'Resource.NotFound', 'errorMessage' => 'Resource not found.', 'description' => ''], ], [ ['errorCode' => 'ClusterAPI.NotSupported', 'errorMessage' => 'ClusterAPI not supported in this region.', 'description' => ''], ], 409 => [ ['errorCode' => 'Conflict', 'errorMessage' => 'Resource is being updated by a previous request. Current request is redundant.', 'description' => ''], ['errorCode' => 'Cluster.Conflict', 'errorMessage' => 'The cluster is being updated by a previous request. Please try again later.', 'description' => ''], ], 500 => [ ['errorCode' => 'ConfigWhitelistFailed.Error', 'errorMessage' => 'config white list error', 'description' => ''], ['errorCode' => 'ActionFailed.Error', 'errorMessage' => 'internal error, please try again', 'description' => ''], ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => 'Unknown error caused request processing to fail.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'QuickInitInstance', 'description' => 'This operation applies only to General-purpose Hardware Security Module (GVSM) instances in the Chinese mainland.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:QuickInitInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C467B38-3910-447D-87BC-AC049366F216\\",\\n \\"Job\\": {\\n \\"JobId\\": \\"job-000fi9k1v2hclo321sal\\",\\n \\"Type\\": \\"create\\",\\n \\"Completed\\": true,\\n \\"CreateTime\\": \\"1699515963000\\",\\n \\"Status\\": \\"success\\",\\n \\"Response\\": \\"success\\",\\n \\"Error\\": \\"OperationTimeout\\",\\n \\"Progress\\": 100\\n }\\n}","type":"json"}]', ], 'ResetBackup' => [ 'summary' => 'Disassociates a backup from a hardware security module (HSM).', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREhsmQEGDGS'], ], 'parameters' => [ [ 'name' => 'BackupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup.'."\n", 'type' => 'string', 'required' => false, 'example' => 'backup-fdb897sdfg5****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '4C467B38-3910-447D-87BC-AC049166F216'], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidApiParam.Error', 'errorMessage' => 'api param is invalid', 'description' => ''], ], 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'caller has no permission', 'description' => ''], ['errorCode' => 'Backup.ActionForbidden', 'errorMessage' => 'This API is forbidden for this backup type.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => 'Unknown error caused request processing to fail.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ResetBackup', 'description' => 'This operation is available only for HSMs in the Chinese mainland.'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:ResetBackup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C467B38-3910-447D-87BC-AC049166F216\\"\\n}","type":"json"}]', ], 'ResetInstance' => [ 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREhsmV7VE3Y', 'FEATUREhsmGIFYCG', 'FEATUREhsm01FLNB', 'FEATUREhsmLBBV5W'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the HSM.', 'type' => 'string', 'required' => true, 'example' => 'hsm-cn-vj30bil8****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'PlainResult', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4C467B38-3910-447D-87BC-AC049166F216', 'title' => ''], 'Job' => [ 'description' => 'The details of the task.', 'type' => 'object', 'properties' => [ 'JobId' => ['description' => 'The ID of the task.', 'type' => 'string', 'example' => 'job-0007bl8oev0u3jqyfu6a', 'title' => ''], 'Type' => [ 'description' => 'The operation type. Valid values:'."\n" ."\n" .'- create'."\n" ."\n" .'- cancel', 'enumValueTitles' => [], 'type' => 'string', 'example' => 'create', 'title' => '', ], 'Completed' => ['description' => 'Indicates whether the task is complete.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'CreateTime' => ['description' => 'The time when the task is created. The value is accurate to the millisecond. The value is a UNIX timestamp.', 'type' => 'string', 'example' => '1653274407000', 'title' => ''], 'Status' => [ 'description' => 'The task status. Valid values:'."\n" ."\n" .'- success'."\n" ."\n" .'- running'."\n" ."\n" .'- cancel'."\n" ."\n" .'- fail', 'enumValueTitles' => [], 'type' => 'string', 'example' => 'success', 'title' => '', ], 'Response' => ['description' => 'The response returned after the task succeeds.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Error' => ['description' => 'The error message returned if the task fails.', 'type' => 'string', 'example' => 'OperationTimeout', 'title' => ''], 'Progress' => ['description' => 'The progress of the task. Unit: percent (%).', 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'SwitchMaster.InstanceInvalid', 'errorMessage' => 'Instance not in the cluster.', 'description' => ''], ['errorCode' => 'LeaveCluster.MasterLast', 'errorMessage' => 'Master instance can not leave a cluster until all other instances are left.', 'description' => ''], ['errorCode' => 'Certificate.ChainInvalid', 'errorMessage' => 'Certificate chain invalid. Please make sure issuer certificate is the trust anchor and cluster certificate is signed by issuer certificate.', 'description' => ''], ['errorCode' => 'Certificate.FormatInvalid', 'errorMessage' => 'Certificate format invalid. Cluster/Issuer certificate must be in PEM format.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.DuplicateZone', 'errorMessage' => 'VSwitches should not contain duplicate zones.', 'description' => ''], ['errorCode' => 'InvalidApiParam.Error', 'errorMessage' => 'api param is invalid', 'description' => ''], ['errorCode' => 'InvalidClusterName', 'errorMessage' => 'Invalid parameter clusterName.', 'description' => ''], ['errorCode' => 'InvalidPageSize', 'errorMessage' => 'Invalid parameter pageSize.', 'description' => ''], ['errorCode' => 'InvalidCurrentPage', 'errorMessage' => 'Invalid parameter currentPage.', 'description' => ''], ['errorCode' => 'InvalidRegionId', 'errorMessage' => 'Invalid parameter regionId.', 'description' => ''], ['errorCode' => 'InvalidVSwitch', 'errorMessage' => 'Invalid parameter vSwitch.', 'description' => ''], ['errorCode' => 'InvalidVpc', 'errorMessage' => 'Invalid parameter vpcId.', 'description' => ''], ['errorCode' => 'InvalidIp', 'errorMessage' => 'Invalid parameter IP.', 'description' => ''], ['errorCode' => 'InvalidAliuid', 'errorMessage' => 'Invalid parameter aliuid.', 'description' => ''], ['errorCode' => 'InvalidClusterId', 'errorMessage' => 'Invalid parameter clusterId.', 'description' => ''], ['errorCode' => 'InvalidInstanceId', 'errorMessage' => 'Invalid parameter instanceId.', 'description' => ''], ['errorCode' => 'InvalidBackupId', 'errorMessage' => 'Invalid parameter backupId.', 'description' => ''], ['errorCode' => 'InvalidImageId', 'errorMessage' => 'Invalid parameter imageId.', 'description' => ''], ['errorCode' => 'HsmInstanceNotExist.Error', 'errorMessage' => 'hsm instance not exist', 'description' => ''], ['errorCode' => 'HSMIntanceNotActived.Error', 'errorMessage' => 'hsm intance is not actived', 'description' => ''], ['errorCode' => 'WhiteListMaxCount.Error', 'errorMessage' => 'whilte list is more than max count', 'description' => ''], ['errorCode' => 'ClusterIdIsNotExists.Error', 'errorMessage' => 'cluster ID non-exists', 'description' => ''], ['errorCode' => 'InstanceListIsEmpty.Error', 'errorMessage' => 'instance list is empty', 'description' => ''], ['errorCode' => 'InstanceIdIsEmpty.Error', 'errorMessage' => 'instance id is empty', 'description' => ''], ['errorCode' => 'InstanceIsNotExistsInCluster.Error', 'errorMessage' => 'cluster has no such instance', 'description' => ''], ['errorCode' => 'InstanceIsExistsInCluster.Error', 'errorMessage' => 'instance already in the cluster', 'description' => ''], ['errorCode' => 'RegionNoEmpty.Error', 'errorMessage' => 'region no. is empty', 'description' => ''], ['errorCode' => 'ClusterNameEmpty.Error', 'errorMessage' => 'empty cluster name not allowed', 'description' => ''], ['errorCode' => 'ClusterNameIsExists.Error', 'errorMessage' => 'the cluster name is already taken', 'description' => ''], ['errorCode' => 'IpNotValid.Error', 'errorMessage' => 'ip not valid', 'description' => ''], ['errorCode' => 'ClusterIsEmpty.Error', 'errorMessage' => 'cluster is empty', 'description' => ''], ['errorCode' => 'NoMasterFoundInCluster.Error', 'errorMessage' => 'cluster has no master instance', 'description' => ''], ['errorCode' => 'HsmInstanceIdNotFound.Error', 'errorMessage' => 'no such instance', 'description' => ''], ['errorCode' => 'NoInstanceFoundInCluster.Error', 'errorMessage' => 'cluster is empty', 'description' => ''], ['errorCode' => 'Whitelist.Invalid', 'errorMessage' => 'Whitelist blocks not in CIDR format.', 'description' => ''], ['errorCode' => 'Whitelist.TooLong', 'errorMessage' => 'Whitelist too long, exceeds 10 CIDR blocks.', 'description' => ''], ], 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'Caller has no permission on the resource.', 'description' => ''], ['errorCode' => 'InstanceNotPaused', 'errorMessage' => 'Please pause the instance before reset.', 'description' => ''], ['errorCode' => 'InstanceNotActive', 'errorMessage' => 'Instance is not active.', 'description' => ''], ['errorCode' => 'ConfigIp.IncorrectState', 'errorMessage' => 'Instance not in pending or active state, can not config IP address.', 'description' => ''], ['errorCode' => 'SwitchMaster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'SyncCluster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'LeaveCluster.InstanceInvalid', 'errorMessage' => 'The instance is not in the cluster.', 'description' => ''], ['errorCode' => 'DeleteCluster.IncorrectState', 'errorMessage' => 'Cluster not empty, please remove all instances first.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceVSwitchNotInCluster', 'errorMessage' => 'Instance\'s vSwitch is not in cluster config, please change instance\'s vSwitch first.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceInitialized', 'errorMessage' => 'Initialized instance can not join a cluster.', 'description' => ''], ['errorCode' => 'JoinCluster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'InitializeCluster.InstanceNotInitialized', 'errorMessage' => 'Cluster master instance not initialized, please initialize cluster master instance first.', 'description' => ''], ['errorCode' => 'InitializeCluster.IncorrectConfig', 'errorMessage' => 'Cluster subnet not configured, please config cluster subnet first.', 'description' => ''], ['errorCode' => 'InitializeCluster.IncorrectState', 'errorMessage' => 'Cluster initialized, do not re-initialize.', 'description' => ''], ['errorCode' => 'Cluster.CN.ActionForbidden', 'errorMessage' => 'This API is forbidden for non-international site cluster.', 'description' => ''], ['errorCode' => 'Cluster.INTL.ActionForbidden', 'errorMessage' => 'This API is forbidden for international site cluster.', 'description' => ''], ['errorCode' => 'ConfigClusterCertificate.IncorrectState', 'errorMessage' => 'Cluster initialized or certificates already configured.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.InvalidVpcId', 'errorMessage' => 'VPC Id invalid. Cluster VPC is the same as cluster master\'s VPC.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.InvalidVSwitchId', 'errorMessage' => 'VSwitch Id invalid. VSwitches should contain all current cluster vSwitches.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.IncorrectState', 'errorMessage' => 'Cluster not in NEW state, can not config cluster subnet.', 'description' => ''], ['errorCode' => 'ClusterName.Exist', 'errorMessage' => 'Cluster name already exists, please use another name.', 'description' => ''], ['errorCode' => 'Whitelist.InstanceInCluster', 'errorMessage' => 'Whitelist.InstanceInCluster', 'description' => ''], ], [ ['errorCode' => 'Resource.NotFound', 'errorMessage' => 'Resource not found.', 'description' => ''], ], [ ['errorCode' => 'ClusterAPI.NotSupported', 'errorMessage' => 'ClusterAPI not supported in this region.', 'description' => ''], ], 409 => [ ['errorCode' => 'Conflict', 'errorMessage' => 'Resource is being updated by a previous request. Current request is redundant.', 'description' => ''], ['errorCode' => 'Cluster.Conflict', 'errorMessage' => 'The cluster is being updated by a previous request. Please try again later.', 'description' => ''], ], 500 => [ ['errorCode' => 'ConfigWhitelistFailed.Error', 'errorMessage' => 'config white list error', 'description' => ''], ['errorCode' => 'ActionFailed.Error', 'errorMessage' => 'internal error, please try again', 'description' => ''], ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => 'Unknown error caused request processing to fail.'], ], ], 'title' => 'ResetInstance', 'summary' => 'Resets a hardware security module (HSM).', 'description' => 'After an HSM is reset, all related data is deleted and cannot be recovered. Proceed with caution.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:ResetInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C467B38-3910-447D-87BC-AC049166F216\\",\\n \\"Job\\": {\\n \\"JobId\\": \\"job-0007bl8oev0u3jqyfu6a\\",\\n \\"Type\\": \\"create\\",\\n \\"Completed\\": true,\\n \\"CreateTime\\": \\"1653274407000\\",\\n \\"Status\\": \\"success\\",\\n \\"Response\\": \\"success\\",\\n \\"Error\\": \\"OperationTimeout\\",\\n \\"Progress\\": 80\\n }\\n}","type":"json"}]', ], 'RestoreInstance' => [ 'summary' => 'Restores instance data from an image.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREhsmV7VE3Y', 'FEATUREhsmGIFYCG', 'FEATUREhsm01FLNB', 'FEATUREhsmLBBV5W'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the HSM instance.', 'type' => 'string', 'required' => true, 'example' => 'hsm-cn-mp90fxef****', 'title' => ''], ], [ 'name' => 'ImageId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the image from which to restore the instance.', 'type' => 'string', 'required' => true, 'example' => 'image-eaOGHkRDQgh4****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'PlainResult', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request. This is a unique identifier that Alibaba Cloud generates for the request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '4C467B38-3910-447D-87BC-AC049366F216', 'title' => ''], 'Job' => [ 'description' => 'The details of the task.', 'type' => 'object', 'properties' => [ 'JobId' => ['description' => 'The ID of the task.', 'type' => 'string', 'example' => 'job-540356379023708160', 'title' => ''], 'Type' => ['description' => 'The type of operation.'."\n" ."\n" .'- create: Creates a task.'."\n" ."\n" .'- cancel: Cancels a task.', 'type' => 'string', 'example' => 'create', 'title' => ''], 'Completed' => ['description' => 'Indicates whether the task is complete.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'CreateTime' => ['description' => 'The time when the task was created. This is a UNIX timestamp, accurate to the millisecond.', 'type' => 'string', 'example' => '1711764127000', 'title' => ''], 'Status' => ['description' => 'The status of the task.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Response' => ['description' => 'The response returned after the task is successfully completed.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Error' => ['description' => 'The error message returned if the task fails.', 'type' => 'string', 'example' => 'OperationTimeout', 'title' => ''], 'Progress' => ['description' => 'The progress of the task execution, in percentage.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'SwitchMaster.InstanceInvalid', 'errorMessage' => 'Instance not in the cluster.', 'description' => ''], ['errorCode' => 'LeaveCluster.MasterLast', 'errorMessage' => 'Master instance can not leave a cluster until all other instances are left.', 'description' => ''], ['errorCode' => 'Certificate.ChainInvalid', 'errorMessage' => 'Certificate chain invalid. Please make sure issuer certificate is the trust anchor and cluster certificate is signed by issuer certificate.', 'description' => ''], ['errorCode' => 'Certificate.FormatInvalid', 'errorMessage' => 'Certificate format invalid. Cluster/Issuer certificate must be in PEM format.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.DuplicateZone', 'errorMessage' => 'VSwitches should not contain duplicate zones.', 'description' => ''], ['errorCode' => 'InvalidApiParam.Error', 'errorMessage' => 'api param is invalid', 'description' => ''], ['errorCode' => 'InvalidClusterName', 'errorMessage' => 'Invalid parameter clusterName.', 'description' => ''], ['errorCode' => 'InvalidPageSize', 'errorMessage' => 'Invalid parameter pageSize.', 'description' => ''], ['errorCode' => 'InvalidCurrentPage', 'errorMessage' => 'Invalid parameter currentPage.', 'description' => ''], ['errorCode' => 'InvalidRegionId', 'errorMessage' => 'Invalid parameter regionId.', 'description' => ''], ['errorCode' => 'InvalidVSwitch', 'errorMessage' => 'Invalid parameter vSwitch.', 'description' => ''], ['errorCode' => 'InvalidVpc', 'errorMessage' => 'Invalid parameter vpcId.', 'description' => ''], ['errorCode' => 'InvalidIp', 'errorMessage' => 'Invalid parameter IP.', 'description' => ''], ['errorCode' => 'InvalidAliuid', 'errorMessage' => 'Invalid parameter aliuid.', 'description' => ''], ['errorCode' => 'InvalidClusterId', 'errorMessage' => 'Invalid parameter clusterId.', 'description' => ''], ['errorCode' => 'InvalidInstanceId', 'errorMessage' => 'Invalid parameter instanceId.', 'description' => ''], ['errorCode' => 'InvalidBackupId', 'errorMessage' => 'Invalid parameter backupId.', 'description' => ''], ['errorCode' => 'InvalidImageId', 'errorMessage' => 'Invalid parameter imageId.', 'description' => ''], ['errorCode' => 'HsmInstanceNotExist.Error', 'errorMessage' => 'hsm instance not exist', 'description' => ''], ['errorCode' => 'HSMIntanceNotActived.Error', 'errorMessage' => 'hsm intance is not actived', 'description' => ''], ['errorCode' => 'WhiteListMaxCount.Error', 'errorMessage' => 'whilte list is more than max count', 'description' => ''], ['errorCode' => 'ClusterIdIsNotExists.Error', 'errorMessage' => 'cluster ID non-exists', 'description' => ''], ['errorCode' => 'InstanceListIsEmpty.Error', 'errorMessage' => 'instance list is empty', 'description' => ''], ['errorCode' => 'InstanceIdIsEmpty.Error', 'errorMessage' => 'instance id is empty', 'description' => ''], ['errorCode' => 'InstanceIsNotExistsInCluster.Error', 'errorMessage' => 'cluster has no such instance', 'description' => ''], ['errorCode' => 'InstanceIsExistsInCluster.Error', 'errorMessage' => 'instance already in the cluster', 'description' => ''], ['errorCode' => 'RegionNoEmpty.Error', 'errorMessage' => 'region no. is empty', 'description' => ''], ['errorCode' => 'ClusterNameEmpty.Error', 'errorMessage' => 'empty cluster name not allowed', 'description' => ''], ['errorCode' => 'ClusterNameIsExists.Error', 'errorMessage' => 'the cluster name is already taken', 'description' => ''], ['errorCode' => 'IpNotValid.Error', 'errorMessage' => 'ip not valid', 'description' => ''], ['errorCode' => 'ClusterIsEmpty.Error', 'errorMessage' => 'cluster is empty', 'description' => ''], ['errorCode' => 'NoMasterFoundInCluster.Error', 'errorMessage' => 'cluster has no master instance', 'description' => ''], ['errorCode' => 'HsmInstanceIdNotFound.Error', 'errorMessage' => 'no such instance', 'description' => ''], ['errorCode' => 'NoInstanceFoundInCluster.Error', 'errorMessage' => 'cluster is empty', 'description' => ''], ['errorCode' => 'Whitelist.Invalid', 'errorMessage' => 'Whitelist blocks not in CIDR format.', 'description' => ''], ['errorCode' => 'Whitelist.TooLong', 'errorMessage' => 'Whitelist too long, exceeds 10 CIDR blocks.', 'description' => ''], ], 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'Caller has no permission on the resource.', 'description' => ''], ['errorCode' => 'InstanceNotPaused', 'errorMessage' => 'Please pause the instance before reset.', 'description' => ''], ['errorCode' => 'InstanceNotActive', 'errorMessage' => 'Instance is not active.', 'description' => ''], ['errorCode' => 'ConfigIp.IncorrectState', 'errorMessage' => 'Instance not in pending or active state, can not config IP address.', 'description' => ''], ['errorCode' => 'SwitchMaster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'SyncCluster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'LeaveCluster.InstanceInvalid', 'errorMessage' => 'The instance is not in the cluster.', 'description' => ''], ['errorCode' => 'DeleteCluster.IncorrectState', 'errorMessage' => 'Cluster not empty, please remove all instances first.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceVSwitchNotInCluster', 'errorMessage' => 'Instance\'s vSwitch is not in cluster config, please change instance\'s vSwitch first.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceInitialized', 'errorMessage' => 'Initialized instance can not join a cluster.', 'description' => ''], ['errorCode' => 'JoinCluster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'InitializeCluster.InstanceNotInitialized', 'errorMessage' => 'Cluster master instance not initialized, please initialize cluster master instance first.', 'description' => ''], ['errorCode' => 'InitializeCluster.IncorrectConfig', 'errorMessage' => 'Cluster subnet not configured, please config cluster subnet first.', 'description' => ''], ['errorCode' => 'InitializeCluster.IncorrectState', 'errorMessage' => 'Cluster initialized, do not re-initialize.', 'description' => ''], ['errorCode' => 'Cluster.CN.ActionForbidden', 'errorMessage' => 'This API is forbidden for non-international site cluster.', 'description' => ''], ['errorCode' => 'Cluster.INTL.ActionForbidden', 'errorMessage' => 'This API is forbidden for international site cluster.', 'description' => ''], ['errorCode' => 'ConfigClusterCertificate.IncorrectState', 'errorMessage' => 'Cluster initialized or certificates already configured.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.InvalidVpcId', 'errorMessage' => 'VPC Id invalid. Cluster VPC is the same as cluster master\'s VPC.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.InvalidVSwitchId', 'errorMessage' => 'VSwitch Id invalid. VSwitches should contain all current cluster vSwitches.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.IncorrectState', 'errorMessage' => 'Cluster not in NEW state, can not config cluster subnet.', 'description' => ''], ['errorCode' => 'ClusterName.Exist', 'errorMessage' => 'Cluster name already exists, please use another name.', 'description' => ''], ['errorCode' => 'Whitelist.InstanceInCluster', 'errorMessage' => 'Whitelist.InstanceInCluster', 'description' => ''], ], [ ['errorCode' => 'Resource.NotFound', 'errorMessage' => 'Resource not found.', 'description' => ''], ], [ ['errorCode' => 'ClusterAPI.NotSupported', 'errorMessage' => 'ClusterAPI not supported in this region.', 'description' => ''], ], 409 => [ ['errorCode' => 'Conflict', 'errorMessage' => 'Resource is being updated by a previous request. Current request is redundant.', 'description' => ''], ['errorCode' => 'Cluster.Conflict', 'errorMessage' => 'The cluster is being updated by a previous request. Please try again later.', 'description' => ''], ], 500 => [ ['errorCode' => 'ConfigWhitelistFailed.Error', 'errorMessage' => 'config white list error', 'description' => ''], ['errorCode' => 'ActionFailed.Error', 'errorMessage' => 'internal error, please try again', 'description' => ''], ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => 'Unknown error caused request processing to fail.'], ], ], 'title' => 'RestoreInstance', 'description' => 'You can import an image to an instance only if the instance is stopped or disabled.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:RestoreInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C467B38-3910-447D-87BC-AC049366F216\\",\\n \\"Job\\": {\\n \\"JobId\\": \\"job-540356379023708160\\",\\n \\"Type\\": \\"create\\",\\n \\"Completed\\": true,\\n \\"CreateTime\\": \\"1711764127000\\",\\n \\"Status\\": \\"success\\",\\n \\"Response\\": \\"success\\",\\n \\"Error\\": \\"OperationTimeout\\",\\n \\"Progress\\": 50\\n }\\n}","type":"json"}]', ], 'ResumeInstance' => [ 'summary' => 'Resumes a deactivated instance.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREhsmV7VE3Y', 'FEATUREhsm01FLNB', 'FEATUREhsmGIFYCG', 'FEATUREhsmLBBV5W'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the HSM instance.', 'type' => 'string', 'required' => true, 'example' => 'hsm-cn-vj30bil8****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'BaseResult', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request. Alibaba Cloud generates this unique identifier for each request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '4C467B38-3910-447D-87BC-AC049166F216', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'SwitchMaster.InstanceInvalid', 'errorMessage' => 'Instance not in the cluster.', 'description' => ''], ['errorCode' => 'LeaveCluster.MasterLast', 'errorMessage' => 'Master instance can not leave a cluster until all other instances are left.', 'description' => ''], ['errorCode' => 'Certificate.ChainInvalid', 'errorMessage' => 'Certificate chain invalid. Please make sure issuer certificate is the trust anchor and cluster certificate is signed by issuer certificate.', 'description' => ''], ['errorCode' => 'Certificate.FormatInvalid', 'errorMessage' => 'Certificate format invalid. Cluster/Issuer certificate must be in PEM format.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.DuplicateZone', 'errorMessage' => 'VSwitches should not contain duplicate zones.', 'description' => ''], ['errorCode' => 'InvalidApiParam.Error', 'errorMessage' => 'api param is invalid', 'description' => ''], ['errorCode' => 'InvalidClusterName', 'errorMessage' => 'Invalid parameter clusterName.', 'description' => ''], ['errorCode' => 'InvalidPageSize', 'errorMessage' => 'Invalid parameter pageSize.', 'description' => ''], ['errorCode' => 'InvalidCurrentPage', 'errorMessage' => 'Invalid parameter currentPage.', 'description' => ''], ['errorCode' => 'InvalidRegionId', 'errorMessage' => 'Invalid parameter regionId.', 'description' => ''], ['errorCode' => 'InvalidVSwitch', 'errorMessage' => 'Invalid parameter vSwitch.', 'description' => ''], ['errorCode' => 'InvalidVpc', 'errorMessage' => 'Invalid parameter vpcId.', 'description' => ''], ['errorCode' => 'InvalidIp', 'errorMessage' => 'Invalid parameter IP.', 'description' => ''], ['errorCode' => 'InvalidAliuid', 'errorMessage' => 'Invalid parameter aliuid.', 'description' => ''], ['errorCode' => 'InvalidClusterId', 'errorMessage' => 'Invalid parameter clusterId.', 'description' => ''], ['errorCode' => 'InvalidInstanceId', 'errorMessage' => 'Invalid parameter instanceId.', 'description' => ''], ['errorCode' => 'InvalidBackupId', 'errorMessage' => 'Invalid parameter backupId.', 'description' => ''], ['errorCode' => 'InvalidImageId', 'errorMessage' => 'Invalid parameter imageId.', 'description' => ''], ['errorCode' => 'HsmInstanceNotExist.Error', 'errorMessage' => 'hsm instance not exist', 'description' => ''], ['errorCode' => 'HSMIntanceNotActived.Error', 'errorMessage' => 'hsm intance is not actived', 'description' => ''], ['errorCode' => 'WhiteListMaxCount.Error', 'errorMessage' => 'whilte list is more than max count', 'description' => ''], ['errorCode' => 'ClusterIdIsNotExists.Error', 'errorMessage' => 'cluster ID non-exists', 'description' => ''], ['errorCode' => 'InstanceListIsEmpty.Error', 'errorMessage' => 'instance list is empty', 'description' => ''], ['errorCode' => 'InstanceIdIsEmpty.Error', 'errorMessage' => 'instance id is empty', 'description' => ''], ['errorCode' => 'InstanceIsNotExistsInCluster.Error', 'errorMessage' => 'cluster has no such instance', 'description' => ''], ['errorCode' => 'InstanceIsExistsInCluster.Error', 'errorMessage' => 'instance already in the cluster', 'description' => ''], ['errorCode' => 'RegionNoEmpty.Error', 'errorMessage' => 'region no. is empty', 'description' => ''], ['errorCode' => 'ClusterNameEmpty.Error', 'errorMessage' => 'empty cluster name not allowed', 'description' => ''], ['errorCode' => 'ClusterNameIsExists.Error', 'errorMessage' => 'the cluster name is already taken', 'description' => ''], ['errorCode' => 'IpNotValid.Error', 'errorMessage' => 'ip not valid', 'description' => ''], ['errorCode' => 'ClusterIsEmpty.Error', 'errorMessage' => 'cluster is empty', 'description' => ''], ['errorCode' => 'NoMasterFoundInCluster.Error', 'errorMessage' => 'cluster has no master instance', 'description' => ''], ['errorCode' => 'HsmInstanceIdNotFound.Error', 'errorMessage' => 'no such instance', 'description' => ''], ['errorCode' => 'NoInstanceFoundInCluster.Error', 'errorMessage' => 'cluster is empty', 'description' => ''], ['errorCode' => 'Whitelist.Invalid', 'errorMessage' => 'Whitelist blocks not in CIDR format.', 'description' => ''], ['errorCode' => 'Whitelist.TooLong', 'errorMessage' => 'Whitelist too long, exceeds 10 CIDR blocks.', 'description' => ''], ], 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'Caller has no permission on the resource.', 'description' => ''], ['errorCode' => 'InstanceNotPaused', 'errorMessage' => 'Please pause the instance before reset.', 'description' => ''], ], [ ['errorCode' => 'Resource.NotFound', 'errorMessage' => 'Resource not found.', 'description' => ''], ], [ ['errorCode' => 'ClusterAPI.NotSupported', 'errorMessage' => 'ClusterAPI not supported in this region.', 'description' => ''], ], 409 => [ ['errorCode' => 'SwitchMaster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'Cluster.Conflict', 'errorMessage' => 'The cluster is being updated by a previous request. Please try again later.', 'description' => ''], ['errorCode' => 'SyncCluster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'LeaveCluster.InstanceInvalid', 'errorMessage' => 'The instance is not in the cluster.', 'description' => ''], ['errorCode' => 'DeleteCluster.IncorrectState', 'errorMessage' => 'Cluster not empty, please remove all instances first.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceVSwitchNotInCluster', 'errorMessage' => 'Instance\'s vSwitch is not in cluster config, please change instance\'s vSwitch first.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceInitialized', 'errorMessage' => 'Initialized instance can not join a cluster.', 'description' => ''], ['errorCode' => 'JoinCluster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'InitializeCluster.InstanceNotInitialized', 'errorMessage' => 'Cluster master instance not initialized, please initialize cluster master instance first.', 'description' => ''], ['errorCode' => 'InitializeCluster.IncorrectConfig', 'errorMessage' => 'Cluster subnet not configured, please config cluster subnet first.', 'description' => ''], ['errorCode' => 'InitializeCluster.IncorrectState', 'errorMessage' => 'Cluster initialized, do not re-initialize.', 'description' => ''], ['errorCode' => 'Cluster.CN.ActionForbidden', 'errorMessage' => 'This API is forbidden for non-international site cluster.', 'description' => ''], ['errorCode' => 'Cluster.INTL.ActionForbidden', 'errorMessage' => 'This API is forbidden for international site cluster.', 'description' => ''], ['errorCode' => 'ConfigClusterCertificate.IncorrectState', 'errorMessage' => 'Cluster initialized or certificates already configured.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.InvalidVpcId', 'errorMessage' => 'VPC Id invalid. Cluster VPC is the same as cluster master\'s VPC.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.InvalidVSwitchId', 'errorMessage' => 'VSwitch Id invalid. VSwitches should contain all current cluster vSwitches.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.IncorrectState', 'errorMessage' => 'Cluster not in NEW state, can not config cluster subnet.', 'description' => ''], ['errorCode' => 'ClusterName.Exist', 'errorMessage' => 'Cluster name already exists, please use another name.', 'description' => ''], ['errorCode' => 'Conflict', 'errorMessage' => 'Resource is being updated by a previous request. Current request is redundant.', 'description' => ''], ['errorCode' => 'ConfigIp.IncorrectState', 'errorMessage' => 'Instance not in pending or active state, can not config IP address.', 'description' => ''], ], 500 => [ ['errorCode' => 'ConfigWhitelistFailed.Error', 'errorMessage' => 'config white list error', 'description' => ''], ['errorCode' => 'ActionFailed.Error', 'errorMessage' => 'internal error, please try again', 'description' => ''], ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => 'Unknown error caused request processing to fail.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ResumeInstance', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:ResumeInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C467B38-3910-447D-87BC-AC049166F216\\"\\n}","type":"json"}]', ], 'RotateClusterManagedCert' => [ 'path' => '/', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREhsmV7VE3Y', 'FEATUREhsm01FLNB'], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'cluster-hfau****gkaud', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4C467B38-3910-447D-87BC-AC049166F216', 'title' => ''], 'Job' => [ 'type' => 'object', 'properties' => [ 'JobId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'job-202401250936hze747fd7e0007005', 'title' => ''], 'Type' => ['description' => 'The operation type of the task.'."\n" ."\n" .'- create: Creates a task.'."\n" ."\n" .'- cancel: Cancels a task.', 'type' => 'string', 'example' => 'create', 'title' => ''], 'Completed' => ['description' => 'Indicates whether the task is complete.'."\n" ."\n" .'- true: The task is complete.'."\n" ."\n" .'- false: The task is in progress.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'CreateTime' => ['description' => 'The time when the task was created. This value is a UNIX timestamp in milliseconds.', 'type' => 'string', 'example' => '1653274407000', 'title' => ''], 'Status' => ['description' => 'The status of the task.'."\n" ."\n" .'- success: The task is successful.'."\n" ."\n" .'- running: The task is in progress.'."\n" ."\n" .'- cancel: The task is canceled.'."\n" ."\n" .'- fail: The task failed.', 'type' => 'string', 'example' => 'running', 'title' => ''], 'Response' => ['description' => 'The response returned after the task is successful.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Error' => ['description' => 'The error message returned if the task failed.', 'type' => 'string', 'example' => 'OperationTimeout', 'title' => ''], 'Process' => ['description' => 'The progress of the task in percent.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], ], 'description' => 'The details of the task.', 'title' => '', 'example' => '', ], ], 'title' => '', 'description' => 'The returned data.', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Cluster.ClusterManagedCertRotate.NotSupport', 'errorMessage' => 'rotate cluster managed cert not support', 'description' => ''], ], 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'caller has no permission', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => 'Unknown error caused request processing to fail.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'RotateClusterManagedCert', 'summary' => 'Rotates a managed certificate for a cluster.', 'description' => 'This operation is available only for certificate hosting clusters in regions within the China site (aliyun.com).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:RotateClusterManagedCert', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C467B38-3910-447D-87BC-AC049166F216\\",\\n \\"Job\\": {\\n \\"JobId\\": \\"job-202401250936hze747fd7e0007005\\",\\n \\"Type\\": \\"create\\",\\n \\"Completed\\": true,\\n \\"CreateTime\\": \\"1653274407000\\",\\n \\"Status\\": \\"running\\",\\n \\"Response\\": \\"success\\",\\n \\"Error\\": \\"OperationTimeout\\",\\n \\"Process\\": 100\\n }\\n}","type":"json"}]', ], 'SwitchClusterMaster' => [ 'summary' => 'Switches the master role in a cluster to a subordinate HSM. This operation is not supported for manually synchronized clusters in the Chinese mainland.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREhsmV7VE3Y', 'FEATUREhsm01FLNB', 'FEATUREhsmGIFYCG', 'FEATUREhsmLBBV5W'], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'formData', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'cluster-w3G9vOJI2****', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the HSM instance to be set as the master HSM.', 'type' => 'string', 'required' => true, 'example' => 'hsm-cn-vj30bil8****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'BaseResult', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID. Alibaba Cloud generates this unique ID for each request. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '4C467B38-3910-447D-87BC-AC049166F216', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'SwitchMaster.InstanceInvalid', 'errorMessage' => 'Instance not in the cluster.', 'description' => ''], ['errorCode' => 'LeaveCluster.MasterLast', 'errorMessage' => 'Master instance can not leave a cluster until all other instances are left.', 'description' => ''], ['errorCode' => 'Certificate.ChainInvalid', 'errorMessage' => 'Certificate chain invalid. Please make sure issuer certificate is the trust anchor and cluster certificate is signed by issuer certificate.', 'description' => ''], ['errorCode' => 'Certificate.FormatInvalid', 'errorMessage' => 'Certificate format invalid. Cluster/Issuer certificate must be in PEM format.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.DuplicateZone', 'errorMessage' => 'VSwitches should not contain duplicate zones.', 'description' => ''], ['errorCode' => 'InvalidApiParam.Error', 'errorMessage' => 'api param is invalid', 'description' => ''], ['errorCode' => 'InvalidClusterName', 'errorMessage' => 'Invalid parameter clusterName.', 'description' => ''], ['errorCode' => 'InvalidPageSize', 'errorMessage' => 'Invalid parameter pageSize.', 'description' => ''], ['errorCode' => 'InvalidCurrentPage', 'errorMessage' => 'Invalid parameter currentPage.', 'description' => ''], ['errorCode' => 'InvalidRegionId', 'errorMessage' => 'Invalid parameter regionId.', 'description' => ''], ['errorCode' => 'InvalidVSwitch', 'errorMessage' => 'Invalid parameter vSwitch.', 'description' => ''], ['errorCode' => 'InvalidVpc', 'errorMessage' => 'Invalid parameter vpcId.', 'description' => ''], ['errorCode' => 'InvalidIp', 'errorMessage' => 'Invalid parameter IP.', 'description' => ''], ['errorCode' => 'InvalidAliuid', 'errorMessage' => 'Invalid parameter aliuid.', 'description' => ''], ['errorCode' => 'InvalidClusterId', 'errorMessage' => 'Invalid parameter clusterId.', 'description' => ''], ['errorCode' => 'InvalidInstanceId', 'errorMessage' => 'Invalid parameter instanceId.', 'description' => ''], ['errorCode' => 'InvalidBackupId', 'errorMessage' => 'Invalid parameter backupId.', 'description' => ''], ['errorCode' => 'InvalidImageId', 'errorMessage' => 'Invalid parameter imageId.', 'description' => ''], ['errorCode' => 'HsmInstanceNotExist.Error', 'errorMessage' => 'hsm instance not exist', 'description' => ''], ['errorCode' => 'HSMIntanceNotActived.Error', 'errorMessage' => 'hsm intance is not actived', 'description' => ''], ['errorCode' => 'WhiteListMaxCount.Error', 'errorMessage' => 'whilte list is more than max count', 'description' => ''], ['errorCode' => 'ClusterIdIsNotExists.Error', 'errorMessage' => 'cluster ID non-exists', 'description' => ''], ['errorCode' => 'InstanceListIsEmpty.Error', 'errorMessage' => 'instance list is empty', 'description' => ''], ['errorCode' => 'InstanceIdIsEmpty.Error', 'errorMessage' => 'instance id is empty', 'description' => ''], ['errorCode' => 'InstanceIsNotExistsInCluster.Error', 'errorMessage' => 'cluster has no such instance', 'description' => ''], ['errorCode' => 'InstanceIsExistsInCluster.Error', 'errorMessage' => 'instance already in the cluster', 'description' => ''], ['errorCode' => 'RegionNoEmpty.Error', 'errorMessage' => 'region no. is empty', 'description' => ''], ['errorCode' => 'ClusterNameEmpty.Error', 'errorMessage' => 'empty cluster name not allowed', 'description' => ''], ['errorCode' => 'ClusterNameIsExists.Error', 'errorMessage' => 'the cluster name is already taken', 'description' => ''], ['errorCode' => 'IpNotValid.Error', 'errorMessage' => 'ip not valid', 'description' => ''], ['errorCode' => 'ClusterIsEmpty.Error', 'errorMessage' => 'cluster is empty', 'description' => ''], ['errorCode' => 'NoMasterFoundInCluster.Error', 'errorMessage' => 'cluster has no master instance', 'description' => ''], ['errorCode' => 'HsmInstanceIdNotFound.Error', 'errorMessage' => 'no such instance', 'description' => ''], ['errorCode' => 'NoInstanceFoundInCluster.Error', 'errorMessage' => 'cluster is empty', 'description' => ''], ['errorCode' => 'Whitelist.Invalid', 'errorMessage' => 'Whitelist blocks not in CIDR format.', 'description' => ''], ['errorCode' => 'Whitelist.TooLong', 'errorMessage' => 'Whitelist too long, exceeds 10 CIDR blocks.', 'description' => ''], ], 403 => [ ['errorCode' => 'Cluster.CN.ClusterModeInvalid', 'errorMessage' => 'This API is forbidden for current cluster mode.', 'description' => ''], ['errorCode' => 'NoPermission', 'errorMessage' => 'Caller has no permission on the resource.', 'description' => ''], ['errorCode' => 'InstanceNotPaused', 'errorMessage' => 'Please pause the instance before reset.', 'description' => ''], ['errorCode' => 'InstanceNotActive', 'errorMessage' => 'Instance is not active.', 'description' => ''], ['errorCode' => 'ConfigIp.IncorrectState', 'errorMessage' => 'Instance not in pending or active state, can not config IP address.', 'description' => ''], ['errorCode' => 'SwitchMaster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'SyncCluster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'LeaveCluster.InstanceInvalid', 'errorMessage' => 'The instance is not in the cluster.', 'description' => ''], ['errorCode' => 'DeleteCluster.IncorrectState', 'errorMessage' => 'Cluster not empty, please remove all instances first.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceVSwitchNotInCluster', 'errorMessage' => 'Instance\'s vSwitch is not in cluster config, please change instance\'s vSwitch first.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceInitialized', 'errorMessage' => 'Initialized instance can not join a cluster.', 'description' => ''], ['errorCode' => 'JoinCluster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'InitializeCluster.InstanceNotInitialized', 'errorMessage' => 'Cluster master instance not initialized, please initialize cluster master instance first.', 'description' => ''], ['errorCode' => 'InitializeCluster.IncorrectConfig', 'errorMessage' => 'Cluster subnet not configured, please config cluster subnet first.', 'description' => ''], ['errorCode' => 'InitializeCluster.IncorrectState', 'errorMessage' => 'Cluster initialized, do not re-initialize.', 'description' => ''], ['errorCode' => 'Cluster.CN.ActionForbidden', 'errorMessage' => 'This API is forbidden for non-international site cluster.', 'description' => ''], ['errorCode' => 'Cluster.INTL.ActionForbidden', 'errorMessage' => 'This API is forbidden for international site cluster.', 'description' => ''], ['errorCode' => 'ConfigClusterCertificate.IncorrectState', 'errorMessage' => 'Cluster initialized or certificates already configured.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.InvalidVpcId', 'errorMessage' => 'VPC Id invalid. Cluster VPC is the same as cluster master\'s VPC.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.InvalidVSwitchId', 'errorMessage' => 'VSwitch Id invalid. VSwitches should contain all current cluster vSwitches.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.IncorrectState', 'errorMessage' => 'Cluster not in NEW state, can not config cluster subnet.', 'description' => ''], ['errorCode' => 'ClusterName.Exist', 'errorMessage' => 'Cluster name already exists, please use another name.', 'description' => ''], ['errorCode' => 'Whitelist.InstanceInCluster', 'errorMessage' => 'Whitelist.InstanceInCluster', 'description' => ''], ], [ ['errorCode' => 'Resource.NotFound', 'errorMessage' => 'Resource not found.', 'description' => ''], ], [ ['errorCode' => 'ClusterAPI.NotSupported', 'errorMessage' => 'ClusterAPI not supported in this region.', 'description' => ''], ], 409 => [ ['errorCode' => 'Conflict', 'errorMessage' => 'Resource is being updated by a previous request. Current request is redundant.', 'description' => ''], ['errorCode' => 'Cluster.Conflict', 'errorMessage' => 'The cluster is being updated by a previous request. Please try again later.', 'description' => ''], ], 500 => [ ['errorCode' => 'ConfigWhitelistFailed.Error', 'errorMessage' => 'config white list error', 'description' => ''], ['errorCode' => 'ActionFailed.Error', 'errorMessage' => 'internal error, please try again', 'description' => ''], ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => 'Unknown error caused request processing to fail.'], ], ], 'title' => 'SwitchClusterMaster', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:SwitchClusterMaster', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C467B38-3910-447D-87BC-AC049166F216\\"\\n}","type":"json"}]', ], 'SyncCluster' => [ 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREhsmV7VE3Y', 'FEATUREhsm01FLNB', 'FEATUREhsmGIFYCG'], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cluster-BqxX63Bsgytet****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'PlainResult'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '4C467B38-3910-447D-87BC-AC049166F216', 'title' => ''], 'Job' => [ 'description' => 'The details of the task.'."\n", 'type' => 'object', 'properties' => [ 'JobId' => ['description' => 'The ID of the task.'."\n", 'type' => 'string', 'example' => 'job-000bu7m5vjmyz9s7qz85', 'title' => ''], 'Type' => ['description' => 'The operation type. Valid values:'."\n" ."\n" .'* create'."\n" .'* cancel'."\n", 'type' => 'string', 'example' => 'create', 'title' => ''], 'Completed' => ['description' => 'Indicates whether the task is complete. Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'CreateTime' => ['description' => 'The time when the task was created. Unit: milliseconds. The value is a UNIX timestamp.'."\n", 'type' => 'string', 'example' => '1711764127000', 'title' => ''], 'Status' => ['description' => 'The status of the task. Valid values:'."\n" ."\n" .'* success'."\n" .'* running'."\n" .'* cancel'."\n" .'* fail'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], 'Response' => ['description' => 'The response returned after the task succeeds.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], 'Error' => ['description' => 'The error message returned if the task fails.'."\n", 'type' => 'string', 'example' => 'OperationTimeout', 'title' => ''], 'Progress' => ['description' => 'The progress of the task. Unit: percent (%).'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '90', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'SwitchMaster.InstanceInvalid', 'errorMessage' => 'Instance not in the cluster.', 'description' => ''], ['errorCode' => 'LeaveCluster.MasterLast', 'errorMessage' => 'Master instance can not leave a cluster until all other instances are left.', 'description' => ''], ['errorCode' => 'Certificate.ChainInvalid', 'errorMessage' => 'Certificate chain invalid. Please make sure issuer certificate is the trust anchor and cluster certificate is signed by issuer certificate.', 'description' => ''], ['errorCode' => 'Certificate.FormatInvalid', 'errorMessage' => 'Certificate format invalid. Cluster/Issuer certificate must be in PEM format.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.DuplicateZone', 'errorMessage' => 'VSwitches should not contain duplicate zones.', 'description' => ''], ['errorCode' => 'InvalidApiParam.Error', 'errorMessage' => 'api param is invalid', 'description' => ''], ['errorCode' => 'InvalidClusterName', 'errorMessage' => 'Invalid parameter clusterName.', 'description' => ''], ['errorCode' => 'InvalidPageSize', 'errorMessage' => 'Invalid parameter pageSize.', 'description' => ''], ['errorCode' => 'InvalidCurrentPage', 'errorMessage' => 'Invalid parameter currentPage.', 'description' => ''], ['errorCode' => 'InvalidRegionId', 'errorMessage' => 'Invalid parameter regionId.', 'description' => ''], ['errorCode' => 'InvalidVSwitch', 'errorMessage' => 'Invalid parameter vSwitch.', 'description' => ''], ['errorCode' => 'InvalidVpc', 'errorMessage' => 'Invalid parameter vpcId.', 'description' => ''], ['errorCode' => 'InvalidIp', 'errorMessage' => 'Invalid parameter IP.', 'description' => ''], ['errorCode' => 'InvalidAliuid', 'errorMessage' => 'Invalid parameter aliuid.', 'description' => ''], ['errorCode' => 'InvalidClusterId', 'errorMessage' => 'Invalid parameter clusterId.', 'description' => ''], ['errorCode' => 'InvalidInstanceId', 'errorMessage' => 'Invalid parameter instanceId.', 'description' => ''], ['errorCode' => 'InvalidBackupId', 'errorMessage' => 'Invalid parameter backupId.', 'description' => ''], ['errorCode' => 'InvalidImageId', 'errorMessage' => 'Invalid parameter imageId.', 'description' => ''], ['errorCode' => 'HsmInstanceNotExist.Error', 'errorMessage' => 'hsm instance not exist', 'description' => ''], ['errorCode' => 'HSMIntanceNotActived.Error', 'errorMessage' => 'hsm intance is not actived', 'description' => ''], ['errorCode' => 'WhiteListMaxCount.Error', 'errorMessage' => 'whilte list is more than max count', 'description' => ''], ['errorCode' => 'ClusterIdIsNotExists.Error', 'errorMessage' => 'cluster ID non-exists', 'description' => ''], ['errorCode' => 'InstanceListIsEmpty.Error', 'errorMessage' => 'instance list is empty', 'description' => ''], ['errorCode' => 'InstanceIdIsEmpty.Error', 'errorMessage' => 'instance id is empty', 'description' => ''], ['errorCode' => 'InstanceIsNotExistsInCluster.Error', 'errorMessage' => 'cluster has no such instance', 'description' => ''], ['errorCode' => 'InstanceIsExistsInCluster.Error', 'errorMessage' => 'instance already in the cluster', 'description' => ''], ['errorCode' => 'RegionNoEmpty.Error', 'errorMessage' => 'region no. is empty', 'description' => ''], ['errorCode' => 'ClusterNameEmpty.Error', 'errorMessage' => 'empty cluster name not allowed', 'description' => ''], ['errorCode' => 'ClusterNameIsExists.Error', 'errorMessage' => 'the cluster name is already taken', 'description' => ''], ['errorCode' => 'IpNotValid.Error', 'errorMessage' => 'ip not valid', 'description' => ''], ['errorCode' => 'ClusterIsEmpty.Error', 'errorMessage' => 'cluster is empty', 'description' => ''], ['errorCode' => 'NoMasterFoundInCluster.Error', 'errorMessage' => 'cluster has no master instance', 'description' => ''], ['errorCode' => 'HsmInstanceIdNotFound.Error', 'errorMessage' => 'no such instance', 'description' => ''], ['errorCode' => 'NoInstanceFoundInCluster.Error', 'errorMessage' => 'cluster is empty', 'description' => ''], ['errorCode' => 'Whitelist.Invalid', 'errorMessage' => 'Whitelist blocks not in CIDR format.', 'description' => ''], ['errorCode' => 'Whitelist.TooLong', 'errorMessage' => 'Whitelist too long, exceeds 10 CIDR blocks.', 'description' => ''], ], 403 => [ ['errorCode' => 'Cluster.CN.ClusterModeInvalid', 'errorMessage' => 'This API is forbidden for current cluster mode.', 'description' => ''], ['errorCode' => 'NoPermission', 'errorMessage' => 'Caller has no permission on the resource.', 'description' => ''], ['errorCode' => 'InstanceNotPaused', 'errorMessage' => 'Please pause the instance before reset.', 'description' => ''], ['errorCode' => 'InstanceNotActive', 'errorMessage' => 'Instance is not active.', 'description' => ''], ['errorCode' => 'ConfigIp.IncorrectState', 'errorMessage' => 'Instance not in pending or active state, can not config IP address.', 'description' => ''], ['errorCode' => 'SwitchMaster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'SyncCluster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'LeaveCluster.InstanceInvalid', 'errorMessage' => 'The instance is not in the cluster.', 'description' => ''], ['errorCode' => 'DeleteCluster.IncorrectState', 'errorMessage' => 'Cluster not empty, please remove all instances first.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceVSwitchNotInCluster', 'errorMessage' => 'Instance\'s vSwitch is not in cluster config, please change instance\'s vSwitch first.', 'description' => ''], ['errorCode' => 'JoinCluster.InstanceInitialized', 'errorMessage' => 'Initialized instance can not join a cluster.', 'description' => ''], ['errorCode' => 'JoinCluster.IncorrectState', 'errorMessage' => 'Cluster not initialized, please initialize the cluster first.', 'description' => ''], ['errorCode' => 'InitializeCluster.InstanceNotInitialized', 'errorMessage' => 'Cluster master instance not initialized, please initialize cluster master instance first.', 'description' => ''], ['errorCode' => 'InitializeCluster.IncorrectConfig', 'errorMessage' => 'Cluster subnet not configured, please config cluster subnet first.', 'description' => ''], ['errorCode' => 'InitializeCluster.IncorrectState', 'errorMessage' => 'Cluster initialized, do not re-initialize.', 'description' => ''], ['errorCode' => 'Cluster.CN.ActionForbidden', 'errorMessage' => 'This API is forbidden for non-international site cluster.', 'description' => ''], ['errorCode' => 'Cluster.INTL.ActionForbidden', 'errorMessage' => 'This API is forbidden for international site cluster.', 'description' => ''], ['errorCode' => 'ConfigClusterCertificate.IncorrectState', 'errorMessage' => 'Cluster initialized or certificates already configured.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.InvalidVpcId', 'errorMessage' => 'VPC Id invalid. Cluster VPC is the same as cluster master\'s VPC.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.InvalidVSwitchId', 'errorMessage' => 'VSwitch Id invalid. VSwitches should contain all current cluster vSwitches.', 'description' => ''], ['errorCode' => 'ConfigClusterSubnet.IncorrectState', 'errorMessage' => 'Cluster not in NEW state, can not config cluster subnet.', 'description' => ''], ['errorCode' => 'ClusterName.Exist', 'errorMessage' => 'Cluster name already exists, please use another name.', 'description' => ''], ['errorCode' => 'Whitelist.InstanceInCluster', 'errorMessage' => 'Whitelist.InstanceInCluster', 'description' => ''], ], [ ['errorCode' => 'Resource.NotFound', 'errorMessage' => 'Resource not found.', 'description' => ''], ], [ ['errorCode' => 'ClusterAPI.NotSupported', 'errorMessage' => 'ClusterAPI not supported in this region.', 'description' => ''], ], 409 => [ ['errorCode' => 'Conflict', 'errorMessage' => 'Resource is being updated by a previous request. Current request is redundant.', 'description' => ''], ['errorCode' => 'Cluster.Conflict', 'errorMessage' => 'The cluster is being updated by a previous request. Please try again later.', 'description' => ''], ], 500 => [ ['errorCode' => 'ConfigWhitelistFailed.Error', 'errorMessage' => 'config white list error', 'description' => ''], ['errorCode' => 'ActionFailed.Error', 'errorMessage' => 'internal error, please try again', 'description' => ''], ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => 'Unknown error caused request processing to fail.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'SyncCluster', 'summary' => 'Synchronizes the data of hardware security modules (HSMs) in a cluster.', 'description' => '* This operation is used for manually synchronizing data within clusters located in the Chinese Mainland. For clusters outside the Chinese Mainland, automatic data synchronization is supported, and this operation is unnecessary. If you attempt to use this operation, a 400 error code will be returned.'."\n" .'* The data synchronization takes approximately 5 minutes. To avoid service interruptions, we recommend performing this operation during off-peak hours.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:SyncCluster', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C467B38-3910-447D-87BC-AC049166F216\\",\\n \\"Job\\": {\\n \\"JobId\\": \\"job-000bu7m5vjmyz9s7qz85\\",\\n \\"Type\\": \\"create\\",\\n \\"Completed\\": true,\\n \\"CreateTime\\": \\"1711764127000\\",\\n \\"Status\\": \\"success\\",\\n \\"Response\\": \\"success\\",\\n \\"Error\\": \\"OperationTimeout\\",\\n \\"Progress\\": 90\\n }\\n}","type":"json"}]', ], ], 'endpoints' => [ ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hsm.aliyuncs.com', 'endpoint' => 'hsm.aliyuncs.com', 'vpc' => 'hsm.vpc-proxy.aliyuncs.com'], ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hsm.aliyuncs.com', 'endpoint' => 'hsm.aliyuncs.com', 'vpc' => 'hsm.vpc-proxy.aliyuncs.com'], ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hsm.aliyuncs.com', 'endpoint' => 'hsm.aliyuncs.com', 'vpc' => 'hsm.vpc-proxy.aliyuncs.com'], ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hsm.aliyuncs.com', 'endpoint' => 'hsm.aliyuncs.com', 'vpc' => 'hsm.vpc-proxy.aliyuncs.com'], ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hsm.aliyuncs.com', 'endpoint' => 'hsm.aliyuncs.com', 'vpc' => 'hsm.vpc-proxy.aliyuncs.com'], ['regionId' => 'cn-heyuan', 'regionName' => 'China (Heyuan)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hsm.aliyuncs.com', 'endpoint' => 'hsm.aliyuncs.com', 'vpc' => 'hsm.vpc-proxy.aliyuncs.com'], ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hsm.aliyuncs.com', 'endpoint' => 'hsm.aliyuncs.com', 'vpc' => 'hsm.vpc-proxy.aliyuncs.com'], ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hsm.aliyuncs.com', 'endpoint' => 'hsm.aliyuncs.com', 'vpc' => 'hsm.vpc-proxy.aliyuncs.com'], ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hsm.aliyuncs.com', 'endpoint' => 'hsm.aliyuncs.com', 'vpc' => 'hsm.vpc-proxy.aliyuncs.com'], ['regionId' => 'me-central-1', 'regionName' => 'Saudi Arabia (Riyadh)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'hsm.aliyuncs.com', 'endpoint' => 'hsm.aliyuncs.com', 'vpc' => 'hsm.vpc-proxy.aliyuncs.com'], ['regionId' => 'me-east-1', 'regionName' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'hsm.aliyuncs.com', 'endpoint' => 'hsm.aliyuncs.com', 'vpc' => ''], ['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'hsm.aliyuncs.com', 'endpoint' => 'hsm.aliyuncs.com', 'vpc' => 'hsm.vpc-proxy.aliyuncs.com'], ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'hsm.aliyuncs.com', 'endpoint' => 'hsm.aliyuncs.com', 'vpc' => 'hsm.vpc-proxy.aliyuncs.com'], ['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'hsm.aliyuncs.com', 'endpoint' => 'hsm.aliyuncs.com', 'vpc' => ''], ], 'errorCodes' => [ ['code' => 'InternalError', 'message' => 'The request processing has failed due to some unknown error.', 'http_code' => 500, 'description' => 'Unknown error caused request processing to fail.'], ['code' => 'InvalidApiParam.Error', 'message' => 'Parameter is invalid.', 'http_code' => 400, 'description' => 'Illegal parameter'], ['code' => 'NoPermission', 'message' => 'caller has no permission.', 'http_code' => 403, 'description' => 'User does not have permission to use.'], ], 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], ], ], 'ram' => [ 'productCode' => 'DataEncryptionService', 'productName' => 'Cloud Hardware Security Module (HSM)', 'ramCodes' => ['yundun-hsm'], 'ramLevel' => 'OPERATION', 'ramConditions' => [], 'ramActions' => [ [ 'apiName' => 'ListImages', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'yundun-hsm:ListImages', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ResumeInstance', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:ResumeInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SwitchClusterMaster', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:SwitchClusterMaster', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'LeaveCluster', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:LeaveCluster', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'EnableBackup', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:EnableBackup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'InitializeCluster', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:InitializeCluster', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ConfigInstanceWhitelist', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:ConfigInstanceWhitelist', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ResetInstance', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:ResetInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'PauseInstance', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:PauseInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'JoinCluster', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:JoinCluster', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListBackups', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'yundun-hsm:ListBackups', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'QuickInitInstance', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:QuickInitInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ConfigAuditLog', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:ConfigAuditLog', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ExportImage', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'yundun-hsm:ExportImage', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetTrialStatus', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'yundun-hsm:DescribeTrialStatus', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetAuditLogStatus', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'yundun-hsm:GetAuditLogStatus', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeRegions', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'yundun-hsm:DescribeRegions', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ConfigInstanceRemark', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:ConfigInstanceRemark', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListClusters', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'yundun-hsm:ListClusters', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetJob', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'yundun-hsm:GetJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'RestoreInstance', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:RestoreInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ConfigBackupTask', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:ConfigBackupTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CopyImage', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:CopyImage', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListInstances', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'yundun-hsm:ListInstances', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetBackup', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'yundun-hsm:GetBackup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ConfigClusterSubnet', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:ConfigClusterSubnet', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DownloadClusterManagedCert', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'yundun-hsm:DownloadClusterManagedCert', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetInstance', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'yundun-hsm:GetInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateCluster', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'yundun-hsm:CreateCluster', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'MoveResourceGroup', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:MoveResourceGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ConfigBackupRemark', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:ConfigBackupRemark', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'InitializeAuditLog', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:InitializeAuditLog', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ConfigInstanceIpAddress', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:ConfigInstanceIpAddress', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetImage', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'yundun-hsm:GetImage', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteCluster', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'yundun-hsm:DeleteCluster', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'QuickDeployCluster', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'yundun-hsm:QuickDeployCluster', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ResetBackup', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:ResetBackup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetInstanceInternalStatus', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'yundun-hsm:GetInstanceInternalStatus', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SyncCluster', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:SyncCluster', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ConfigClusterName', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:ConfigClusterName', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ConfigClusterWhitelist', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:ConfigClusterWhitelist', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetCluster', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'yundun-hsm:GetCluster', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ConfigImageRemark', 'description' => '', 'operationType' => '', 'ramAction' => [ 'action' => 'yundun-hsm:ConfigImageRemark', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ConfigClusterCertificate', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:ConfigClusterCertificate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'RotateClusterManagedCert', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'yundun-hsm:RotateClusterManagedCert', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DataEncryptionService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'resourceTypes' => [], ], ];