返回结果

最近更新时间:2020-08-28 10:24:50

金山云证书管理服务的调用返回的数据格式支持xmljson两种,默认返回json格式,可通过设置HTTP Header Accept=application/json来改变返回数据格式。每次接口调用,无论成功与否,系统都会返回一个唯一识别码RequestId。

  • 返回2xxHTTP状态码表示调用成功。
  • 返回4xx5xxHTTP状态码表示调用失败。

调用成功

json格式示例

{
    "RequestId": "4C467B38-3910-447D-87BC-AC049166F216"
    /*返回结果数据*/
}

调用失败

调用接口失败,不会返回结果数据;返回的HTTP消息体中包含具体的错误代码(code)及错误信息(message);与调用成功一样还包含请求ID(RequestId),在调用方找不到错误原因时,可以联系金山云客服,并提供RequestId,以便我们尽快帮您解决问题。

xml格式示例

<?xml version="1.0" encoding="UTF-8"?>
<response>
<Error>
<Code>PermissionDenied</Code>
<InnerCode>permission_denied</InnerCode>
<Message>权限不足</Message>
</Error>
<RequestId>fd229f7c-e65f-1402-1d85-8cdff25c8b59</RequestId>
</response>

公共错误

错误代码(Code) 错误消息(Message) HTTP 状态码 中文描述(语义)
MissingAuthenticationToken Request is missing 'Host' header. 403 请求header中缺少Host
MissingAuthenticationToken Request is missing Authentication Token. 403 请求header中缺少认证token
MissingAuthenticationToken %s not in Http Header. 403 %s不在Http header中
SignatureDoesNotMatch Host' must be a 'SignedHeader' in the Authorization. 403 请求的SignedHeader中必须包含Host
SignatureDoesNotMatch Credential should be scoped with a valid terminator: 'aws4_request', not: %s. 403 请求Authorization header中的“Credential”末尾必须是“aws4_request”
SignatureDoesNotMatch Credential should be scoped to a valid region, not:%s. 403 请求Authorization header中的“Credential”中的Region信息无效
SignatureDoesNotMatch Credential should be scoped to correct service: %s. 403 请求Authorization header中的“Credential”中的Service信息无效
SignatureDoesNotMatch The request signature we calculated does not match the signature you provided. 403 请求中提供的签名与实际计算结果不匹配
SignatureDoesNotMatch Signature expired:%s. 403 签名已过期
SignatureDoesNotMatch Date in Credential scope does not match YYYYMMDD from ISO-8601 version of date from HTTP. 403 请求Authorization header中的“Credential”中的Date应该是ISO8601基本格式,形如”YYYYMMDD“
InvalidClientTokenId The security token included in the request is invalid. 403 请求中提供的AccessKeyId无效
AccessDenied User: %s is not authorized to perform: %s. 403 用户%s无权限操作该资源:%s
IncompleteSignature Date must be in ISO-8601 'basic format'. Got '%s'. See http://en.wikipedia.org/wiki/ISO_8601. 400 Date必须符合ISO_8601基本格式,参考:http://en.wikipedia.org/wiki/ISO_8601
IncompleteSignature KSC query-string parameters must include %s. Re-examine the query-string parameters. 400 查询条件中缺少签署信息,查询条件中必须包含”X-Amz-Algorithm“、”X-Amz-Credential“、”X-Amz-SignedHeaders“、”X-Amz-Date“信息
IncompleteSignature Unsupported ksc 'algorithm': %s. 400 只支持如下签名算法:AWS4-HMAC-SHA256
IncompleteSignature Authorization header requires 'Credential' parameter. Authorization=%s. 400 请求Authorization header中需要包含“Credential”参数
IncompleteSignature Credential must have exactly 5 slash-delimited elements, e.g. accesskeyid/date/region/service/aws4_request, got: %s. 400 请求Authorization header中中“Credential”至少包含5项以斜杠分隔的元素,如:keyid/date/region/service/aws4_request
IncompleteSignature Authorization header format error. 400 请求Authorization header的格式错误
IncompleteSignature Authorization header requires existence of either a 'X-Amz-Date' or a 'Date' header, Authorization=%s 400 请求中缺少“X-Amz-Date”或者“Date” header信息
IncompleteSignature Authorization header requires 'Signature' parameter. Authorization=%s 400 请求Authorization header中缺少“Signature”信息
IncompleteSignature Authorization header requires 'SignedHeaders' parameter. Authorization=%s 400 请求Authorization header中缺少“SignedHeaders”信息
ServiceUnavailable Exception %s 500 服务暂不可用
ServiceUnavailable Auth Service is unavailable because of an unknown error, exception or failure 500 验签或授权服务暂不可用
ServiceUnavailable Request was rejected because it referenced an 'InnerApi' that does not have an internal service 404 请求被拒绝,因其引用的InnerAPI无内部服务。
ServiceUnavailable OpenAPI or Service is unavailable because of an unknown error, exception or failure. 500 openAPI或服务暂不可用。
DryRunOperation Request would have succeeded, but DryRun flag is set 412 请求本可成功,但由于设置DryRun标记未成功
NoSuchEntity Request was rejected because it referenced an 'InnerApi' that does not exist. 404 请求被拒绝,因其引用的InnerAPI不存在
LimitExceeded Request was rejected because the request speed of this openAPI is beyond the current flow control limit. 409 请求被拒绝,因该openAPI接口访问速度已达到流控上限
InvalidParameterValue An invalid or out-of-range value was supplied for the input parameter %s. 400 输入参数%s的值无效、不合法或者超出范围
InvalidMethod The method %s for is not valid for this web service. 400 Method %s对当前web服务无效
MissingParameter An value must be supplied for the input parameter %s. 400 输入参数 %s的值不能为空
InvalidQueryParameter The query parameter %s is malformed or does not adhere to KSC standards. 400 查询参数 %s格式不对、不存在或者不符合金山云标准
ServiceTimeout Internal Service is unavailable because of time out. 500 内部服务由于超时暂不可用

