Help Center> Data Lake Insight> API Reference> Agency-related APIs> Creating a DLI Agency
View PDF

Creating a DLI Agency

Function

This API is used to create an agency for a DLI user.

Debugging

You can debug this API in API Explorer.

URI

  • URI format

    POST /v2/{project_id}/agency

  • 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.

Request

Table 2 Request parameters

Parameter

Mandatory

Type

Description

roles

Yes

Array of Strings

Role. Currently, only obs_adm, dis_adm, ctable_adm, vpc_netadm, smn_adm, and te_admin are supported.

Response

Table 3 Response parameters

Parameter

Mandatory

Type

Description

is_success

No

Boolean

Indicates 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

  • Example request 
    {
    "roles": [
        "ctable_adm",
        "vpc_netadm",
        "dis_adm",
        "smn_adm",
        "obs_adm"
    ]
}
  • Example response (successful request) 
    {
    "is_success": true,
    "message": ""
}

Status Codes

Table 4 describes status codes.

Table 4 Status codes

Status Code

Description

200

The job is created successfully.

400

Request failure.

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 Code.

Parent topic: Agency-related APIs