重置应用密钥 - ResetRomaAppSecret

功能介绍

重置应用密钥。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

PUT /v2/{project_id}/instances/{instance_id}/apps/{app_id}/secret

表1 路径参数
参数	是否必选	参数类型	描述
app_id	是	String	应用ID。
instance_id	是	String	实例ID。
project_id	是	String	项目ID，获取方式请参见API参考的“附录 > 获取项目ID”章节。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

表3 请求Body参数
参数	是否必选	参数类型	描述
secret	否	String	应用认证访问SECRET,未提供（字段不存在或值为null）时随机生成。字符集：英文字母、数字、！、@、#、$、%、+、=、点、中划线、斜线/。复杂度：满足大小写字母、数字、特殊字符的复杂度组合，考虑兼容性暂时不做复杂度校验。

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
id	String	应用ID。
secret	String	应用认证访问SECRET,未提供（字段不存在或值为null）时随机生成。字符集：英文字母、数字、！、@、#、$、%、+、=、点、中划线、斜线/。复杂度：满足大小写字母、数字、特殊字符的复杂度组合，考虑兼容性暂时不做复杂度校验。

状态码：403

表5 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误消息。
error_details	String	具体错误消息。
request_id	String	请求处理ID。

请求示例

重置集成应用的密钥为指定值。

{
  "secret" : "JNs1****Djd"
}

响应示例

状态码：200

{
  "id" : "b2e6b145-4f3f-4a80-aa45-f4b8029f95a3",
  "secret" : "JNs****Djd"
}

状态码：403

Forbidden

{
  "error_code" : "ROMA.00000101",
  "error_msg" : "error summary",
  "error_details" : "some error details here",
  "request_id" : "13760c1fe8655e61209b75665e9bef43"
}