DescribeDBInstance

调用 DescribeDBInstance 接口获取 MySQL 实例的详细信息。

请求类型

同步请求。

请求参数

返回参数

请求示例

POST /?Action=DescribeDBInstance&Version=2018-01-01 HTTP/1.1
Content-Type: application/json
Host: rds.volcengineapi.com
X-Date: 20211202T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mysql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c645a****

{
    "InstanceId" : "rds-mysql-h441603c68aaa****"
}

返回示例

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "202210141744040102040280350747E3B3",
        "Action": "DescribeDBInstance",
        "Version": "2018-01-01",
        "Service": "rds_mysql",
        "Region": "cn-beijing"
    },
    "Result": {
        "BasicInfo": {
            "AccountId": "",
            "AllowListVersion": "v1",
            "ChargeStatus": "Normal",
            "ChargeType": "PostPaid",
            "CreateTime": "2022-07-15 11:26:27",
            "DBEngine": "MySQL",
            "DBEngineVersion": "MySQL_Community_5_7",
            "DBEngineVersionStr": "MySQL 5.7",
            "ExtendInfo": {
                "VpcName": ""
            },
            "InstanceCategory": "Primary",
            "InstanceDesc": "",
            "InstanceId": "mysql-a65db2ff****",
            "InstanceName": "xuzhuotest",
            "InstanceSpec": {
                "CpuNum": 1,
                "DBEngineVersion": "MySQL_Community_5_7",
                "InstanceFamily": "General",
                "Iops": 3000,
                "MaxConn": 600,
                "MemInGb": 2,
                "SpecName": "rds.mysql.1c2g"
            },
            "InstanceSpecStr": "1C / 2GB / 100GB",
            "InstanceStatus": "Running",
            "InstanceType": "HA",
            "MaintainPeriods": "Sunday,Monday,Tuesday,Wednesday,Thursday,Friday,Saturday",
            "MaintainTime": "03:00-06:00",
            "MasterInstanceId": "",
            "ProjectName": "",
            "ReadOnlyInstanceIds": [],
            "Region": "cn-beijing",
            "ServerCollation": "",
            "ShardNumber": 0,
            "Sharding": false,
            "StorageSpaceGB": 100,
            "StorageType": "LocalSSD",
            "StorageUseGB": 0,
            "SubnetId": "subnet-13fw99ulj7tog3n6nu4zx****",
            "UpdateTime": "",
            "VpcID": "vpc-13fw994y4r4003n6nu485****",
            "VpcName": "xuzhuotest-bj",
            "Zone": "cn-beijing-b",
            "ZoneDesc": "华北 2（北京）-可用区B",
            "TempModifyEndTime": "2023-05-16T13:48:58.000Z",
            "TempModifyStartTime": "2023-05-11T13:48:58.000Z"
        },
        "ConnectionInfo": {
            "Domain": "",
            "EnableReadOnly": "Disable",
            "EnableReadWriteSplitting": "Disable",
            "InnerDomain": "",
            "InnerPort": "",
            "InternalDomain": "mysqla65db2ffae01.rds.ivolces.com",
            "InternalPort": "3306",
            "InternalVIP": "192.168.0.***",
            "Port": "",
            "PublicDomain": "106.120.188.***",
            "PublicPort": "3306",
            "PublicVIP": "106.120.188.***",
            "ReadOnlyUnchangeable": false,
            "ReadOnlyUnchangeableReason": "",
            "ReadWriteSplittingDomain": "",
            "ReadWriteSplittingPort": "",
            "StorageInnerDomain": "",
            "StorageInnerPort": ""
        },
        "DataSyncMode": "SemiSync",
        "StorageType": "LocalSSD",
        "UnchangeableEndTime": "",
        "UnchangeableStartTime": ""
    }
}

错误码

更多详情，请参见错误码。