云数据库 MariaDB 查询实例详细信息 |
您所在的位置：网站首页 › 获取api信息失败 › 云数据库 MariaDB 查询实例详细信息 |
|
1. 接口描述 接口请求域名： mariadb.tencentcloudapi.com 。 本接口(DescribeDBInstanceDetail)用于查询指定实例的详细信息。 默认接口请求频率限制：20次/秒。 推荐使用 API Explorer 点击调试 API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。 2. 输入参数以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。 参数名称 必选 类型 描述 Action 是 String 公共参数，本接口取值：DescribeDBInstanceDetail。 Version 是 String 公共参数，本接口取值：2017-03-12。 Region 是 String 公共参数，详见产品支持的 地域列表。 InstanceId 是 String 实例Id形如：tdsql-ow728lmc。 3. 输出参数 参数名称 类型 描述 InstanceId String 实例Id InstanceName String 实例名称 Status Integer 实例状态 StatusDesc String 实例目前运行状态描述 Vip String 内网 IP 地址 Vport Integer 内网端口 IsTmp Integer 是否临时实例，0为否，非0为是 NodeCount Integer 节点数，2为一主一从，3为一主二从 Region String 实例所在地域名称，如 ap-shanghai Zone String 实例所在可用区名称，如 ap-shanghai-1 VpcId String 字符串型的私有网络Id SubnetId String 字符串型的私有网络子网Id WanStatus Integer 外网状态，0-未开通；1-已开通；2-关闭；3-开通中；4-关闭中 WanDomain String 外网访问的域名，公网可解析 WanVip String 外网 IP 地址，公网可访问 WanPort Integer 外网端口 ProjectId Integer 实例所属项目 Id TdsqlVersion String TDSQL 版本信息 Memory Integer 实例内存大小，单位 GB Storage Integer 实例存储大小，单位 GB MasterZone String 主可用区，如 ap-shanghai-1 SlaveZones Array of String 从可用区列表，如 [ap-shanghai-2] AutoRenewFlag Integer 自动续费标志：0 否，1 是 ExclusterId String 独享集群Id，普通实例为空 PayMode String 付费模式：prepaid 表示预付费 CreateTime Timestamp 实例创建时间，格式为 2006-01-02 15:04:05 IsAuditSupported Boolean 实例是否支持审计 PeriodEndTime Timestamp 实例到期时间，格式为 2006-01-02 15:04:05 Machine String 机型信息 StorageUsage String 存储空间使用率 LogStorage Integer 日志存储空间大小，单位 GB IsEncryptSupported Integer 是否支持数据加密。1-支持；0-不支持 Vip6 String 内网IPv6注意：此字段可能返回 null，表示取不到有效值。 Cpu Integer 实例Cpu核数 Pid Integer 产品类型ID Qps Integer 最大QPS Ipv6Flag Integer 是否支持IPv6注意：此字段可能返回 null，表示取不到有效值。 WanVipv6 String 外网IPv6地址，公网可访问注意：此字段可能返回 null，表示取不到有效值。 WanStatusIpv6 Integer 外网状态，0-未开通；1-已开通；2-关闭；3-开通中；4-关闭中注意：此字段可能返回 null，表示取不到有效值。 WanPortIpv6 Integer 外网IPv6端口注意：此字段可能返回 null，表示取不到有效值。 DbEngine String 数据库引擎注意：此字段可能返回 null，表示取不到有效值。 DbVersion String 数据库版本注意：此字段可能返回 null，表示取不到有效值。 ResourceTags Array of ResourceTag 标签信息 DcnFlag Integer DCN标志，0-无，1-主实例，2-灾备实例注意：此字段可能返回 null，表示取不到有效值。 DcnStatus Integer DCN状态，0-无，1-创建中，2-同步中，3-已断开注意：此字段可能返回 null，表示取不到有效值。 DcnDstNum Integer DCN灾备实例数注意：此字段可能返回 null，表示取不到有效值。 InstanceType Integer 1： 主实例（独享型）, 2: 主实例, 3： 灾备实例, 4： 灾备实例（独享型）注意：此字段可能返回 null，表示取不到有效值。 NodesInfo Array of NodeInfo 实例的各个DB节点信息注意：此字段可能返回 null，表示取不到有效值。 IsMaxUserConnectionsSupported Boolean 实例是否支持设置用户连接数限制，内核为10.1暂不支持。注意：此字段可能返回 null，表示取不到有效值。 DbVersionId String 对外显示的数据库版本注意：此字段可能返回 null，表示取不到有效值。 EncryptStatus Integer 加密状态, 0-未开启，1-已开启注意：此字段可能返回 null，表示取不到有效值。 ReplicaConfig DCNReplicaConfig DCN的配置信息注意：此字段可能返回 null，表示取不到有效值。 ReplicaStatus DCNReplicaStatus DCN的运行状态注意：此字段可能返回 null，表示取不到有效值。 ExclusterType Integer 独享集群类型，0:公有云, 1:金融围笼, 2:CDC集群注意：此字段可能返回 null，表示取不到有效值。 RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 4. 示例示例1 查询实例详细信息输入示例POST / HTTP/1.1 Host: mariadb.tencentcloudapi.com Content-Type: application/json X-TC-Action: DescribeDBInstanceDetail { "InstanceId": "tdsql-jv8z8fhl" } 输出示例{ "Response": { "WanStatus": 0, "Zone": "ap-guangzhou-2", "Pid": 1002231, "WanPortIpv6": 0, "Storage": 10, "Machine": "SH12", "AutoRenewFlag": 0, "NodesInfo": [ { "Role": "xx", "NodeId": "xx" } ], "Memory": 2, "Status": 2, "Vip6": "", "MasterZone": "ap-guangzhou-1", "VpcId": "vpc-hqxhp43z", "IsEncryptSupported": 0, "InstanceId": "tdsql-jv8z8fhl", "WanVipv6": "", "SlaveZones": [ "ap-guangzhou-2", "ap-guangzhou-2" ], "TdsqlVersion": "基于MariaDB 10.0.10设计(兼容MySQL 5.5)", "WanStatusIpv6": 0, "SubnetId": "subnet-15y3y4eo", "InstanceType": 0, "StorageUsage": "10.1", "DcnStatus": 0, "DbVersion": "5.7.17", "DcnDstNum": 0, "ProjectId": 0, "Region": "ap-guangzhou", "DbEngine": "Percona", "IsTmp": 0, "PayMode": "1", "PeriodEndTime": "2020-09-22 00:00:00", "ResourceTags": [ { "TagKey": "k1", "TagValue": "v1" } ], "RequestId": "14f6980a-7fe1-11ea-b896-525400542aa6", "Ipv6Flag": 0, "StatusDesc": "运行中", "InstanceName": "cos_test", "Cpu": 1, "DcnFlag": 0, "IsAuditSupported": true, "WanDomain": "", "WanPort": 0, "CreateTime": "2020-09-22 00:00:00", "Vip": "192.168.240.44", "ExclusterId": "", "LogStorage": 8, "NodeCount": 3, "Qps": 2100, "Vport": 3306, "WanVip": "", "IsMaxUserConnectionsSupported": true, "DbVersionId": "5.7", "ReplicaConfig": { "DelayReplicationType": "xx", "ReplicationDelay": 0, "RoReplicationMode": "xx", "DueTime": "xx" }, "ReplicaStatus": { "Status": "xx", "Delay": 0 }, "EncryptStatus": 0, "ExclusterType": 0 } } 5. 开发者资源腾讯云 API 平台腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。 API Inspector用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。 SDK云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。 Tencent Cloud SDK 3.0 for Python Tencent Cloud SDK 3.0 for Java Tencent Cloud SDK 3.0 for PHP Tencent Cloud SDK 3.0 for Go Tencent Cloud SDK 3.0 for NodeJS Tencent Cloud SDK 3.0 for .NET Tencent Cloud SDK 3.0 for C++ Tencent Cloud SDK 3.0 for Ruby 命令行工具 Tencent Cloud CLI 3.0 6. 错误码以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。 错误码 描述 InternalError.DbOperationFailed 查询数据库失败。 InternalError.GetInstanceDetailFailed 获取实例详情失败。 InternalError.GetSubnetFailed 查询虚拟私有网络子网信息失败。 InternalError.OperateDatabaseFailed 操作数据库失败。 InvalidParameter.InstanceNotFound 未找到请求的实例。 UnauthorizedOperation.PermissionDenied 没有权限操作该接口或资源。 |
今日新闻 |
推荐新闻 |
| CopyRight 2018-2019 办公设备维修网 版权所有 豫ICP备15022753号-3 |