Listing Resources

Function

This API is used to list resources. During the query, you can specify the page number and the maximum number of records on each page.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

URI format
GET /v1/{project_id}/resources

Parameter description

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain a project ID, see Project ID and Account ID.

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	The maximum number of records on each page. The value ranges from 1 to 100. Default value: 10
offset	No	Integer	Start page of the paging list. Default value: 0 The value must be greater than or equal to 0.
resourceName	No	String	Name of the resource.

Request Parameters

**Table 3** Request header parameter
Parameter	Mandatory	Type	Description
workspace	No	String	Workspace ID. For details about how to obtain it, see Instance ID and Workspace ID. If this parameter is not set, data in the default workspace is queried by default. To query data in other workspaces, this header must be carried. NOTE: You need to specify a workspace for multiple DataArts Studio instances. This parameter is mandatory if no default workspace is available. If you do not set it, an error is reported.

Response Parameters

**Table 4** Parameter description
Parameter	Mandatory	Type	Description
total	Yes	Integer	The total number of resources.
resources	Yes	List<Resource>	A list of resources.

**Table 5** Resource parameters
Parameter	Mandatory	Type	Description
id	Yes	String	ID of the resource. The resource ID is used to query the resource.
name	Yes	String	Resource name. The value can contain up to 32 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.
type	Yes	String	Resource type. archive file jar
location	Yes	String	OBS path for storing the resource file. When type is set to jar, location is the path for storing the main JAR package. The path contains a maximum of 256 characters. For example, obs://myBucket/test.jar
dependFiles	No	List<String>	JAR package and properties file that the main JAR package depends on. The description contains a maximum of 10,240 characters.
desc	No	String	Description. The value can contain up to 255 characters.
directory	No	String	Directory for storing the resource. Log in to the DataArts Studio console and access the DataArts Factory console. In the navigation pane, choose Configuration > Configure. In the resource directory tree, you can view the created directories. The default directory is the root directory.

Example Request

Query a list of resources.

GET /v1/b384b9e9ab9b4ee8994c8633aabc9505/resources

Example Response

Success response

HTTP status code 200

{
    "total":1,
    "resources":[
        {
            "id":"b384b9e9ab9b4ee8994c8633aabc9505",
            "name":"test",
            "type":"jar",
            "location":"obs://00000000dlf-test/hadoop-mapreduce-examples-2.4.1.jar",
            "dependFiles":[
                "obs://00000000dlf-test/depend1.jar",
                "obs://00000000dlf-test/depend2.jar"
            ],
            "desc":"test",
            "directory":"/resource"
        }
    ]
}

Failure response

HTTP status code 400

{
    "error_code":"DLF.3051",
    "error_msg":"The request parameter is invalid."
}

Parent Topic: Resource Management APIs

Previous topic: Deleting a Resource

Next topic: Job Development APIs

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot