获取NAT网关可配置端口转发规则的资源信息 - GetAvailableResourceForPolicy
简介
获取NAT网关可配置端口转发规则的资源信息
定义
公共参数
参数名 | 类型 | 描述信息 | 必填 |
---|---|---|---|
Action | string | 对应的 API 指令名称,当前 API 为 GetAvailableResourceForPolicy | Yes |
PublicKey | string | 用户公钥,可从 控制台 获取 | Yes |
Signature | string | 根据公钥及 API 指令生成的用户签名,参见 签名算法 | Yes |
请求参数
参数名 | 类型 | 描述信息 | 必填 |
---|---|---|---|
Region | string | 地域。 参见 地域和可用区列表 | Yes |
ProjectId | string | 项目Id。不填写为默认项目,子帐号必须填写。 请参考GetProjectList接口 | No |
NATGWId | string | NAT网关Id | Yes |
Limit | int | 返回数据长度,默认为20 | No |
Offset | int | 列表起始位置偏移量,默认为0 | No |
响应字段
字段名 | 类型 | 描述信息 | 必填 |
---|---|---|---|
RetCode | int | 返回状态码,为 0 则为成功返回,非 0 为失败 | Yes |
Action | string | 操作指令名称 | Yes |
Message | string | 返回错误消息,当 RetCode 非 0 时提供详细的描述信息 | No |
DataSet | array[GetAvailableResourceForPolicyDataSet] | 支持资源类型的信息 | Yes |
数据模型
GetAvailableResourceForPolicyDataSet
字段名 | 类型 | 描述信息 | 必填 |
---|---|---|---|
ResourceId | string | 资源的Id | Yes |
PrivateIP | string | 资源对应的内网Ip | Yes |
ResourceType | string | 资源类型。“uhost”:云主机; “upm”,物理云主机; “hadoophost”:hadoop节点; “fortresshost”:堡垒机: “udockhost”,容器 | Yes |
示例
请求示例
https://api.an-link.com/?Action=GetAvailableResourceForPolicy
&Region=xxx
&ProjectId=xxx
&NATGWId=CuqLxGDE
&Limit=1000
&Offset=0
响应示例
{
"Action": "GetAvailableResourceForPolicyResponse",
"DataSet": [
{
"PrivateIP": "xxxx",
"ResourceId": "xxxx",
"ResourceType": "xxxx"
}
],
"RetCode": 0,
"TotalCount": 1
}