查看实例

接口描述

查看SQLServer实例列表或详情

Action: DescribeDBInstances

Version: 2019-04-25

请求方法: GET

请求参数

参数名称	参数描述	是否必填	参数类型	取值范围	样例
DBInstanceIdentifier	实例Id	否	String	UUID类型，不传返回实例列表	1de3cacc-71f1-4f55-8bd6-c26c27fd4c7c
Order	排序方式	否	String	DEFAULT:按创建时间倒序\| GROUP：按复制组关系排序。默认值：DEFAULT	DEFAULT
DBInstanceStatus	按实例状态过滤	否	String	ACTIVE: 运行中实例\| INVALID：已过期实例	ACTIVE
Keyword	关键字过滤	否	String	可按名称、VIP进行模糊匹配	10.111.0.1
Marker	获取记录开始偏移量	否	Integer	整型，默认值是0	10
MaxRecords	每页结果中包含的条数	否	Integer	10-100，默认值：10	30

请求示例

http://sqlserver.api.ksyun.com/?Action=DescribeDBInstances&Version=2019-04-25

返回参数说明

字段	描述
Data	数据部分
Instances	实例列表包含：SQLServer 实例数据结构
RequestId	唯一标志符

返回样例

{
    "Data": {
        "Instances": [
            {
                "DBInstanceClass": {
                    "Id": "RDSOpenAPI_c6949ae07b53a0b6",
                    "Vcpus": 1,
                    "Disk": 80,
                    "Ram": 2
                },
                "DBInstanceIdentifier": "e299d3f6-d9cc-408f-8d1a-7d927e9148c0",
                "DBInstanceName": "qichenliang",
                "DBInstanceStatus": "ACTIVE",
                "DBInstanceType": "HRDS_SS",
                "GroupId": "c8035411-9ac4-4efc-96cc-8aa55efaf978",
                "Vip": "10.0.1.21",
                "Port": 1433,
                "Engine": "sqlserver",
                "EngineVersion": "2016",
                "InstanceCreateTime": "2019-12-19T22:10:22+0800",
                "MasterUserName": "admin",
                "VpcId": "ba083f85-ec4b-4f42-b4d5-a8bd582e558a",
                "SubnetId": "30ec7fa7-f6bd-4e2c-8d39-c82c273d1250",
                "PubliclyAccessible": true,
                "ReadReplicaDBInstanceIdentifiers": [],
                "BillType": "HourlyInstantSettlement",
                "OrderType": "REGULAR",
                "OrderSource": "CONSOLE",
                "MultiAvailabilityZone": false,
                "MasterAvailabilityZone": "cn-shanghai-3b",
                "SlaveAvailabilityZone": "cn-shanghai-3b",
                "ProductId": "57fbab0d-5d4b-4fbd-b472-199aff416823",
                "OrderUse": "BUY",
                "ProjectId": 0,
                "ProjectName": "默认项目",
                "Region": "cn-shanghai-3",
                "BillTypeId": 87
            },
            {
                "DBInstanceClass": {
                    "Id": "RDSOpenAPI_d946fbbcbfa89b10",
                    "Vcpus": 1,
                    "Disk": 5,
                    "Ram": 1
                },
                "DBInstanceIdentifier": "66b5ef93-9377-443f-a89d-a26252408ede",
                "DBInstanceName": "hlf_sqlserver_3",
                "DBInstanceStatus": "ACTIVE",
                "DBInstanceType": "HRDS_SS",
                "GroupId": "c587e969-0c87-4c30-b37c-a2e131cdb958",
                "SecurityGroupId": "27985",
                "Vip": "172.31.1.60",
                "Port": 1433,
                "Engine": "sqlserver",
                "EngineVersion": "2016",
                "InstanceCreateTime": "2019-12-13T17:50:06+0800",
                "MasterUserName": "admin",
                "VpcId": "9d4d768e-36ff-49b0-b72d-dc8b760c51cb",
                "SubnetId": "d3f42a3b-5b6b-4a24-9e6c-785941540d23",
                "PubliclyAccessible": true,
                "ReadReplicaDBInstanceIdentifiers": [],
                "BillType": "HourlyInstantSettlement",
                "OrderType": "REGULAR",
                "OrderSource": "CONSOLE",
                "MultiAvailabilityZone": false,
                "MasterAvailabilityZone": "cn-shanghai-3b",
                "SlaveAvailabilityZone": "cn-shanghai-3b",
                "ProductId": "897235d5-1bb1-4354-acda-4838a8dec3e0",
                "OrderUse": "BUY",
                "ProjectId": 0,
                "ProjectName": "默认项目",
                "Region": "cn-shanghai-3",
                "BillTypeId": 87
            }
        ],
        "TotalCount": 2,
        "MaxRecords": 10,
        "Marker": 2
    },
    "RequestId": "bff7a150-726d-4722-a60a-a5a416fd2c12"
}

文档导读

上一篇：创建实例

下一篇：删除实例

纯净模式常规模式

纯净模式

点击可全屏预览文档内容