Updated on 2024-08-08 GMT+08:00

Querying High-Risk Commands

Function

This API is used to query high-risk commands supported by a GeminiDB Redis instance.

Constraints

This API supports only proxy-based general-purpose GeminiDB Redis instances.

URI

GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/high-risk-commands

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

instance_id

Yes

String

Instance ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

commands

Array of objects

High-risk commands and their corresponding renamed commands. For details, see Table 4.

Table 4 CommandInfo

Parameter

Type

Description

origin_name

String

Original high-risk commands. The following commands are supported: KEYS, FLUSHDB, FLUSHALL, HGETALL, HKEYS, HVALS, and SMEMBERS.

name

String

Name of the command that takes effect. If this parameter is left blank, the command is disabled. The name can include 0 to 30 characters, including digits, uppercase letters, lowercase letters, and underscores (_).

Minimum characters: 0

Maximum characters: 30

Example Requests

GET https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/41409e5a49ee467287d738b9b6d0adcbin12/high-risk-commands

Example Responses

Status code: 200

Success

{ 
  "commands" : [ { 
    "origin_name" : "keys", 
    "name" : "newKeys" 
  }, { 
    "origin_name" : "flushdb", 
    "name" : "newFlushdb" 
  }, { 
    "origin_name" : "flushall", 
    "name" : "newFlushall" 
  }, { 
    "origin_name" : "hgetall", 
    "name" : "newHgetall" 
  }, { 
    "origin_name" : "hkeys", 
    "name" : "newHkeys" 
  }, { 
    "origin_name" : "hvals", 
    "name" : "newHvals" 
  }, { 
    "origin_name" : "smembers", 
    "name" : "newSmembers" 
  } ] 
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.