Skip to content

Latest commit

 

History

History
72 lines (59 loc) · 1.96 KB

get_services.md

File metadata and controls

72 lines (59 loc) · 1.96 KB

功能描述

服务列表查询,支持根据指定的目录查询服务列表

请求参数

{{ common_args_desc }}

接口参数

字段 类型 必选 描述
catalog_id int 服务目录id,可在服务目录查询接口中data["id"]字段获取
service_type string 服务类型:change(变更),event(事件),request(请求),question(问题)
display_type string 可见范围类型:GENERAL(通用角色表),组织架构(ORGANIZATION),第三方系统(API)
display_role string 可见范围: display_type是ORGANIZATION时为角色ID,GENERAL/API时为系统唯一标识

请求参数示例

{
    "bk_app_secret": "xxxx",
    "bk_app_code": "xxxx",
    "bk_token": "xxxx",
    "catalog_id": 12,
    "service_type": "request",
    "display_type": "GENERAL",
    "display_role": "GENERAL_8"
}

返回结果示例

{
    "message": "success",
    "code": 0,
    "data": [
        {
            "id": 3,
            "name": "test1",
            "desc": "1",
            "service_type": "request"
        },
        {
            "id": 4,
            "name": "test2",
            "desc": "2",
            "service_type": "request"
        }
    ],
    "result": true
}

返回结果参数说明

字段 类型 描述
result bool 返回结果,true为成功,false为失败
code int 返回码,0表示成功,其他值表示失败
message string 错误信息
data array 返回数据

data

字段 类型 描述
id int 服务id
name string 服务名称
desc string 服务描述
service_type string 服务类型