您可以通过发送HTTP GET请求调用安骑士API,并按照接口说明在请求中加入相应的请求参数。调用接口后系统会返回处理结果。请求和返回结果都使用UTF-8字符集进行编码。 请求结构 安骑士的API是RPC风格,您可以通过发送HTTP GET请求调用安骑士API。 其请求结构如下:
https://Endpoint/?Action=xx&Parameters 其中: Endpoint:安骑士API的服务接入地址为aegis.cn-hangzhou.aliyuncs.com。 Action:要执行的操作,如使用DescribeAlarmEventList查询安全事件列表。 Version:要使用的API版本,安骑士的API版本是2016-11-11。 Parameters:请求参数,每个参数之间用“&”分隔。 请求参数由公共请求参数和API自定义参数组成。公共参数中包含API版本号、身份验证等信息,详细内容参见公共参数。 下面是一个调用DescribeAlarmEventList接口查询安全事件列表的示例:
说明 为了便于用户查看,本文档中的示例都做了格式化处理。
http(s)://aegis.cn-hangzhou.aliyuncs.com/?Action=DescribeAlarmEventList &Format=xml &Version=2016-11-11 &Signature=xxxx%xxxx%3D &SignatureMethod=HMAC-SHA1 &SignatureNonce=15215528852396 &SignatureVersion=1.0 &AccessKeyId=key-test &TimeStamp=2012-06-01T12:00:00Z ... API授权 为了确保您的账号安全,建议您使用子账号的身份凭证调用API。如果您使用RAM账号调用API,您需要为该RAM账号创建、附加相应的授权策略。 API签名 安骑士服务会对每个API请求进行身份验证,无论使用HTTP还是HTTPS协议提交请求,都需要在请求中包含签名(Signature)信息。 安骑士通过使用AccessKey ID和AccessKey Secret进行对称加密的方法来验证请求的发送者身份。AccessKey是为阿里云账号和RAM用户发布的一种身份凭证(类似于用户的登录密码),其中AccessKey ID用于标识访问者的身份,AccessKey Secret是用于加密签名字符串和服务器端验证签名字符串的密钥,必须严格保密。 RPC API需按如下格式在请求中增加签名(Signature):
https://endpoint/?SignatureVersion=1.0&SignatureMethod=HMAC-SHA1&Signature=CT9X0VtwR86fNWSnsc6v8YGOjuE%3D&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf 以DescribeAlarmEventList为例,假设AccessKey ID是testid, AccessKey Secret是testsecret,则签名前的请求URL如下:
https://aegis.cn-hangzhou.aliyuncs.com/?Action=DescribeAlarmEventList &TimeStamp=2016-02-23T12:46:24Z &Format=XML &AccessKeyId=testid &SignatureMethod=HMAC-SHA1 &SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf &Version=2016-11-11 &SignatureVersion=1.0 完成以下步骤计算签名: 使用请求参数创建待签名字符串:
GET&%2F&AccessKeyId%3Dtestid&Action%3DDescribeAlarmEventList&Format%3DXML&SignatureMethod%3DHMAC-SHA1&SignatureNonce%3D3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf&SignatureVersion%3D1.0&TimeStamp%3D2016-02-23T12%253A46%253A24Z&Version%3D2018-12-03 计算待签名的HMAC的值。 在AccessKey Secret后添加一个“&”作为计算HMAC值的key。本示例中的key为testsecret&。
CT9X0VtwR86fNWSnsc6v8YGOjuE= 将签名加到请求参数中:
https://aegis.cn-hangzhou.aliyuncs.com/?Action=DescribeAlarmEventList &TimeStamp=2016-02-23T12:46:24Z &Format=XML &AccessKeyId=testid &SignatureMethod=HMAC-SHA1 &SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf &Version=2016-11-11 &SignatureVersion=1.0 &Signature=CT9X0VtwR86fNWSnsc6v8YGOjuE%3D
说明 阿里云提供了多种语言的SDK及第三方SDK,可以免去您对签名算法进行编码的麻烦。更多阿里云SDK信息请参见阿里云开发工具包(SDK)。
版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。