Updated on 2023-07-31 GMT+08:00

Deleting a Global Variable

Function

This API is used to delete a global variable.

Only the user who creates a global variable can delete the variable.

URI

  • URI format

    DELETE /v1.0/{project_id}/variables/{var_name}

  • Parameter description
    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 its value, see Obtaining a Project ID.

    var_name

    Yes

    String

    A global variable name can contain a maximum of 128 characters, including only digits, letters, and underscores (_), but cannot start with an underscore (_) or contain only digits.

Request

None

Response

  • Parameter description
    Table 2 Response parameters

    Parameter

    Mandatory

    Type

    Description

    is_success

    No

    Boolean

    Whether the request is successfully executed. Value true indicates that the request is successfully executed.

    message

    No

    String

    System prompt. If execution succeeds, the parameter setting may be left blank.

Example Request

None

Example Response

{
    "is_success": true,
    "message": "string"
}

Status Codes

Table 3 describes status codes.

Table 3 Status codes

Status Code

Description

200

A variable is deleted successfully.

400

The input parameter is invalid.

Error Codes

If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Codes.

Table 4 Error codes

Error Code

Error Message

DLI.0001

Parameter check errors occur.

DLI.0999

Server-side errors occur.