ListSecretReferences - 列出密钥引用-API 网关(API Gateway)-阿里云帮助中心

列出密钥引用。

接口说明

接口支持创建多个服务。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

apig:ListSecretReferences

list

*Domain

acs:apig:{#regionId}:{#accountId}:secret/{#SecretId}

无

请求语法

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

路径参数

名称	类型	必填	描述	示例值
secretId	string	否	密钥 ID。	sec-d5e6shmm1hkoxxxxxxxx

请求参数

名称	类型	必填	描述	示例值
pageNumber	integer	否	分页页码。从 1 开始，不填默认 1。	1
pageSize	integer	否	分页大小。	10

返回参数

名称	类型	描述	示例值
	object	Schema of Response
requestId	string	Id of the request	CE857A85-251D-5018-8103-A38957D71***
code	string	响应状态码。	Ok
message	string	响应消息。	success
data	object	响应数据。
totalSize	integer	总数量。	25
pageNumber	integer	分页页码。	1
pageSize	integer	分页大小。	10
items	array<object>	引用详情列表。
	array<object>	引用详情。
gatewayId	string	网关实例 ID	gw-xxxx
resourceType	string	资源类型。	Plugin
mcpServerConfig	object	引用当前密钥的 MCP 服务信息。
routeId	string	路由 ID。	hr-cv0i5oum1hkhxxxxxxxx
name	string	路由名称。	mcp
httpApiId	string	HTTP API ID。	api-d2vv43em201hxxxxxxxx
consumerConfig	object	引用当前密钥的消费者信息。
consumerId	string	消费者 ID。	cs-d0iltnem1hkhxxxxxxxx
name	string	消费者名称。	myconsumer
PluginConfig	object	引用当前密钥的插件信息。
pluginId	string	插件 ID。	pl-d4ijk56m1hkhxxxxxxxx
name	string	插件名称。	oauth
pluginClassId	string	插件类型 id	pls-xxxxxxxx
ServiceConfig	object	引用当前密钥的服务信息。
serviceId	string	服务 ID。	svc-cvgbtcmm1hkmxxxxxxxx
name	string	服务名称。	myService

示例

正常返回示例

JSON格式

{
  "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"
        }
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。