All Products
Search
Document Center

:ListSecrets

Last Updated:Feb 05, 2026

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
apig:ListSecretslist
*All Resources
*
    none
none

Request syntax

GET /v1/secrets HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
nameLikestringNo

Secret name for fuzzy matching, supports filtering secrets by name

test-secret
pageNumberintegerNo

Page number

1
pageSizeintegerNo

Number of items per page

10
gatewayTypestringNo

Gateway type for filtering secrets of specific gateway type

API

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

requestIdstring

Id of the request

2F270C0B-7D6A-5DA7-93E2-******
codestring

Code of the request

200
messagestring

message

success
dataobject

Data

totalSizeinteger

Total number of records matching the query

104
pageNumberinteger

Page number

1
pageSizeinteger

Number of items per page

10
itemsarray<object>

Array of secret details

itemobject

object

gatewayTypestring

Gateway type associated with the secret

API
referenceCountinteger

Number of resources referencing this secret

5
namestring

Name of the secret

test-secret
kmsConfigKMSConfig

KMS configuration object

secretIdstring

Source of the ID

xxxxxx
secretSourcestring

Source of the secret

KMS
updateTimestamplong

Unix timestamp when the secret was last updated

1234567890
createTimestamplong

Unix timestamp when the secret was created

1234567890
statusstring

Current status of the secret

ENABLE

Examples

Sample success responses

JSONformat

{
  "requestId": "2F270C0B-7D6A-5DA7-93E2-******",
  "code": 200,
  "message": "success",
  "data": {
    "totalSize": 104,
    "pageNumber": 1,
    "pageSize": 10,
    "items": [
      {
        "gatewayType": "API",
        "referenceCount": 5,
        "name": "test-secret",
        "kmsConfig": {
          "kmsInstanceId": "",
          "kmsKeyId": ""
        },
        "secretId": "xxxxxx",
        "secretSource": "KMS",
        "updateTimestamp": 1234567890,
        "createTimestamp": 1234567890,
        "status": "ENABLE"
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2026-01-07Add OperationView Change Details