修改签名密钥.md

修改签名密钥

功能介绍

修改指定签名密钥的详细信息。

调试

您可以在API Explorer中调试该接口。

URI

PUT /v2/{project_id}/apigw/instances/{instance_id}/signs/{sign_id}

表 1 路径参数

参数	是否必选	参数类型	描述
project_id	是	String	租户项目编号
instance_id	是	String	实例编号
sign_id	是	String	签名密钥编号

请求参数

表 2 请求Header参数

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

表 3 请求Body参数

参数	是否必选	参数类型	描述
sign_secret	否	String	签名密钥的密钥。支持英文，数字，下划线，中划线，!，@，#，$，%，且只能以英文字母开头，16 ~ 64字符。未填写时后台自动生成。
name	是	String	签名密钥的名称。支持汉字，英文，数字，下划线，且只能以英文和汉字开头，3 ~ 64字符。 说明： 中文字符必须为UTF-8或者unicode编码。
sign_key	否	String	签名密钥的key。支持英文，数字，下划线，中划线，且只能以英文字母开头，8 ~ 32字符。未填写时后台自动生成。
sign_type	否	String	签名密钥类型。 枚举值： hmac basic

响应参数

状态码： 201

表 4 响应Body参数

参数	参数类型	描述
sign_secret	String	签名密钥的密钥
update_time	String	更新时间
create_time	String	创建时间
name	String	签名密钥的名称
id	String	签名密钥的编号
sign_key	String	签名密钥的key
sign_type	String	签名密钥类型。 枚举值： hmac basic

状态码： 400

表 5 响应Body参数

参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误描述

状态码： 401

表 6 响应Body参数

参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误描述

状态码： 403

表 7 响应Body参数

参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误描述

状态码： 404

表 8 响应Body参数

参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误描述

状态码： 500

表 9 响应Body参数

参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误描述

请求示例

{
  "name" : "signature_demo"
}

响应示例

状态码： 201

OK

{
  "sign_secret" : "dc02fc5f30714d6bb21888389419e2b3",
  "update_time" : "2020-08-03T03:50:14.989785802Z",
  "create_time" : "2020-08-03T03:39:38Z",
  "name" : "signature_demo",
  "id" : "0b0e8f456b8742218af75f945307173c",
  "sign_key" : "a071a20d460a4f639a636c3d7e3d8163",
  "sign_type" : "hmac"
}

状态码： 400

Bad Request

{
  "error_code" : "APIG.2011",
  "error_msg" : "Invalid parameter value,parameterName:name. Please refer to the support documentation"
}

状态码： 401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

状态码： 403

Forbidden

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

状态码： 404

Not Found

{
  "error_code" : "APIG.3017",
  "error_msg" : "Signature key 0b0e8f456b8742218af75f945307173c does not exist"
}

状态码： 500

Internal Server Error

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

状态码

状态码	描述
201	OK
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
500	Internal Server Error

错误码

请参见错误码。