ResetInstance - 重置实例

重置实例数据。

接口说明

实例被重置后,相关数据全部丢失且永久不可恢复,请谨慎调用该操作。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-hsm:ResetInstanceupdate
  • 全部资源
    *

请求参数

名称类型必填描述示例值
InstanceIdstring

密码机实例 ID。

hsm-cn-vj30bil8****

返回参数

名称类型描述示例值
object

PlainResult

RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

4C467B38-3910-447D-87BC-AC049166F216
Jobobject

任务详情。

JobIdstring

任务 ID。

job-0007bl8oev0u3jqyfu6a
Typestring

操作类型。

  • create:创建任务
  • cancel:取消任务
create
Completedboolean

任务是否完成。

true
CreateTimestring

任务创建时间,精确到毫秒。时间戳格式。

1653274407000
Statusstring

任务状态。

  • success:任务成功
  • running:任务执行中
  • cancel:任务取消
  • fail:任务失败
success
Responsestring

任务成功后返回的响应信息。

success
Errorstring

任务失败时的错误信息。

OperationTimeout
Progressinteger

任务执行进度。单位为百分比。

80

示例

正常返回示例

JSON格式

{
  "RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
  "Job": {
    "JobId": "job-0007bl8oev0u3jqyfu6a",
    "Type": "create",
    "Completed": true,
    "CreateTime": "1653274407000",
    "Status": "success",
    "Response": "success",
    "Error": "OperationTimeout",
    "Progress": 80
  }
}

错误码

HTTP status code错误码错误信息
400SwitchMaster.InstanceInvalidInstance not in the cluster.
400LeaveCluster.MasterLastMaster instance can not leave a cluster until all other instances are left.
400Certificate.ChainInvalidCertificate chain invalid. Please make sure issuer certificate is the trust anchor and cluster certificate is signed by issuer certificate.
400Certificate.FormatInvalidCertificate format invalid. Cluster/Issuer certificate must be in PEM format.
400ConfigClusterSubnet.DuplicateZoneVSwitches should not contain duplicate zones.
400InvalidApiParam.Errorapi param is invalid
400InvalidClusterNameInvalid parameter clusterName.
400InvalidPageSizeInvalid parameter pageSize.
400InvalidCurrentPageInvalid parameter currentPage.
400InvalidRegionIdInvalid parameter regionId.
400InvalidVSwitchInvalid parameter vSwitch.
400InvalidVpcInvalid parameter vpcId.
400InvalidIpInvalid parameter IP.
400InvalidAliuidInvalid parameter aliuid.
400InvalidClusterIdInvalid parameter clusterId.
400InvalidInstanceIdInvalid parameter instanceId.
400InvalidBackupIdInvalid parameter backupId.
400InvalidImageIdInvalid parameter imageId.
400HsmInstanceNotExist.Errorhsm instance not exist
400HSMIntanceNotActived.Errorhsm intance is not actived
400WhiteListMaxCount.Errorwhilte list is more than max count
400ClusterIdIsNotExists.Errorcluster ID non-exists
400InstanceListIsEmpty.Errorinstance list is empty
400InstanceIdIsEmpty.Errorinstance id is empty
400InstanceIsNotExistsInCluster.Errorcluster has no such instance
400InstanceIsExistsInCluster.Errorinstance already in the cluster
400RegionNoEmpty.Errorregion no. is empty
400ClusterNameEmpty.Errorempty cluster name not allowed
400ClusterNameIsExists.Errorthe cluster name is already taken
400IpNotValid.Errorip not valid
400ClusterIsEmpty.Errorcluster is empty
400NoMasterFoundInCluster.Errorcluster has no master instance
400HsmInstanceIdNotFound.Errorno such instance
400NoInstanceFoundInCluster.Errorcluster is empty
400Whitelist.InvalidWhitelist blocks not in CIDR format.
400Whitelist.TooLongWhitelist too long, exceeds 10 CIDR blocks.
403NoPermissionCaller has no permission on the resource.
403InstanceNotPausedPlease pause the instance before reset.
403InstanceNotActiveInstance is not active.
403ConfigIp.IncorrectStateInstance not in pending or active state, can not config IP address.
403SwitchMaster.IncorrectStateCluster not initialized, please initialize the cluster first.
403SyncCluster.IncorrectStateCluster not initialized, please initialize the cluster first.
403LeaveCluster.InstanceInvalidThe instance is not in the cluster.
403DeleteCluster.IncorrectStateCluster not empty, please remove all instances first.
403JoinCluster.InstanceVSwitchNotInClusterInstance's vSwitch is not in cluster config, please change instance's vSwitch first.
403JoinCluster.InstanceInitializedInitialized instance can not join a cluster.
403JoinCluster.IncorrectStateCluster not initialized, please initialize the cluster first.
403InitializeCluster.InstanceNotInitializedCluster master instance not initialized, please initialize cluster master instance first.
403InitializeCluster.IncorrectConfigCluster subnet not configured, please config cluster subnet first.
403InitializeCluster.IncorrectStateCluster initialized, do not re-initialize.
403Cluster.CN.ActionForbiddenThis API is forbidden for non-international site cluster.
403Cluster.INTL.ActionForbiddenThis API is forbidden for international site cluster.
403ConfigClusterCertificate.IncorrectStateCluster initialized or certificates already configured.
403ConfigClusterSubnet.InvalidVpcIdVPC Id invalid. Cluster VPC is the same as cluster master's VPC.
403ConfigClusterSubnet.InvalidVSwitchIdVSwitch Id invalid. VSwitches should contain all current cluster vSwitches.
403ConfigClusterSubnet.IncorrectStateCluster not in NEW state, can not config cluster subnet.
403ClusterName.ExistCluster name already exists, please use another name.
403Whitelist.InstanceInClusterWhitelist.InstanceInCluster
404Resource.NotFoundResource not found.
405ClusterAPI.NotSupportedClusterAPI not supported in this region.
409ConflictResource is being updated by a previous request. Current request is redundant.
409Cluster.ConflictThe cluster is being updated by a previous request. Please try again later.
500ConfigWhitelistFailed.Errorconfig white list error
500ActionFailed.Errorinternal error, please try again
500ActionFailed.Errorinternal error, please try again
500ActionFailed.Errorinternal error, please try again
500InternalErrorThe request processing has failed due to some unknown error.

访问错误中心查看更多错误码。