{"base_path":"/","components":null,"consumes":"[\"application/json;charset=UTF-8\"]","definitions":{"BaseSignature":{"properties":{"name":{"description":"签名密钥的名称。支持汉字,英文,数字,下划线,且只能以英文和汉字开头。\n> 中文字符必须为UTF-8或者unicode编码。","example":"signature01","maxLength":64,"minLength":3,"pattern":"^([a-zA-Z]|[\\u4e00-\\u9fa5])([a-zA-Z0-9_]|[\\u4e00-\\u9fa5]){2,63}$","type":"string"},"sign_algorithm":{"description":"签名算法。默认值为空,仅aes类型签名密钥支持选择签名算法,其他类型签名密钥不支持签名算法。","enum":["aes-128-cfb","aes-256-cfb"],"example":"aes-128-cfb","type":"string"},"sign_key":{"description":"签名密钥的key。\n- hmac类型的签名密钥key:支持英文,数字,下划线,中划线,且只能以英文字母或数字开头,8 ~ 32字符。未填写时后台自动生成。\n- basic类型的签名密钥key:支持英文,数字,下划线,中划线,且只能以英文字母开头,4 ~ 32字符。未填写时后台自动生成。\n- public_key类型的签名密钥key:支持英文,数字,下划线,中划线,+,/,=,可以英文字母,数字,+,/开头,8 ~ 512字符。未填写时后台自动生成。\n- aes类型的签名密钥key:支持英文,数字,下划线,中划线,!,@,#,$,%,+,/,=,可以英文字母,数字,+,/开头,签名算法为aes-128-cfb时为16个字符,签名算法为aes-256-cfb时为32个字符。未填写时后台自动生成。","example":"abcd_123456789123456","type":"string"},"sign_secret":{"description":"签名密钥的密钥。\n- hmac类型的签名密钥key:支持英文,数字,下划线,中划线,!,@,#,$,%,且只能以英文字母或数字开头,16 ~ 64字符。未填写时后台自动生成。\n- basic类型的签名密钥key:支持英文,数字,下划线,中划线,!,@,#,$,%,且只能以英文字母或数字开头,8 ~ 64字符。未填写时后台自动生成。\n- public_key类型的签名密钥key:支持英文,数字,下划线,中划线,!,@,#,$,%,+,/,=,可以英文字母,数字,+,/开头,15 ~ 2048字符。未填写时后台自动生成。\n- aes类型签名密钥使用的向量:支持英文,数字,下划线,中划线,!,@,#,$,%,+,/,=,可以英文字母,数字,+,/开头,16个字符。未填写时后台自动生成。","example":"sig**********ret","type":"string"},"sign_type":{"description":"签名密钥类型:\n- hmac\n- basic\n- public_key\n- aes\n\nbasic和aes类型需要实例升级到对应版本,若不存在可联系技术工程师升级。\n\npublic_key类型开启实例配置public_key才可使用,实例特性配置详情请参考“附录 > 实例支持的APIC特性”,如确认实例不存在public_key配置可联系技术工程师开启。","enum":["hmac","basic","public_key","aes"],"example":"hmac","type":"string"}},"required":["name"]},"ResponseModel":{"properties":{"error_code":{"description":"错误码","type":"string"},"error_msg":{"description":"错误描述","type":"string"}},"required":["error_code","error_msg"]},"Signature":{"allOf":[{"$ref":"#/definitions/BaseSignature"},{"properties":{"create_time":{"description":"创建时间","format":"date-time","type":"string"},"id":{"description":"签名密钥的编号","type":"string"},"update_time":{"description":"更新时间","format":"date-time","type":"string"}},"type":"object"}]}},"description":null,"group_id":"025d125ee4da4956af037c3315e94b30","host":"roma.cn-north-4.myhuaweicloud.com","id":"0a16684994f544579e4208e3604972eb","info_version":"v2","method":"post","name":"CreateSignatureKeyV2","parameters":{"apic_instance_id":{"description":"实例ID","in":"path","name":"instance_id","required":true,"type":"string","x-example":"f0fa1789-3b76-433b-a787-9892951c620e"},"apic_project_id":{"description":"项目ID,获取方式请参见API参考的“附录 > 获取项目ID”章节。","in":"path","name":"project_id","required":true,"type":"string","x-example":"73d69ae0cfcf460190522d06b60f05ad"},"apic_x_auth_token":{"description":"用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","name":"X-Auth-Token","required":true,"type":"string","x-example":"MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..."}},"paths":{"/v2/{project_id}/apic/instances/{instance_id}/signs":{"post":{"description":"为了保护API的安全性,建议租户为API的访问提供一套保护机制,即租户开放的API,需要对请求来源进行认证,不符合认证的请求直接拒绝访问。\n\n其中,签名密钥就是API安全保护机制的一种。\n\n租户创建一个签名密钥,并将签名密钥与API进行绑定,则服务集成在请求这个API时,就会使用绑定的签名密钥对请求参数进行数据加密,生成签名。当租户的后端服务收到请求时,可以校验这个签名,如果签名校验不通过,则该请求不是服务集成发出的请求,租户可以拒绝这个请求,从而保证API的安全性,避免API被未知来源的请求攻击。","operationId":"CreateSignatureKeyV2","parameters":[{"$ref":"#/parameters/apic_x_auth_token"},{"$ref":"#/parameters/apic_project_id"},{"$ref":"#/parameters/apic_instance_id"},{"description":"创建签名密钥的请求体","in":"body","name":"CreateSignatureKeyV2RequestBody","required":true,"schema":{"$ref":"#/definitions/BaseSignature"}}],"responses":{"201":{"description":"Created","examples":{"application/json":{"create_time":"2020-08-03T03:39:38.119032659Z","id":"0b0e8f456b8742218af75f945307173c","name":"signature_demo","sign_key":"signkeysignkey","sign_secret":"sig**********ret","sign_type":"hmac","update_time":"2020-08-03T03:39:38.119032888Z"}},"schema":{"$ref":"#/definitions/Signature"}},"400":{"description":"Bad Request","examples":{"application/json":{"error_code":"APIG.2011","error_msg":"Invalid parameter value,parameterName:name. Please refer to the support documentation"}},"schema":{"$ref":"#/definitions/ResponseModel"}},"401":{"description":"Unauthorized","examples":{"application/json":{"error_code":"APIG.1002","error_msg":"Incorrect token or token resolution failed"}},"schema":{"$ref":"#/definitions/ResponseModel"}},"403":{"description":"Forbidden","examples":{"application/json":{"error_code":"APIG.1005","error_msg":"No permissions to request this method"}},"schema":{"$ref":"#/definitions/ResponseModel"}},"404":{"description":"Not Found","examples":{"application/json":{"error_code":"APIG.3030","error_msg":"The instance does not exist;id:f0fa1789-3b76-433b-a787-9892951c620ec"}},"schema":{"$ref":"#/definitions/ResponseModel"}},"500":{"description":"Internal Server Error","examples":{"application/json":{"error_code":"APIG.9999","error_msg":"System error"}},"schema":{"$ref":"#/definitions/ResponseModel"}}},"schemes":["https"],"summary":"创建签名密钥","tags":["签名密钥管理"],"x-api-version":"v2","x-apigateway-request-type":"public","x-hybridcloud":true,"x-is-registered":"Y","x-open-region-cloud":"hc,hcso","x-order":1,"x-request-examples-1":{"name":"signature_demo","sign_key":"signkeysignkey","sign_secret":"sig**********ret"},"x-request-examples-description-1":"创建一个签名密钥,签名密钥类型使用默认","x-romaconnect-mode":"huaweicloud,hybrid,on-premise","x-support-sdk":"Y"}}},"product_short":"ROMA","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"创建签名密钥","tags":"签名密钥管理","uri":null,"version":"2.0"}