查询实例详细信息
最近更新时间: 2024-09-03 18:49:43
1. 接口描述
接口请求域名： mariadb.api3.cloud.sunhongs.com。
本接口(DescribeDBInstanceDetail)用于查询指定实例的详细信息。
默认接口请求频率限制：20次/秒。
接口更新时间：2023-08-04 17:04:33。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeDBInstanceDetail |
| Version | 是 | 否 | String | 公共参数，本接口取值：2017-03-12 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| InstanceId | 是 | 否 | String | 实例Id形如：tdsql-ow728lmc。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 此参数对外不可见。 实例Id |
| InstanceName | String | 此参数对外不可见。 实例名称 |
| Status | Int64 | 此参数对外不可见。 实例状态 |
| StatusDesc | String | 此参数对外不可见。 实例目前运行状态描述 |
| Vip | String | 此参数对外不可见。 内网 IP 地址 |
| Vport | Int64 | 此参数对外不可见。 内网端口 |
| IsTmp | Int64 | 此参数对外不可见。 是否临时实例，0为否，非0为是 |
| NodeCount | Int64 | 此参数对外不可见。 节点数，2为一主一从，3为一主二从 |
| Region | String | 此参数对外不可见。 实例所在地域名称，如 ap-shanghai |
| Zone | String | 此参数对外不可见。 实例所在可用区名称，如 ap-shanghai-1 |
| VpcId | String | 此参数对外不可见。 字符串型的私有网络Id |
| SubnetId | String | 此参数对外不可见。 字符串型的私有网络子网Id |
| WanStatus | Int64 | 此参数对外不可见。 外网状态，0-未开通；1-已开通；2-关闭；3-开通中；4-关闭中 |
| WanDomain | String | 此参数对外不可见。 外网访问的域名，公网可解析 |
| WanVip | String | 此参数对外不可见。 外网 IP 地址，公网可访问 |
| WanPort | Int64 | 此参数对外不可见。 外网端口 |
| ProjectId | Int64 | 此参数对外不可见。 实例所属项目 Id |
| TdsqlVersion | String | 此参数对外不可见。 TDSQL 版本信息 |
| Memory | Int64 | 此参数对外不可见。 实例内存大小，单位 GB |
| Storage | Int64 | 此参数对外不可见。 实例存储大小，单位 GB |
| MasterZone | String | 此参数对外不可见。 主可用区，如 ap-shanghai-1 |
| SlaveZones | String | 此参数对外不可见。 从可用区列表，如 [ap-shanghai-2] |
| AutoRenewFlag | Int64 | 此参数对外不可见。 自动续费标志：0 否，1 是 |
| ExclusterId | String | 此参数对外不可见。 独享集群Id，普通实例为空 |
| PayMode | String | 此参数对外不可见。 付费模式：prepaid 表示预付费 |
| CreateTime | Datetime | 此参数对外不可见。 实例创建时间，格式为 2006-01-02 15:04:05 |
| IsAuditSupported | Bool | 此参数对外不可见。 实例是否支持审计 |
| PeriodEndTime | Datetime | 此参数对外不可见。 实例到期时间，格式为 2006-01-02 15:04:05 |
| Machine | String | 此参数对外不可见。 机型信息 |
| StorageUsage | String | 此参数对外不可见。 存储空间使用率 |
| LogStorage | Int64 | 此参数对外不可见。 日志存储空间大小，单位 GB |
| IsEncryptSupported | Int64 | 此参数对外不可见。 是否支持数据加密。1-支持；0-不支持 |
| Vip6 | String | 此参数对外不可见。 内网IPv6 |
| Cpu | Int64 | 此参数对外不可见。 实例Cpu核数 |
| Pid | Int64 | 此参数对外不可见。 产品类型ID |
| Qps | Int64 | 此参数对外不可见。 最大QPS |
| Ipv6Flag | Int64 | 此参数对外不可见。 是否支持IPv6 |
| WanVipv6 | String | 此参数对外不可见。 外网IPv6地址，公网可访问 |
| WanStatusIpv6 | Int64 | 此参数对外不可见。 外网状态，0-未开通；1-已开通；2-关闭；3-开通中；4-关闭中 |
| WanPortIpv6 | Int64 | 此参数对外不可见。 外网IPv6端口 |
| DbEngine | String | 此参数对外不可见。 数据库引擎 |
| DbVersion | String | 此参数对外不可见。 数据库版本 |
| ResourceTags | ResourceTag | 此参数对外不可见。 标签信息 |
| DcnFlag | Int64 | 此参数对外不可见。 DCN标志，0-无，1-主实例，2-灾备实例 |
| DcnStatus | Int64 | 此参数对外不可见。 DCN状态，0-无，1-创建中，2-同步中，3-已断开 |
| DcnDstNum | Int64 | 此参数对外不可见。 DCN灾备实例数 |
| PlatformProjectId | String | 此参数对外不可见。 平台项目ID |
| PlatformProjectName | String | 此参数对外不可见。 平台项目名称 |
| ReplicaConfig | DCNReplicaConfig | 此参数对外不可见。 只读实例复制配置信息，仅当实例为DCN备时有效 |
| ReplicaStatus | DCNReplicaStatus | 此参数对外不可见。 只读实例复制状态，仅当实例为DCN备时有效 |
| InstanceType | Int64 | 此参数对外不可见。 1： 主实例（独享型）, 2: 主实例, 3： 灾备实例, 4： 灾备实例（独享型） |
| NodesInfo | NodeInfo | 此参数对外不可见。 实例的各个DB节点信息 |
| CpuArch | String | 此参数对外不可见。 cpu架构 |
| RsAccessStrategy | Int64 | 此参数对外不可见。 就近访问策略，0-无策略, 1-可用区就近访问 |
| ExclusterName | String | 资源池名称 |
| ReservedNetResources | ReservedNetResources | 尚未回收的网络资源 |
| IsDcnSqlSyncSupported | Int64 | 是否支持强同步dcn |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.DbOperationFailed | |
| InternalError.GetInstanceDetailFailed | |
| InternalError.GetSubnetFailed | |
| InternalError.OperateDatabaseFailed | |
| InvalidParameter.InstanceNotFound | |
| UnauthorizedOperation.PermissionDenied |