获取符合查询条件的实例集合。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| yundun-hsm:ListInstances | get |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 否 | 地域 ID。 | cn-hangzhou |
| CurrentPage | integer | 否 | 当前页数。 | 1 |
| PageSize | integer | 否 | 每页查询数目。取值：1~1000。 | 20 |
返回参数
示例
正常返回示例
JSON格式
{
"Total": 80,
"PageSize": 20,
"CurrentPage": 1,
"RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
"Instances": [
{
"InstanceId": "hsm-cn-vj30bil8****",
"Status": "ACTIVE"
}
]
}错误码
| HTTP status code | 错误码 | 错误信息 |
|---|---|---|
| 400 | InvalidApiParam.Error | api param is invalid |
| 400 | HsmInstanceNotExist.Error | hsm instance not exist |
| 400 | HSMIntanceNotActived.Error | hsm intance is not actived |
| 400 | WhiteListMaxCount.Error | whilte list is more than max count |
| 400 | ClusterIdIsNotExists.Error | cluster ID non-exists |
| 400 | InstanceListIsEmpty.Error | instance list is empty |
| 400 | InstanceIdIsEmpty.Error | instance id is empty |
| 400 | InstanceIsNotExistsInCluster.Error | cluster has no such instance |
| 400 | InstanceIsExistsInCluster.Error | instance already in the cluster |
| 400 | RegionNoEmpty.Error | region no. is empty |
| 400 | ClusterNameEmpty.Error | empty cluster name not allowed |
| 400 | ClusterNameIsExists.Error | the cluster name is already taken |
| 400 | IpNotValid.Error | ip not valid |
| 400 | ClusterIsEmpty.Error | cluster is empty |
| 400 | NoMasterFoundInCluster.Error | cluster has no master instance |
| 400 | HsmInstanceIdNotFound.Error | no such instance |
| 400 | NoInstanceFoundInCluster.Error | cluster is empty |
| 400 | Whitelist.Invalid | Whitelist blocks not in CIDR format. |
| 400 | Whitelist.TooLong | Whitelist too long, exceeds 10 CIDR blocks. |
| 403 | NoPermission | Caller has no permission on the resource. |
| 403 | InstanceNotPaused | Please pause the instance before reset. |
| 404 | Resource.NotFound | Resource not found. |
| 409 | Conflict | Resource is being updated by a previous request. Current request is redundant. |
| 409 | ConfigIp.IncorrectState | Instance not in pending or active state, can not config IP address. |
| 500 | ConfigWhitelistFailed.Error | config white list error |
| 500 | ActionFailed.Error | internal error, please try again |
| 500 | ActionFailed.Error | internal error, please try again |
| 500 | ActionFailed.Error | internal error, please try again |
| 500 | InternalError | The request processing has failed due to some unknown error. |
访问错误中心查看更多错误码。