DescribeManagedInstances
1. 接口描述
本接口用于查询一台或多台实例的信息。用户可以根据实例ID、实例名称等条件来查询实例的详细信息。
2. 请求参数
以下请求参数列表仅列出了接口中需要的请求参数
参数名称
必选
类型
描述
instanceIds
否
Array of String
实例ID。
取值可以由多个实例ID组成一个。
最多支持100个ID查询。
instanceName
否
String
实例名称。
ip
否
String
公网IP地址。
lanIp
否
String
内网IP地址。
facName
否
String
地域名称。
cityCode
否
String
城市代码。
pageNum
否
Integer
返回的分页数。
默认值:1。
pageSize
否
Integer
返回的分页大小。
默认值:20。
3. 响应结果
参数名称
类型
描述
requestId
String
唯一请求 ID。
每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
totalCount
Integer
实例数量。
4. 代码示例
POST /api/v2/bmc HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeManagedInstances
<Common Request Params>
Request:
{
"instanceIds": ["instanceId1","instanceId2"]
}
Response:
{
"requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
"response": {
"requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
"totalCount": 1,
"dataSet": [
{
"instanceId": "instanceId1",
"instanceName": "TEST",
"facName": "example",
"ips": [
"1.1.1.1"
],
"lanIps": [
"192.168.0.1"
],
"createTime": "2023-01-01T00:00:00Z"
}
]
}
}
5. 开发者工具
Zenlayer Cloud API 2.0 提供了配套的开发工具集(SDK),未来会陆续支持更多开发语言,方便快速接入和使用Zenlayer的产品和服务。
6. 错误码
下面包含业务逻辑中遇到的错误码,其他错误码见公共错误码
最后更新于