拉取udredis代理信息 - DescribeUDRedisProxyInfo
简介
拉取udredis所有的代理信息
定义
公共参数
| 参数名 | 类型 | 描述信息 | 必填 | 
|---|---|---|---|
| Action | string | 对应的 API 指令名称,当前 API 为 DescribeUDRedisProxyInfo | Yes | 
| PublicKey | string | 用户公钥,可从 控制台 获取 | Yes | 
| Signature | string | 根据公钥及 API 指令生成的用户签名,参见 签名算法 | Yes | 
请求参数
| 参数名 | 类型 | 描述信息 | 必填 | 
|---|---|---|---|
| Region | string | 地域。 参见 地域和可用区列表 | Yes | 
| Zone | string | 可用区。参见 可用区列表 | Yes | 
| ProjectId | string | 项目ID。不填写为默认项目,子帐号必须填写。 请参考GetProjectList接口 | No | 
| SpaceId | string | udredis实例id | Yes | 
响应字段
| 字段名 | 类型 | 描述信息 | 必填 | 
|---|---|---|---|
| RetCode | int | 返回状态码,为 0 则为成功返回,非 0 为失败 | Yes | 
| Action | string | 操作指令名称 | Yes | 
| Message | string | 返回错误消息,当 RetCode非 0 时提供详细的描述信息 | No | 
| DataSet | array[UDRedisProxyInfo] | 代理数据集 | Yes | 
数据模型
UDRedisProxyInfo
| 字段名 | 类型 | 描述信息 | 必填 | 
|---|---|---|---|
| ResourceId | string | 代理资源id | Yes | 
| ProxyId | string | 代理id | Yes | 
| Vip | string | 代理ip | Yes | 
| State | string | 代理状态 | Yes | 
示例
请求示例
https://api.tnqacloud.com/?Action=DescribeUDRedisProxyInfo
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=SnTuFTYS
&SpaceId=AyGhZPJL响应示例
{
  "Action": "DescribeUDRedisProxyInfoResponse",
  "DataSet": "eEoRMcPk",
  "RetCode": 0
}