获取GlobalSSH实例列表 - DescribeGlobalSSHInstance
简介
获取GlobalSSH实例列表（传实例ID获取单个实例信息，不传获取项目下全部实例）
定义
公共参数
| 参数名 | 类型 | 描述信息 | 必填 |
|---|---|---|---|
| Action | string | 对应的 API 指令名称，当前 API 为 DescribeGlobalSSHInstance | Yes |
| PublicKey | string | 用户公钥，可从 控制台 获取 | Yes |
| Signature | string | 根据公钥及 API 指令生成的用户签名，参见 签名算法 | Yes |
请求参数
| 参数名 | 类型 | 描述信息 | 必填 |
|---|---|---|---|
| ProjectId | string | 项目ID，如org-xxxx。请参考GetProjectList接口 | Yes |
| InstanceId | string | 实例ID，资源唯一标识 | No |
响应字段
| 字段名 | 类型 | 描述信息 | 必填 |
|---|---|---|---|
| RetCode | int | 返回状态码，为 0 则为成功返回，非 0 为失败 | Yes |
| Action | string | 操作指令名称 | Yes |
| Message | string | 返回错误消息，当 RetCode 非 0 时提供详细的描述信息 | No |
| InstanceSet | array[GlobalSSHInfo] | GlobalSSH实例列表，实例的属性参考GlobalSSHInfo模型 | No |
数据模型
GlobalSSHInfo
| 字段名 | 类型 | 描述信息 | 必填 |
|---|---|---|---|
| InstanceId | string | 实例ID，资源唯一标识 | Yes |
| InstanceType | string | 枚举值：[“Enterprise”,“Basic”,“Free”,“Welfare”], 分别代表企业版，基础版本，免费版本，较早的公测免费版 | Yes |
| AcceleratingDomain | string | GlobalSSH分配的加速域名。 | Yes |
| Area | string | 被SSH访问的IP所在地区 | Yes |
| TargetIP | string | 被SSH访问的源站 IPv4地址。 | Yes |
| Remark | string | 备注信息 | Yes |
| Port | int | 源站服务器监听的SSH端口，windows系统为RDP端口 | Yes |
| GlobalSSHPort | int | InstanceType等于Free时，由系统自动分配，不等于源站Port值。InstanceType不等于Free时，与源站Port值相同。 | Yes |
| ChargeType | string | 支付周期，如Month,Year,Dynamic等 | Yes |
| CreateTime | int | 资源创建时间戳 | Yes |
| ExpireTime | int | 资源过期时间戳 | Yes |
| Expire | boolean | 是否过期 | Yes |
| IPV6Access | boolean | 是否开启EIP IPV6 接入,Flase:未开启 | No |
| ExtraDomain | array[string] | GlobalSSH分配的其他可用加速域名列表 | No |
| BandwidthPackage | int | globalssh Ultimate带宽包大小 | No |
| ForwardRegion | string | InstanceType为Basic版本时，需要展示具体分配的转发机房 | No |
| DomainStatus | object | 加速域名当前可用性检测结果 HashMap 结构 0表示可用, 1 表示有污染 | No |
示例
请求示例
https://api.an-link.com/?Action=DescribeGlobalSSHInstance
&ProjectId=UjsPseDf
&InstanceId=djsjuLQU响应示例
{
"Action": "DescribeGlobalSSHInstanceResponse",
"InstanceSet": [
{
"AcceleratingDomain": "muLRknRb",
"Area": "rojJRrWD",
"BandwidthPackage": 5,
"ChargeType": "Year",
"CreateTime": 4,
"DomainStatus": {},
"Expire": true,
"ExpireTime": 7,
"ExtraDomain": [
"JSweMMIB"
],
"ForwardRegion": "yBKumXLK",
"GlobalSSHPort": 5,
"IPV6Access": false,
"InstanceId": "jUtFMSnm",
"InstanceType": "ZpSbjafD",
"Port": 2,
"Remark": "mtRmapTE",
"TargetIP": "OhMnFNvq"
}
],
"RetCode": 0
}