API 概览

此接口可以通过已知资源ID查询包括主机退订/删除时间等有关实例的简单描述。

调用方式

请求结构

客户调用金山云实例描述的OpenAPI接口是通过向指定服务地址发送请求，并按照OpenAPI文档说明在请求中添加相应的公共参数和接口参数来完成的。

服务地址

实例描述接入地址为：trade.api.ksyun.com
通信协议

支持通过 HTTP 或 HTTPS 两种方式进行请求通信，推荐使用安全性更高的 HTTPS方式发送请求。
请求方法 POST
请求参数

金山云OpenAPI请求包含两类参数：公共请求参数和接口请求参数。其中，公共请求参数是每个接口都要用到的请求参数，具体可参见公共参数小节；接口请求参数是各个接口所特有的，具体见各个接口的“请求参数”描述。

构建公共参数时会用到如下参数： Service 传固定值 trade, Region 传固定值 cn-beijing-6
字符编码

请求及返回结果都使用UTF-8字符集进行编码。

公共参数

参数说明 公共请求参数是每个接口都需要使用到的请求参数。

名称	类型	是否必须参数	长度限制(字符)	参数格式	描述
Action	String	是	不确定	`[a-zA-Z]+`	操作接口名，与调用的具体openAPI相关
Version	String	是	10字符	`V1`	接口版本号，版本号不同接口支持的参数和返回值可能不同，账单服务接口当前只支持一个版本，即`V1`
X-Amz-Algorithm	String	是	16字符	`AWS4-HMAC-SHA256`	签名算法，目前只支持一种，即HMAC-SHA256
X-Amz-Credential	String	是	不确定	`AccessKeyId/YYYYMMDD/region/service/AWS4_request`	信任状信息，包括访问密钥ID，日期，region名称和服务名称以及结尾字符串`AWS4_request`
X-Amz-Date	String	否（用于覆盖信任状或者date header中的日期）	16字符	ISO 8601 基本格式 `YYYYMMDD'T'HHMMSS'Z'`，如20151101T120000Z	签名日期
X-Amz-Signature	String	是	64字符	16进制编码表示	请求签名值
X-Amz-SignedHeaders	String	是	不确定	`[a-zA-Z0-9-;]+`	需要在签名计算中包含的请求header

返回结果

调用金山云的openAPI服务，调用成功，返回的HTTP状态码（Status）为200；调用失败，返回4xx 或5xx的HTTP状态码（Status）。

返回的数据格式支持xml和json两种，可通过设置HTTP Header Accept=application/json来设置返回数据格式。

调用成功

json格式示例

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

调用失败

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

json格式示例

{    
    "RequestId": "68093a99-2f63-4f39-8f70-3047ab8ecb5b",
    "Error": {
        "Code": "InvalidParameterValue",
        "Message": "An invalid or out-of-range value was supplied for the input parameter PathPrefix."    
    }
}

公共错误

错误代码(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的值无效、不合法或者超出范围

密钥

客户调用金山云的OpenAPI接口，需要对应的AccessKey和SecretKey

用户登录控制台，在左侧导航栏选择身份与管理，进入设置—AK密匙管理页面，选择新建密钥或使用已存在的密钥。请妥善管理自己的密钥信息，避免泄露

名称	类型	描述
customerId	String	客户ID
availableAmount	String	可用金额
rewardAmount	String	赠送金额
frozenAmount	String	冻结金额
currency	String	币种取值范围：CNY：人民币，USD：美元

文档中心

账户资产

计费方式

费用账单

卡券管理

商品试用

账户余额OpenAPI

调用方式

相关接口

数据类型

实例描述OpenAPI

账单OpenAPI

实时付费账单OpenAPI

调用方式

相关接口

数据类型

后付费账单OpenAPI

调用方式

相关接口

数据类型

常见问题

CashWalletDetail

CashWalletDetail

描述

内容

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