业务错误

错误代码(Code) inner错误代码 错误消息(Message) HTTP 状态码 中文描述(语义)
InvalidParameterValue invalid_token token invalid 400 token值无效或已过期
InvalidParameterValue invalid_filter_name filter.N.name invalid 400 参数验证未通过
MissingParameter missing_parameter A required parameter is not supplied 400 必要参数缺失
NoSuchEntity order_not_exist The order info does not exist 404 订单信息不存在
NoSuchEntity domain_not_exist The domain does not exist 404 域名不存在
StatusError cert_status_error certificate status error 400 当前状态下的证书不允许执行该操作
StatusError cert_type_error cert type error 400 Symantec DV证书不可重新签发
StatusError trans_status_error transaction type error 400 只有创建、延期和升级操作可取消
StatusError https_status_error You tried to delete a https cert object that is in use 400 正在被使用的证书不能删除
StatusError cancel_conflict cancel conflict 400 取消的证书不能重复操作
ServiceUnavailable service_unavailable The request has failed due to a temporary failure of the server 500 后台服务异常,可能是请求过于频繁,请稍后重试
ServiceUnavailable revoke_fail revoke certificate fail due to a temporary failure of the server 500 后台服务异常,吊销证书失败
InvalidUser user_not_exist revoke certificate fail due to a temporary failure of the server 401 无效的用户或者用户不存在
InvalidSource ip_not_allow You have no right to do this action 403 没有执行此操作的权限
InvalidDomain not_on_record The domain name not put on record 400 域名未备案
ResourceLimit free_limit Maximum number of free certificates has been applied 400 申请的免费证书数量已达到上限
ResourceLimit extend_limit Free certificates can not extend 400 免费证书不能延期

金山云,开启您的云计算之旅

免费注册