Querying Disabled Commands for a Redis Instance
Function
This API is used to query disabled commands for a Redis instance.
Constraints
This API supports only GeminiDB Redis instances.
URI
GET https://{Endpoint}/v3/{project_id}/redis/instances/{instance_id}/disabled-commands
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Explanation: Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints: N/A Values: N/A Default value: N/A |
instance_id |
Yes |
String |
Explanation: Instance ID Constraints: N/A Values: N/A Default value: N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
type |
Yes |
String |
Explanation: Disabled type Constraints: N/A Values:
Default value: N/A |
offset |
No |
Integer |
Explanation: Index position. If offset is set to N, the command information is queried from the N+1 piece of data. Constraints: N/A Values: ≥ 0 Default value: 0 |
limit |
No |
Integer |
Explanation: Maximum records to be queried Constraints: N/A Values: 1–50 Default value: 50 |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Explanation: User token Constraints: N/A Values: N/A Default value: N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total_count |
String |
Explanation: Total number Values: N/A |
disabled_type |
String |
Explanation: Command type Values: Enumerated values:
|
commands |
Array of strings |
Explanation: This parameter is displayed when disabled_type is set to command. Values: Enumerated values:
|
keys |
Array of objects in Table 5 |
Explanation: This parameter is displayed when disabled_type is set to key. A maximum of 20 keys are supported. Values: N/A |
Parameter |
Type |
Description |
---|---|---|
db_id |
String |
Explanation: Database where a key is located Values: N/A |
key |
String |
Explanation: Key name Values: N/A |
commands |
Array of strings |
Explanation: Command list Values: N/A |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code |
error_msg |
String |
Error message |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code |
error_msg |
String |
Error message |
Example Requests
- Querying disabled commands for a redis instance. By default, the first 50 instances are queried.
GET https://{endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/redis/instances/0a9a2be86bdf493981d17626ad2f8668in12/disabled-commands?type=command
- Querying disabled commands for a Redis instance
GET https://{endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/redis/instances/0a9a2be86bdf493981d17626ad2f8668in12/disabled-commands?type=key&offset=0&limit=10
Example Responses
Status code: 200
Success.
{ "total_count" : 2, "disabled_type" : "key", "keys" : [ { "db_id" : "0", "key" : "name", "commands" : [ "get" ] }, { "db_id" : "0", "key" : "address", "commands" : [ "get", "set" ] } ] }
Status Codes
For details, see Status Codes.
Error Codes
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot