Help Center/ DataArts Studio/ API Reference/ DataArts Security APIs/ Permission Management/ Querying the URL Information Configured in the Permission Set
Updated on 2025-11-17 GMT+08:00
View PDF

Querying the URL Information Configured in the Permission Set

Function

Query the URL information configured in the permission set, for example, the URL paths in components such as OBS and HDFS.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/security/permission-sets/datasource/urls

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Project ID and Account ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

cluster_id

No

String

Cluster ID. For details about how to obtain the cluster ID, see Querying Information About a Single Data Connection.

datasource_type

No

String

Data source type:

  • Hive data source

parent_permission_set_id

No

String

Parent permission set ID. For details about how to obtain the value, see Querying Information About a Single Data Connection.

Notes:

  • If the value is the ID of the parent privilege set, the query is based on the privilege in the parent privilege set.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

workspace

Yes

String

Workspace ID. For details about how to obtain the workspace ID, see Instance ID and Workspace ID.

X-Auth-Token

Yes

String

IAM token, which is obtained by calling the IAM API for obtaining a user token (value of X-Subject-Token in the response header). This parameter is mandatory for token authentication.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total

Integer

Specifies the total number of events.

urls

Array of UrlDTO objects

URL list.
Table 5 UrlDTO

Parameter

Type

Description

name

String

URL path name.

contains

Boolean

Indicates whether the parent permission set contains the permission. The options are true (yes), false (no), and null (not detected).

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

/v1/0833a5737480d53b2f25c010dc1a7b88/security/permission-sets/datasource/urls?cluster_id=dc425074-26b3-479c-9e2f-b103c0cdd90f&datasource_type=HIVE&parent_permission_set_id=78dea561c983c1157b4ef8c8c746f35f

{
  "cluster_id" : "dc425074-26b3-479c-9e2f-b103c0cdd90f",
  "datasource_type" : "HIVE",
  "parent_permission_set_id" : "78dea561c983c1157b4ef8c8c746f35f"
}

Example Responses

Status code: 200

OK

{
  "total" : 1,
  "urls" : [ {
    "contains" : true,
    "name" : "obs:/root/tmp/test"
  } ]
}

Status Codes

Status Code

Description

200

OK

400

Bad Request
Parent Topic: Permission Management