欢迎来到天天文库
浏览记录
ID:35885447
大小:212.84 KB
页数:73页
时间:2019-04-22
《阿里云弹性伸缩-API参考-D》由会员上传分享,免费在线阅读,更多相关内容在行业资料-天天文库。
1、弹性伸缩API参考弹性伸缩/API参考API参考API使用须知在调用弹性伸缩OpenAPI之前,需要在阿里云官网先开通ESS,并在ESS控制台将用户的OpenAPI权限授权予弹性伸缩(ESS借助阿里云的RAM(ResourceAccessManagement服务),通过ECSOpenAPI代替用户弹性伸缩ECS实例资源)不符合条件,将抛以下异常:错误错误代码描述HTTP状态码用户未开通弹性伸缩,无权调用该APIForbidden.UnsubscribedDidn'thavepermissiontoaccessthisAPI.4
2、03用户并未向弹性伸缩完整授权OpenAPI接口Forbidden.UnauthorizedArequiredauthorizationforthespecifiedactionisnotsupplied.403调用方式对弹性伸缩API接口调用是通过向弹性伸缩API的服务端地址发送HTTPGET请求,并按照接口说明在请求中加入相应请求参数来完成的;根据请求的处理情况,系统会返回处理结果。请求结构服务地址ESSAPI的服务接入地址为:ess.aliyuncs.com通信协议支持通过HTTP或HTTPS通道进行请求通信。为了获得更
3、高的安全性,推荐您使用HTTPS通道发送请求。72弹性伸缩/API参考请求方法支持HTTPGET方法发送请求,这种方式下请求参数需要包含在请求的URL中。请求参数每个请求都需要指定要执行的操作,即Action参数(例如CreateScalingGroup),以及每个操作都需要包含的公共请求参数和指定操作所特有的请求参数。字符编码请求及返回结果都使用UTF-8字符集进行编码。公共参数公共请求参数公共请求参数是指每个接口都需要使用到的请求参数。名称类型是否必须描述FormatString否返回值的类型,支持JSON与XML。默认为
4、XMLVersionString是API版本号,为日期形式:YYYY-MM-DD,本版本对应为2014-08-28AccessKeyIdString是阿里云颁发给用户的访问服务所用的密钥IDSignatureString是签名结果串,关于签名的计算方法,请参见签名机制。SignatureMethodString是签名方式,目前支持HMAC-SHA1TimestampString是请求的时间戳。日期格式按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-72弹性伸缩/API参考DDThh:mm:ssZ。例如
5、2014-08-28T12:00:00Z(为北京时间2014年8月28日12点0分0秒)SignatureVersionString是签名算法版本,目前版本是1.0SignatureNonceString是唯一随机数,用于防止网络重放攻击。用户在不同请求间要使用不同的随机数值https://ess.aliyuncs.com/?Format=xml&Version=2014-08-28&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D&SignatureMethod=HMAC-SHA1&S
6、ignatureNonce=15215528852396&SignatureVersion=1.0&AccessKeyId=key-test&Timestamp=2014-08-28T12:00:00Z…XML示例:公共返回参数<接口名称+Response>4C467B38-3910-447D-87BC-AC049166F216接口名称
7、+Response>用户发送的每次接口调用请求,无论成功与否,系统都会返回一个唯一识别码RequestId给用户。XML示例:{"RequestId":"4C467B38-3910-447D-87BC-AC049166F216",/*返回结果数据*/}JSON示例72弹性伸缩/API参考返回结果成功结果调用API服务后返回数据采用统一格式,返回的HTTP状态码为2xx,代表调用成功;返回4xx或5xx的HTTP状态码代表调用失败。调用成功返回的数据格式主要有XML和JSON两种,外部系统可以在请求时传入参数来制定返回的数据格式
8、,默认为XML格式。本文档中的返回示例为了便于用户查看,做了格式化处理,实际返回结果是没有进行换行、缩进等处理的。<接口名称+Response>
此文档下载收益归作者所有