Help Center/ GeminiDB/ API Reference/ API v3/ Instances/ Querying High-Risk Commands
Updated on 2026-09-22 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 GeminiDB Redis instances (excluding Redis Cluster instances with classic storage).

Authorization Information

Each account has permissions to call all APIs, but IAM users must have the required permissions specifically assigned.

  • If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    gaussdbfornosql:instance:listHighRiskCommands

    List

    instance *

    • g:ResourceTag/<tag-key>
    • g:EnterpriseProjectId

    nosql:command:list

    -

URI

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

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

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

Constraints

N/A

Range

The value contains 32 characters. Only letters and digits are allowed.

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID. To obtain the value, call the Querying Instances and Details API. If no instance is available, call the Creating an Instance API to create one.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token

You can obtain the token by calling the IAM API by following Obtaining a User Token Through Password Authentication.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

commands

Array of Table 4 objects

Definition

High-risk commands and their corresponding renamed commands.

Table 4 CommandInfo

Parameter

Type

Description

origin_name

String

Definition

Original high-risk commands

Range

Currently, the following commands are supported:

  • keys: searches for keys in fuzzy mode.
  • flushdb: clears data in the current database.
  • flushall: clears data in all databases.
  • hgetall: reads all fields and values of a hash at a time.
  • hkeys: displays the list of hash field names.
  • hvals: displays the list of hash values.
  • smembers: displays all members of a set.

name

String

Definition

Name of an enabled command. If this parameter is left blank, the command is disabled. The value can contain a maximum of 30 characters, including digits, letters, and underscores (_).

Range

N/A

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.