1. 接口描述
接口请求域名: tcr.api3.fincloud.tencent.com。
用于校验企业版实例信息
默认接口请求频率限制:20次/秒。
接口更新时间:2023-09-05 10:07:01。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:CheckInstance |
| Version | 是 | 否 | String | 公共参数,本接口取值:2019-09-24 |
| Region | 是 | 否 | String | 公共参数,地域信息本接口不需要传递此参数。 |
| RegistryId | 是 | 否 | String | 待检测的实例Id 示例值: |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| IsValidated | Bool | 检查结果,true为合法,false为非法 示例值: |
| RegionId | Uint64 | 实例所在的RegionId 示例值: |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.ErrNotExist | 目标不存在。 |
| InternalError.ErrConflict | 目标冲突。 |
| MissingParameter | 缺少参数错误。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InternalError.DbError | 数据库错误。 |
| InternalError.ErrorConflict | 资源已存在。 |
| UnsupportedOperation | 操作不支持。 |
| UnauthorizedOperation | 未授权操作。 |
| UnknownParameter | 未知参数错误。 |
| InternalError.ErrorOverLimit | 资源超过配额。 |
| InvalidParameter.UnsupportedRegion | 该地域不支持创建实例。 |
| InvalidParameter.ErrorRegistryName | 实例名称非法,格式不正确或者已保留。 |
| InvalidParameter.ErrorTagOverLimit | 云标签超过10个上线。 |
| InvalidParameter.ErrorNameExists | 实例名称已存在。 |