接口描述
您可以通过该接口查询获取实例的详细信息。
请求方式
GET
请求头
参数名称 |
类型 |
是否必须 |
描述 |
X-Version |
String |
是 |
版本号,取值:2020-08-01 |
X-Action |
String |
是 |
操作接口名,取值:DescribeInstances |
请求参数
参数名称 |
类型 |
是否必须 |
示例值 |
描述 |
NamespaceID |
String |
是 |
default-UID |
命名空间ID |
EdgeNodeIDs |
String |
否 |
Jnun11 |
边缘节点ID,多个边缘节点ID以","分隔 |
InstanceIDs |
String |
是 |
i-3422f6efdc3432052421ef67f24b14e1-sxct01 |
如需查询多个实例,以","分隔;InatanceID高优于任何其他查询条件,其他条件为且的关系 |
PrivatedIPAddress |
String |
否 |
10.1.1.1 |
私网IP |
PublicIPAddress |
String |
否 |
200.1.1.1 |
公网弹性IP,目前暂不支持无公网IP创建实例。 |
返回参数
参数名称 |
类型 |
示例值 |
描述 |
RequestID |
String |
3a87cc31-efe6-487c-b28b-11bec3571e7d |
请求ID |
Code |
String |
Success |
状态码,有InvalidParameter,Forbidden InternalError,Success四种状态 |
TotalCount |
Integer |
1 |
Instances数组的元素个数 |
Instances |
Array |
实例信息,以数组形式返回 |
Instances
参数名称 |
类型 |
示例值 |
描述 |
InstanceID |
String |
i-9147f8d6bd69d65b43fbeab3da5ed9621-sxct01 |
实例ID |
InstanceName |
String |
i-9147f8d6bd69d65b43fbeab3da5ed9621-sxct01 |
实例名称 |
InstanceStatus |
String |
Running |
实例状态, 可能存在6种状态,分别是Pending(准备中),Starting(创建中),Running(运行中),Stopping(停止中),Stopped(已停止),Error(错误) |
EdgeNodeID |
String |
Jnun11 |
边缘节点ID |
ImageID |
String |
a700fd4e-e6bc-42e9-bdbd-3664d6d921ae |
镜像ID |
Cpu |
String |
2 |
CPU个数 |
Memory |
String |
20G |
内存大小,单位G |
SystemDisk |
Object |
|
系统盘数据 |
DataDisk |
Array |
|
数据盘数据 |
IPAddresses |
Object |
IP地址数据 |
VpcId |
String |
eb7a729c-984f-47a6-8dbc-9ac4e1bf7aea |
实例所属VPCId |
VSwitchId |
String |
9d4c183c-689b-49f5-a67d-ff10630cc71a |
实例所属VSwitchId |
Livenet |
boolean |
disable/enable |
未使用/使用中 |
SystemDisk
参数名称 |
类型 |
示例值 |
描述 |
VolumeID |
String |
d-5c5cd9139c7a77dd9d1f606c2e65399f-sxct01 |
硬盘ID |
VolumeType |
String |
system |
硬盘类别,系统盘 |
VolumeSize |
String |
20 |
硬盘容量,GB |
DataDisk
参数名称 |
类型 |
示例值 |
描述 |
VolumeID |
String |
d-7b45c1e2f555c8ae682afbde566eda40-sxct01-1 |
硬盘ID |
VolumeType |
String |
data |
硬盘类别,数据盘 |
VolumeSize |
String |
20 |
硬盘容量,GB |
IPAddresses
参数名称 |
类型 |
示例值 |
描述 |
PrivateIPAddress |
String |
172.20.2.3 |
内网IP |
PublicIPAddresses |
Array |
公网弹性IP |
PublicIPAddresses
参数名称 |
类型 |
示例值 |
描述 |
PublicIPAddresses |
String |
183.134.92.68 |
公网弹性IP |
IspName |
String |
ct |
其中ct代表电信,cm代表移动,un代表联通 |
IPVersion |
String |
ipv4 |
ipv4/ipv6 |
请求示例
入参示例
curl --location --request GET 'kenc.api.ksyun.com?NamespaceID=demo' \
--header 'X-Action: DescribeInstances' \
--header 'X-Version: 2020-08-01' \
--header 'Accept: application/json' \
--header 'X-Amz-Date: 20200826T091135Z' \
--header 'Authorization: AWS4-HMAC-SHA256 Credential=AKLTDOTh-1tDQjSosbliA0SRHQ/20200826/beijing-6/kenc/aws4_request, SignedHeaders=host;x-amz-date;x-ksc-account-id, Signature=xxxxxxxxxx'
成功示例
{
"Code": "Success",
"Instances": [
{
"Cpu": "4",
"DataDisk": [
{
"VolumeID": "d-7b45c1e2f555c8ae682afbde566eda40-sxct01-1",
"VolumeSize": "10Gi",
"VolumeType": "data"
}
],
"EdgeNodeID": "sxct01",
"IPs": [
{
"IPVersion": "ipv4",
"IspName": "ct",
"PrivatedIPAddress": "172.20.2.3",
"PublicIPAddress": "183.134.92.68"
}
],
"ImageID": "a700fd4e-e6bc-42e9-bdbd-3664d6d921ae",
"InstanceID": "i-5c5cd9139c7a77dd9d1f606c2e65399f-sxct01",
"InstanceStatus": "Running",
"Memory": "4Gi",
"SystemDisk": {
"VolumeID": "d-5c5cd9139c7a77dd9d1f606c2e65399f-sxct01",
"VolumeSize": "20Gi",
"VolumeType": "system"
}
}
],
"RequestId": "903ce782-47e1-4f19-9c42-0e08c3a7a397",
"TotalCount": 1
}
失败示例
{
"RequestId": "1312fefe-ca48-4d72-8521-cf5d2cf06b9c",
"Code": "InvalidParameter",
"Message": "Invalid param NameSpaceID."
}