ResetAgenticApiKey - 重置数据网关 Access Token

更新时间:
复制 MD 格式

重置指定数据网关 Access Token:保留归属 Agent 与名称,仅重新生成明文 Access Token,旧 Access Token 立即失效;新明文 Access Token 仅在本次响应中一次性返回,请立即妥善保存。仅该 Access Token 的创建者本人可重置,且仅支持重置由控制台签发(source=console)的 Access Token。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

Id

integer

是

待重置的数据网关 Access Token 的 ID,与创建、查询接口返回的 Id 一致。仅该 Access Token 的创建者本人可重置,且目标 Access Token 不能处于已吊销状态。

1024

ExpireAfterSeconds

integer

否

自本次重置时刻起新 Access Token 的有效时长,单位为秒,取值范围 [1, 31536000](最长约 365 天)。不传时沿用该 Access Token 原有的过期时刻;当目标 Access Token 已过期时本参数必填,否则会因沿用已过去的过期时刻而签发出生即失效的 Access Token,请求将被拒绝。

2592000

返回参数

名称

类型

描述

示例值

object

Schema of Response

Data

object

重置成功后返回的 Access Token 信息,其中 Secret 为本次一次性返回的新明文 Secret。

AgentId

string

Access Token 所归属的 Agent 的 ID。

agent-7f3c9a2b

AgentName

string

Access Token 所归属的 Agent 的名称。

my-data-agent

AgentType

string

Access Token 所归属 Agent 的类型,取值包括 HUMAN_BOUND(完整继承关联用户权限)、PERMISSION_NARROW(在关联用户权限基线上收窄)、AGENT_BOUND(继承父 Agent 权限)、STANDALONE(作为独立身份主体持有权限)。

STANDALONE

CreatedAt

string

Access Token 的创建时间,格式为 yyyy-MM-dd HH:mm:ss(东八区),重置前后保持不变。

2026-05-13 08:00:00

CreatorId

string

Access Token 创建者的用户 ID。

27400000000000001

CreatorName

string

Access Token 创建者的显示名称。

alice

Description

string

Access Token 的描述信息,重置前后保持不变。

Access token used by the data analysis agent

ExpireTime

string

Access Token 的过期时间,格式为 yyyy-MM-dd HH:mm:ss(东八区)。传入 ExpireAfterSeconds 时以重置时刻重新计算;不传时沿用原过期时间。

2027-05-13 10:20:30

Id

integer

被重置的 Access Token 的 ID,重置前后保持不变。

1024

IsRevoked

boolean

Access Token 是否已被吊销。重置成功返回的 Access Token 一定为未吊销状态(false)。

KeyPrefix

string

Access Token 的可见前缀,用于在不暴露完整 Secret 的前提下识别该 Access Token,重置前后保持不变。

dms_sk_3f9a

LastUsedTime

string

Access Token 最近一次被使用的时间,格式为 yyyy-MM-dd HH:mm:ss(东八区);从未使用时为空。

2026-05-13 09:15:00

Name

string

Access Token 的名称,重置前后保持不变。

prod-readonly-key

Secret

string

本次重置生成的新明文 Secret,仅在本次响应中一次性返回,后续任何接口都不会再次返回,请立即妥善保存。旧 Secret 在重置后立即失效。

dms_sk_3f9a1c8e5b7d4062a1f6c9e2b8d05a3f

Source

string

Access Token 的凭证来源。重置接口仅支持控制台签发的 Access Token,因此固定返回 console。

console

Warning

string

与本次重置相关的提醒信息,例如提示新 Secret 仅一次性返回、须立即保存;无提醒时为空。

The new secret is shown only once. Please store it securely now.

ErrorCode

string

请求失败时返回的错误码,用于程序判断失败类型;请求成功时为空。

ACCESS_TOKEN_NOT_FOUND

ErrorMessage

string

请求失败时返回的错误描述信息,便于人工定位问题;请求成功时为空。

access token not found: 1024

RequestId

string

本次请求的唯一标识,用于问题排查与日志关联。

1AD222E9-E606-4A42-BF6C-2C4DD51BD5E7

Success

boolean

本次请求是否成功。true 表示重置成功,false 表示失败,此时可结合 ErrorCode 与 ErrorMessage 定位原因。

示例

正常返回示例

JSON格式

{
  "Data": {
    "AgentId": "agent-7f3c9a2b",
    "AgentName": "my-data-agent",
    "AgentType": "STANDALONE",
    "CreatedAt": "2026-05-13 08:00:00",
    "CreatorId": "27400000000000001",
    "CreatorName": "alice",
    "Description": "Access token used by the data analysis agent",
    "ExpireTime": "2027-05-13 10:20:30",
    "Id": 1024,
    "IsRevoked": true,
    "KeyPrefix": "dms_sk_3f9a",
    "LastUsedTime": "2026-05-13 09:15:00",
    "Name": "prod-readonly-key",
    "Secret": "dms_sk_3f9a1c8e5b7d4062a1f6c9e2b8d05a3f",
    "Source": "console",
    "Warning": "The new secret is shown only once. Please store it securely now."
  },
  "ErrorCode": "ACCESS_TOKEN_NOT_FOUND",
  "ErrorMessage": "access token not found: 1024",
  "RequestId": "1AD222E9-E606-4A42-BF6C-2C4DD51BD5E7",
  "Success": true
}

错误码

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

变更历史

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