主机安全客户端HOSTEYE

    通用说明

    API版本号

    参数 类型 参数位置 描述 是否必须
    version String URL参数 API版本号,当前版本为2。

    请求参数

    请求参数包括如下4种:

    参数类型 说明
    URI 通常用于指明操作实体,如:GET /v2/hosteye/loginmanage/overview
    Query参数 URL中携带的请求参数
    HEADER 通过HTTP头域传入,如:x-bce-date
    RequestBody 通过JSON格式组织的请求数据体

    返回值说明

    返回值分为两种形式:

    返回内容 说明
    HTTP STATUS CODE 如200,400,403,404等
    ResponseBody JSON格式组织的响应数据体

    签名认证

    本产品API会对每个访问的请求进行身份认证,以保障用户的安全。安全认证采用Access Key与请求签名机制。Access Key由Access Key ID和Secret Access Key组成,均为字符串,由百度云官方颁发给用户。其中Access Key ID用于标识用户身份,Access Key Secret 是用于加密签名字符串和服务器端验证签名字符串的密钥,必须严格保密。

    签名字符串格式

    bce-auth-v{version}/{accessKeyId}/{timestamp}/{expireTime}/{signedHeaders}/{signature}

    签名申请步骤

    关于AK/SK的获取,请参看获取AK/SK

    签名生成算法

    有关签名生成算法的具体介绍,请参看[鉴权认证机制]((Reference/鉴权认证机制/简介.md)。

    幂等性

    当调用创建接口时如果遇到了请求超时或服务器内部错误,用户可能会尝试重发请求,这时用户通过clientToken参数避免创建出比预期要多的资源,即保证请求的幂等性。

    幂等性基于clientToken,clientToken是一个长度不超过64位的ASCII字符串,通常放在query string里,如http://bss.bj.baidubce.com/open-api/v2/loginmanage/overview/getAttackSource&clientToken=be31b98c-5e41-4838-9830-9be700de5a20

    如果用户使用同一个clientToken值调用创建接口,则服务端会返回相同的请求结果。因此用户在遇到错误进行重试的时候,可以通过提供相同的clientToken值,来确保只创建一个资源;如果用户提供了一个已经使用过的clientToken,但其他请求参数(包括queryString和requestBody)不同甚至url Path不同,则会返回IdempotentParameterMismatch的错误代码。

    clientToken的有效期为24小时,以服务端最后一次收到该clientToken为准。也就是说,如果客户端不断发送同一个clientToken,那么该clientToken将长期有效。

    时间与日期

    日期与时间的表示有多种方式。为统一起见,除非是约定俗成或者有相应规范的,凡需要日期时间表示的地方一律采用UTC时间,遵循ISO 8601,并做以下约束:

    • 表示日期一律采用YYYY-MM-DD方式,例如2014-06-01表示2014年6月1日
    • 表示时间一律采用hh:mm:ss方式,并在最后加一个大写字母Z表示UTC时间。例如23:00:10Z表示UTC时间23点0分10秒。
    • 凡涉及日期和时间合并表示时,在两者中间加大写字母T,例如2014-06-01T23:00:10Z表示UTC时间2014年6月1日23点0分10秒。

    排版约定

    排版格式 含义
    < > 变量
    [] 可选项
    {} 必选项
    | 互斥关系
    等宽字体 Courier New 屏幕输出
    上一篇
    概述
    下一篇
    公共请求头和响应头