Fetch udredis proxy information - DescribeUDRedisProxyInfo
Overview
Pull all proxy information of udredis
Definition
Public Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Action | string | Corresponding API command name, the current API is DescribeUDRedisProxyInfo . | Yes |
PublicKey | string | The user’s public key can be obtained from Console | Yes |
Signature | string | User signature generated based on public key and API command, see Signature Algorithm | Yes |
Request Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Region | string | Region. See List of Regions and Availability Zones | Yes |
Zone | string | Availability Zone. See Availability Zone List | Yes |
ProjectId | string | Project ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface. | No |
SpaceId | string | udredis instance id | Yes |
Response Field
Field Name | Type | Description Information | Required |
---|---|---|---|
RetCode | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. | Yes |
Action | string | Operation command name. | Yes |
Message | string | Returns an error message, providing detailed description when RetCode is non-zero. | No |
DataSet | array[UDRedisProxyInfo] | UDProxy | Yes |
Data Model
UDRedisProxyInfo
Field Name | Type | Description Information | Required |
---|---|---|---|
ResourceId | string | Proxy Resource ID | Yes |
ProxyId | string | Proxy ID | Yes |
Vip | string | Proxy IP | Yes |
State | string | Proxy Status | Yes |
Example
Request Example
https://api.dezai.com/?Action=DescribeUDRedisProxyInfo
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=SnTuFTYS
&SpaceId=AyGhZPJL
Response Example
{
"Action": "DescribeUDRedisProxyInfoResponse",
"DataSet": "eEoRMcPk",
"RetCode": 0
}