云观测开放API - 站点管理

注:“站点详情”、“修改站点信息”、“删除站点”三个API的请求都需要 带上GET查询参数 site_address 来标明目标站点。

注:POST/PUT请求体为JSON格式

1.1 站点列表

功能:获取 X-User-Id 用户名下的站点列表
请求URL:https://api.su.baidu.com/v1/ygc/site/
HTTP请求方式:GET
参数名称 参数类型 必选/可选 参数说明
per_page int 可选 每页的条数,默认为10
page int 可选 标明获取第几页,默认为0

返回字段

参数名称 参数类型 参数说明
request_id string 本次请求的唯一性ID,帮助排查问题
success boolean 本次请求的结果:

true => 成功

false => 失败

errors list 错误信息列表,如无错误则为空
messages list 信息列表,如无信息则为空
result.total_page int 总共分页的页数
result.data list 站点数据列表
result.data.[].site_id string 站点ID
result.data.[].alias_name string 站点别名
result.data.[].host_address string 站点地址(带http://或https://)
result.data.[].status string 站点状态,“NOT_FINISHED”、“ACTIVE”两种,在为站点添加任务之前,站点的状态为NOT_FINISHED
result.data.[].industry string 站点所属行业
result.data.[].hardware_level string 站点服务器的硬件优劣
result.data.[].use_cdn string 站点是否使用了CDN
result.data.[].host_ip_list string 站点在使用了CDN的情况下,源站IP是什么
result.data.[].cdn_provider string 为站点提供CDN服务的服务商
result.data.[].dns_provider string 为站点提供DNS服务的服务商
result.data.[].contacts list 站点相关的联系人列表
result.data.[].contacts.[].contact_id string 站点相关的联系人ID
result.data.[].contacts.[].name string 站点相关的联系人名字
result.data.[].contacts.[].email string 站点相关联系人的email
result.data.[].contacts.[].phone string 站点相关联系人的电话号码
result.data.[].score string 站点的总评分
result.data.[].indicators list 站点监测项数据列表
result.data.[].indicators.[].type string 站点监测项的类型
result.data.[].indicators.[].score string 站点监测项的评分
result.data.[].indicators.[].status string 站点监测项的状态
result.data.[].alert_type list 站点监测告警方式列表
result.data.[].created_time string 站点创建的时间点
result.data.[].updated_time string 站点最近一次更新的时间点

返回示例

{
    "request_id": "55963e33eedc4-181460786-3708",
    "success": true,
    "errors": [],
    "messages": [],
    "result": {
        "total_page": 10,
        "data": [
            {
                "site_id": "20824",
                "alias_name": "xxx",
                "site_address": "xxx",
                "status": "xxx",
                "industry": "PORTAL",
                "hardware_level": "middle",
                "use_cdn": "YES",
                "host_ip_list": "xxx, xxx",
                "cdn_provider": "xxx",
                "dns_provider": "xxx",
                "contacts": [
                    {
                        "contact_id": xxx,
                        "name": "xxx",
                        "email": "name@bd.com",
                        "phone": "18521385447"
                    },
                    ...
                ]
                "score": xxx,
                "indicators": [
                    {
                        "type": "xxx",
                        "score": "xxx",
                        "status": "xxx"
                    },
                ],
                "alert_type": ["email", "phone"],
                "created_time": "xxx",
                "updated_time": "xxx"
            },
            ...
        ]
    }
}

1.2 站点详情

功能:获取站点 site_address 的详细信息
请求URL:https://api.su.baidu.com/v1/ygc/site/
HTTP请求方式:GET
参数名称 参数类型 必选/可选 参数说明
site_address string 必选 待查询站点的地址

返回字段

参数名称 参数类型 参数说明
request_id string 本次请求的唯一性ID,帮助排查问题
success boolean 本次请求的结果:

true => 成功

false => 失败

errors list 错误信息列表,如无错误则为空
messages list 信息列表,如无信息则为空
result dict 站点信息
result.site_id string 站点ID
result.alias_name string 站点别名
result.host_address string 站点地址(带http://或https://)
result.status string 站点状态,“NOT_FINISHED”、“ACTIVE”两种,在为站点添加任务之前,站点的状态为NOT_FINISHED
result.industry string 站点所属行业
result.hardware_level string 站点服务器的硬件优劣
result.use_cdn string 站点是否使用了CDN
result.host_ip_list string 站点在使用了CDN的情况下,源站IP是什么
result.cdn_provider string 为站点提供CDN服务的服务商
result.dns_provider string 为站点提供DNS服务的服务商
result.data.[].contacts list 站点相关的联系人列表
result.contacts.[].contact_id string 站点相关的联系人ID
result.contacts.[].name string 站点相关的联系人名字
result.contacts.[].email string 站点相关联系人的email
result.contacts.[].phone string 站点相关联系人的电话号码
result.score string 站点的总评分
result.indicators list 站点监测项数据列表
result.indicators.[].type string 站点监测项的类型
result.indicators.[].score string 站点监测项的评分
result.indicators.[].status string 站点监测项的状态
result.alert_type list 站点监测告警方式列表
result.created_time string 站点创建的时间点
result.updated_time string 站点最近一次更新的时间点

返回示例

{
    "request_id": "55963e33eedc4-181460786-3708",
    "success": true,
    "errors": [],
    "messages": [],
    "result": {
        "site_id": "20824",
        "alias_name": "xxx",
        "site_address": "xxx",
        "status": "xxx",
        "industry": "PORTAL",
        "hardware_level": "middle",
        "use_cdn": "YES",
        "host_ip_list": "xxx, xxx",
        "cdn_provider": "xxx",
        "dns_provider": "xxx",
        "contacts": [
            {
                "contact_id": xxx,
                "name": "xxx",
                "email": "name@bd.com",
                "phone": "18521385447"
            },
            ...
        ]
        "score": xxx,
        "indicators": [
            {
                "type": "xxx",
                "score": "xxx",
                "status": "xxx"
            },
        ],
        "alert_type": ["email", "phone"],
        "created_time": "xxx",
        "updated_time": "xxx"
    }
}

1.3 添加站点

功能:添加一个新的待监测的站点
请求URL:https://api.su.baidu.com/v1/ygc/site/
HTTP请求方式:POST
参数名称 参数类型 必选/可选 参数说明
site_address string 必选 待添加站点的地址
alias_name string 可选 站点别名
industry string 必选 站点所属行业,对应关系:’PORTAL’=>’综合门户’,’MEDIAL’=>’影视音乐’,’SNS’=>’社交网络’,’TRAVEL’=>’旅游出行’,’ENT’=>’游戏娱乐’,’ART’=>’文学艺术’,’LIFE’=>’生活服务’,’EDU’=>’教育培训’,’HEALTH’=>’健康医疗’,’DIGITAL’=>’科技数码’,’COMMERCE’=>’商务服务’,’PROFESSIONAL’=>’行业网站’,’BLOG’=>’个人博客’,’OTHER’=>’其他行业’
hardware_level int 可选 站点服务器硬件配置级别(“low”, “middle”, “high”,默认为low),对应安全任务的检测速度低、中、高
use_cdn string 可选 站点是否使用了cdn,“YES”或“NO”,默认为NO
host_ip_list string 可选 对于使用CDN的站点,其源站IP,多个ip,则已逗号“,”分隔
use_cname(暂不支持) string 必选 对于使用CDN的站点,是否以CNAME的方式接入的
cname_list(暂不支持) string 可选 当use_cname为”YES”时,需要填写该字段,格式为逗号分隔的cname字符串列表
cdn_provider string 可选 CDN服务提供商,若未提供,则云观测会自动检测
dns_provider string 可选 DNS服务提供商,若未提供,则云观测会自动检测
alert_contacts string 可选 站点告警联系方式,格式为:用户1,邮箱,手机;用户2,邮箱,手机 (此字段不提供,则表示不告警)

返回字段

参数名称 参数类型 参数说明
request_id string 本次请求的唯一性ID,帮助排查问题
success boolean 本次请求的结果:

true => 成功

false => 失败

errors list 错误信息列表,如无错误则为空
messages list 信息列表,如无信息则为空
result.site_id string 新添加站点的ID
result.create_id string 站点创建的时间点

返回示例

{
    "request_id": "55963e33eedc4-181460786-3708",
    "success": true,
    "errors": [],
    "messages": [],
    "result": {
        "site_id": "20824",
        "created_time": "xxx"
    }
}

1.4 修改站点信息

功能:修改/更新已有监测站点的基本信息
请求URL:https://api.su.baidu.com/v1/ygc/site/
HTTP请求方式:PUT
参数名称 参数类型 必选/可选 参数说明
alias_name string 可选 站点别名
industry string 必选 站点所属行业,对应关系:’PORTAL’=>’综合门户’,’MEDIAL’=>’影视音乐’,’SNS’=>’社交网络’,’TRAVEL’=>’旅游出行’,’ENT’=>’游戏娱乐’,’ART’=>’文学艺术’,’LIFE’=>’生活服务’,’EDU’=>’教育培训’,’HEALTH’=>’健康医疗’,’DIGITAL’=>’科技数码’,’COMMERCE’=>’商务服务’,’PROFESSIONAL’=>’行业网站’,’BLOG’=>’个人博客’,’OTHER’=>’其他行业’
hardware_level int 可选 站点服务器硬件配置级别(“low”, “middle”, “high”,默认为low),对应安全任务的检测速度低、中、高
use_cdn string 可选 站点是否使用了cdn,“YES”或“NO”,默认为NO
host_ip_list string 可选 对于使用CDN的站点,其源站IP,多个ip,则已逗号“,”分隔
use_cname(暂不支持) string 必选 对于使用CDN的站点,是否以CNAME的方式接入的
cname_list(暂不支持) string 可选 当use_cname为”YES”时,需要填写该字段,格式为逗号分隔的cname字符串列表
cdn_provider string 可选 CDN服务提供商,若未提供,则云观测会自动检测
dns_provider string 可选 DNS服务提供商,若未提供,则云观测会自动检测

另外得带上GET查询参数site_address。

返回字段

参数名称 参数类型 参数说明
request_id string 本次请求的唯一性ID,帮助排查问题
success boolean 本次请求的结果:

true => 成功

false => 失败

errors list 错误信息列表,如无错误则为空
messages list 信息列表,如无信息则为空
result.site_id string 刚更新的站点ID
result.updated_time string 站点更新的时间点

返回示例

{
    "request_id": "55963e33eedc4-181460786-3708",
    "success": true,
    "errors": [],
    "messages": [],
    "result": {
        "site_id": "20824",
        "updated_time": "xxx"
    }
}

1.5 删除监测站点

功能:删除之前添加的监测站点
请求URL:https://api.su.baidu.com/v1/ygc/site/
HTTP请求方式:DELETE
参数名称 参数类型 必选/可选 参数说明

记得带上GET查询参数site_address。

返回字段

参数名称 参数类型 参数说明
request_id string 本次请求的唯一性ID,帮助排查问题
success boolean 本次请求的结果:

true => 成功

false => 失败

errors list 错误信息列表,如无错误则为空
messages list 信息列表,如无信息则为空
result.site_id string 刚删除的站点ID

返回示例

{
    "request_id": "55963e33eedc4-181460786-3708",
    "success": true,
    "errors": [],
    "messages": [],
    "result": {
        "site_id": "20824"
    }
}