文档首页 > > API参考> API(V1不推荐)> 全局配置API>

获取全局配置指标

获取全局配置指标

分享
更新时间:2020/12/17 GMT+08:00

功能介绍

该接口用于获取全局配置指标。

URI

GET /v1/{project_id}/global-setting?scene-id={scene_id}

参数说明请参见表1-URI参数说明
表1 URI参数说明

名称

是否必选

类型

说明

project_id

String

项目编号,用于资源隔离。获取方法请参见获取项目ID

scene_id

String

场景ID。

请求消息

请求参数暂不涉及。

响应消息

响应参数请参见表2

表2 响应参数说明

参数名称

参数类型

说明

is_success

boolean

请求是否成功。

globals

object []

请参见表3,全局配置信息。

error_code

String

请求失败时的错误码,请求成功时无此字段。

error_msg

String

请求失败时的错误信息,请求成功时无此字段。

表3 globals参数说明

参数名称

参数类型

说明

project_id

String

项目编号,用于资源隔离。

user_id

String

来自公有云的User ID,用于用户隔离。

type

String

指标类型。

parameter

String

全局配置参数配置。

data_format

String

数据格式,用户属性表、物品属性表,用户操作行为表必填,值可以为“csv”“json”

data_param

JSON

data_format为csv时必填,其他可选。

表4 data_param参数说明

参数名称

是否必选

参数类型

说明

header

String

是否显示表头。

  • true:有表头
  • false:无表头

delimiter

String

分隔符,最大长度10字符。

quote

String

引用字符,最大长度10字符。

escape

String

转义字符,最大长度10字符。

示例

  • 成功响应示例
    {
        "is_success": true,
        "globals": [
           {
                "project_id": "07f125793ba7497d887cb112dc917e87",
                "user_id": "b72b44e54fbc4b31adddf7c27a226b0e",
                "type": "config_load_path",
                "parameter": "",
                "scene_id": "0"
            },
            {
                "project_id": "07f125793ba7497d887cb112dc917e87",
                "user_id": "b72b44e54fbc4b31adddf7c27a226b0e",
                "type": "global_features_information_path",
                "parameter": "<全局配置参数存储路径>",
                "scene_id": "0"
            },
            {
                "project_id": "07f125793ba7497d887cb112dc917e87",
                "user_id": "b72b44e54fbc4b31adddf7c27a226b0e",
                "type": "GENERAL_FORMAT",
                "parameter": "<全局配置参数存储路径>",
                "scene_id": "0"
            },
            {
                "project_id": "07f125793ba7497d887cb112dc917e87",
                "user_id": "b72b44e54fbc4b31adddf7c27a226b0e",
                "type": "USER_META",
                "parameter": "<全局配置参数存储路径>",
                "data_format": "csv",
                "data_param": {
                    "header": "false",
                    "delimiter": ",",
                    "quote": "\"",
                    "escape": "\\"
                },
                "scene_id": "0"
            },
            {
                "project_id": "07f125793ba7497d887cb112dc917e87",
                "user_id": "b72b44e54fbc4b31adddf7c27a226b0e",
                "type": "ITEM_META",
                "parameter": "<全局配置参数存储路径>",
                "data_format": "csv",
                "data_param": {
                    "header": "false",
                    "delimiter": ",",
                    "quote": "\"",
                    "escape": "\\"
                },
                "scene_id": "0"
            },
            {
                "project_id": "07f125793ba7497d887cb112dc917e87",
                "user_id": "b72b44e54fbc4b31adddf7c27a226b0e",
                "type": "USER_BEHAVIOR",
                "parameter": "<全局配置参数存储路径>",
                "data_format": "csv",
                "data_param": {
                    "header": "false",
                    "delimiter": ",",
                    "quote": "\"",
                    "escape": "\\"
                },
                "scene_id": "0"
            }
        ]
    }
  • 失败响应示例
    {
        "is_success": false,
        "error_code": "res.2301",
        "error_msg": "Failed to resolve the token from the request."
    }

状态码

状态码请参见状态码

分享:

    相关文档

    相关产品