1. 接口描述
接口请求域名： tcr.api3.fincloud.tencent.com。
查询实例公网访问入口状态
默认接口请求频率限制：20次/秒。
接口更新时间：2024-10-10 16:58:06。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeExternalEndpointStatus |
| Version | 是 | 否 | String | 公共参数，本接口取值：2019-09-24 |
| Region | 是 | 否 | String | 公共参数，地域信息本接口不需要传递此参数。 |
| RegistryId | 是 | 否 | String | 实例Id 示例值： |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 开启公网访问状态，开启中（Opening）、已开启（Opened）、关闭（Closed） 示例值： |
| Reason | String | 原因 示例值： |
| ExternalIp | String | 公网访问 ip 示例值： |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| MissingParameter | 缺少参数错误。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InternalError.DbError | 数据库错误。 |
| UnsupportedOperation | 操作不支持。 |
| UnauthorizedOperation | 未授权操作。 |
| UnknownParameter | 未知参数错误。 |
| ResourceNotFound | 资源不存在。 |
| OperationDenied | 操作被拒绝。 |
| FailedOperation.GetDBDataError | 获取数据库数据错误。 |
| FailedOperation.GetTcrClient | 获取TcrClient错误。 |
| FailedOperation.ErrorGetDBDataError | 获取数据库数据错误。 |