DescribeInstanceParams
最近更新时间: 2025-10-20 17:05:53
1. 接口描述
接口请求域名： redis.api3.fincloud.tencent.cn。
查询实例参数列表
默认接口请求频率限制：20次/秒。
接口更新时间：2019-12-09 17:08:43。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeInstanceParams |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-04-12 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| InstanceId | 是 | 否 | String | 实例Id |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Int64 | 此参数对外不可见。 实例参数个数 |
| InstanceEnumParam | InstanceEnumParam | 此参数对外不可见。 实例枚举类型参数 |
| InstanceIntegerParam | InstanceIntegerParam | 此参数对外不可见。 实例整型参数 |
| InstanceTextParam | InstanceTextParam | 此参数对外不可见。 实例字符型参数 |
| InstanceMultiParam | InstanceMultiParam | 此参数对外不可见。 实例多选项型参数 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| UnauthorizedOperation | 未授权操作。 |
| InternalError.DbOperationFailed | 统一的 DB 操作错误，可以是 update insert select..。 |
| UnauthorizedOperation.UserNotInWhiteList | 用户不在白名单中。 |
| UnsupportedOperation.ClusterInstanceAccessedDeny | redis 集群版不允许接入安全组。 |
| UnauthorizedOperation.NoCAMAuthed | 无cam 权限。 |
| FailedOperation.SystemError | 内部系统错误，和业务无关。 |
| InvalidParameter | 参数错误 |
| InternalError.InternalError | 内部错误。 |
| FailedOperation.UnSupportError | 实例不支持该接口。 |
| InvalidParameter.PermissionDenied | 接口没有cam权限。 |