Query all configuration files of master-slave Redis - DescribeURedisConfig
Overview
Query all configuration files of master-slave Redis
Definition
Public Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Action | string | Corresponding API command name, the current API is DescribeURedisConfig . | Yes |
PublicKey | string | The user's public key can be obtained from Console (opens in a new tab) | 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, and the sub-account must be filled in. Please refer to the GetProjectList interface. | No |
RegionFlag | boolean | Is it a cross-IDC URedis (default is false) | Yes |
Version | string | Redis Version Number | No |
ConfigId | string | Configuration File ID | No |
Offset | int | The starting offset of the page display, the default value is 0 | No |
Limit | int | Number of items displayed per page, default value is 10 | No |
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 |
TotalCount | int | Total count based on filter conditions | No |
DataSet | array[URedisConfigSet] | Configuration File List See URedisConfigSet | No |
Data Model
URedisConfigSet
Field Name | Type | Description Information | Required |
---|---|---|---|
Zone | string | Zone | No |
ConfigId | string | Configuration ID | No |
Name | string | Configuration Name | No |
Description | string | Configuration Description | No |
Version | string | Configure the corresponding Redis version | No |
IsModify | string | Whether it can be modified | No |
State | string | The status of the configuration | No |
CreateTime | int | Creation Time (UNIX Timestamp) | No |
ModifyTime | int | Modification Time (UNIX Timestamp) | No |
RegionFlag | boolean | Is it a cross-IDC URedis (default is false) | No |
Example
Request Example
https://api.surfercloud.com/?Action=DescribeURedisConfig
&Region=cn-zj
&Zone=cn-zj-01
&ConfigId=EmTNpurL
&Offset=8
&Limit=2
&ProjectId=VuPSDiad
&Version=qyhfGmaZ
Response Example
{
"Action": "DescribeURedisConfigResponse",
"DataSet": [
{
"ConfigId": "03f58ca9-b64d-4bdd-abc7-c6b9a46fd801",
"CreateTime": 1425458755,
"Description": "default-config",
"IsModify": "Unmodifiable",
"ModifyTime": 1425458755,
"Name": "redis-3.0",
"RegionFlag": false,
"State": "Usable",
"Version": "3.0",
"Zone": "......"
}
],
"RetCode": 0,
"TotalCount": 1
}