Help Center> RES> API Reference> APIs (Old Version)> Global Configuration-related APIs> Obtaining Global Configuration Metrics
View PDF

Obtaining Global Configuration Metrics

Function

This API is used to obtain global configuration metrics.

URI

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

Table 1 describes the URI parameters.
Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID, which is used for resource isolation. For details about how to obtain the project ID, see Obtaining a Project ID.

scene_id

Yes

String

Scenario ID.

Request

N/A

Response

Table 2 describes the response parameters.

Table 2 Response parameters

Parameter

Type

Description

is_success

boolean

Whether the request is successful

globals

object []

Global configuration information. For details, see Table 3.

error_code

String

Error code that indicates a request has failed. This parameter is unavailable when a request is successful.

error_msg

String

Error message that indicates a request has failed. This parameter is unavailable when a request is successful.
Table 3 globals parameters

Parameter

Type

Description

project_id

String

Project ID, which is used for resource isolation.

user_id

String

User ID, which is used to isolate users in the public cloud.

type

String

Metric type

parameter

String

Global configuration parameters

data_format

String

Data format. The options are csv and json. This parameter is mandatory for User Attribute Table, Item Attribute List, and User Operation Behavior Table.

data_param

JSON

This parameter is mandatory when data_format is set to csv and optional for other data formats.
Table 4 data_param parameters

Parameter

Mandatory

Type

Description

header

Yes

String

Whether to display the table header.

  • true: Yes
  • false: No

delimiter

Yes

String

Delimiter. The value can contain a maximum of 10 characters.

quote

Yes

String

Quotation character. The value can contain a maximum of 10 characters.

escape

Yes

String

Escape character. The value can contain a maximum of 10 characters.

Example

  • Example of a successful response 
    {
    "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": "<Path for storing the global configuration parameters>",
            "scene_id": "0"
        },
        {
            "project_id": "07f125793ba7497d887cb112dc917e87",
            "user_id": "b72b44e54fbc4b31adddf7c27a226b0e",
            "type": "GENERAL_FORMAT",
            "parameter": "<Path for storing the global configuration parameters>",
            "scene_id": "0"
        },
        {
            "project_id": "07f125793ba7497d887cb112dc917e87",
            "user_id": "b72b44e54fbc4b31adddf7c27a226b0e",
            "type": "USER_META",
            "parameter": "<Path for storing the global configuration parameters>",
            "data_format": "csv",
            "data_param": {
                "header": "false",
                "delimiter": ",",
                "quote": "\"",
                "escape": "\\"
            },
            "scene_id": "0"
        },
        {
            "project_id": "07f125793ba7497d887cb112dc917e87",
            "user_id": "b72b44e54fbc4b31adddf7c27a226b0e",
            "type": "ITEM_META",
            "parameter": "<Path for storing the global configuration parameters>",
            "data_format": "csv",
            "data_param": {
                "header": "false",
                "delimiter": ",",
                "quote": "\"",
                "escape": "\\"
            },
            "scene_id": "0"
        },
        {
            "project_id": "07f125793ba7497d887cb112dc917e87",
            "user_id": "b72b44e54fbc4b31adddf7c27a226b0e",
            "type": "USER_BEHAVIOR",
            "parameter": "<Path for storing the global configuration parameters>",
            "data_format": "csv",
            "data_param": {
                "header": "false",
                "delimiter": ",",
                "quote": "\"",
                "escape": "\\"
            },
            "scene_id": "0"
        }
    ]
}
  • Example of a failed response 
    {
    "is_success": false,
    "error_code": "res.2301",
    "error_msg": "Failed to resolve the token from the request."
}

Status Code

For details about status codes, see Status Codes.