All Products
Search

This Product

    API Gateway:ListSecretReferences

    Document Center

    API Gateway:ListSecretReferences

    Last Updated:Mar 30, 2026

    Lists key references.

    Operation description

    create multiple services at a time.

    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.
    Operation Access level Resource type Condition key Associated operation
    apig:ListSecretReferences list
    *Domain
    acs:apig:{#regionId}:{#accountId}:secret/{#SecretId}
      none
    		 none

    Request syntax

    GET /v1/secrets/{secretId}/references HTTP/1.1

    Request parameters

    Parameter Type Required Description Example
    pageNumber integer No

    The page number. The value starts from 1. Default value: 1.

    		 1
    pageSize integer No

    The number of entries per page.

    		 10
    secretId string No

    The ID of the key.

    		 sec-d5e6shmm1hkoxxxxxxxx

    Response parameters

    Parameter Type Description Example
    object

    Schema of Response
    requestId string

    Id of the request

    		 CE857A85-251D-5018-8103-A38957D71***
    code string

    The status code.

    		 Ok
    message string

    The response message.

    		 success
    data object

    The returned data.
    totalSize integer

    The total number of entries returned.

    		 25
    pageNumber integer

    The page number.

    		 1
    pageSize integer

    The number of entries per page.

    		 10
    items array<object>

    The list of reference details.
    item object

    The details of the reference.
    gatewayId string

    The gateway instance ID.

    		 gw-xxxx
    resourceType string

    The type of resource.

    		 Plugin
    mcpServerConfig object

    MCP service information that references the current key.
    routeId string

    The route ID.

    		 hr-cv0i5oum1hkhxxxxxxxx
    name string

    The route name.

    		 mcp
    httpApiId string

    The HTTP API ID.

    		 api-d2vv43em201hxxxxxxxx
    consumerConfig object

    The consumer information that references the current key.
    consumerId string

    The consumer ID.

    		 cs-d0iltnem1hkhxxxxxxxx
    name string

    The consumer name.

    		 myconsumer
    PluginConfig object

    The information about the plug-in that references the current key.
    pluginId string

    The plug-in ID.

    		 pl-d4ijk56m1hkhxxxxxxxx
    name string

    The plug-in name.

    		 oauth
    pluginClassId string

    The plug-in type ID.

    		 pls-xxxxxxxx
    ServiceConfig object

    The service information that references the current key.
    serviceId string

    The service ID.

    		 svc-cvgbtcmm1hkmxxxxxxxx
    name string

    The service name.

    		 myService

    Examples

    Sample success responses

    JSONformat

    {
  "requestId": "CE857A85-251D-5018-8103-A38957D71***",
  "code": "Ok",
  "message": "success",
  "data": {
    "totalSize": 25,
    "pageNumber": 1,
    "pageSize": 10,
    "items": [
      {
        "gatewayId": "gw-xxxx",
        "resourceType": "Plugin",
        "mcpServerConfig": {
          "routeId": "hr-cv0i5oum1hkhxxxxxxxx",
          "name": "mcp",
          "httpApiId": "api-d2vv43em201hxxxxxxxx"
        },
        "consumerConfig": {
          "consumerId": "cs-d0iltnem1hkhxxxxxxxx",
          "name": "myconsumer"
        },
        "PluginConfig": {
          "pluginId": "pl-d4ijk56m1hkhxxxxxxxx",
          "name": "oauth",
          "pluginClassId": "pls-xxxxxxxx"
        },
        "ServiceConfig": {
          "serviceId": "svc-cvgbtcmm1hkmxxxxxxxx",
          "name": "myService"
        }
      }
    ]
  }
}

    Error codes

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

    Change history

    Change time Summary of changes Operation
    2026-01-07 Add Operation View Change Details