Help Center/ FunctionGraph/ API Reference/ APIs/ Dependencies/ Querying Dependencies

Updated on 2024-11-07 GMT+08:00

View PDF

Querying Dependencies

Function

This API is used to query all dependencies.

URI

GET /v2/{project_id}/fgs/dependencies

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details, see Obtaining a Project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
marker	No	String	Final record queried last time. Default value: 0.
maxitems	No	String	Maximum number of items to return in a request.
ispublic	No	String	Whether a dependency is public.
dependency_type	No	String	Dependency type. Options: public, private, and all. Default value: all.
runtime	No	String	Environment in which a FunctionGraph function is executed. Options: Python 2.7 Python 3.6 Python 3.9 Python 3.10 Go 1.x Java 8 Java 11 Node.js 6.10 Node.js 8.10 Node.js 10.16 Node.js 12.13 Node.js 14.18 Node.js16.17 Node.js18.15 C# (.NET Core 2.1) C# (.NET Core 3.1) Custom PHP 7.3 HTTP Custom Image Cangjie1.0
name	No	String	Dependence name.
limit	No	String	Maximum number of dependencies that can be obtained in a query. Default value: 400.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
Content-Type	Yes	String	Message body type (format).

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
dependencies	Array of ListDependenciesResult objects	Dependency list.
next_marker	Long	Next read location.
count	Long	Total number of dependencies.

**Table 5** ListDependenciesResult
Parameter	Type	Description
id	String	Dependency ID.
owner	String	Dependency owner. public indicates a public dependency.
link	String	URL of the dependency in the OBS console.
runtime	String	Environment for executing a function. Options: Python2.7 Python 3.6 Python 3.9 Python 3.10 Go 1.x Java 8 Java 11 Node.js 6.10 Node.js 8.10 Node.js 10.16 Node.js 12.13 Node.js 14.18 Node.js 16.17 Node.js 18.15 C# (.NET Core 2.1) C# (.NET Core 3.1) Custom PHP 7.3 HTTP Custom image-based functions Cangjie1.0 Enumeration values: Java8 Java11 Node.js6.10 Node.js8.10 Node.js10.16 Node.js12.13 Node.js14.18 Node.js16.17 Node.js18.15 Python2.7 Python3.6 Python3.10 Go1.x C#(.NET Core 2.1) C#(.NET Core 3.1) Custom PHP7.3 Python3.9 http Custom Image Cangjie1.0
etag	String	Dependency ID.
size	Long	Dependency size.
name	String	Dependency name.
file_name	String	Dependency file name.
description	String	Dependency description.
version	Long	Dependence version.
last_modified	Long	Time when the dependency was last updated.

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 403

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 404

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

Dependencies of the current tenant.

GET https://{Endpoint}/v2/{project_id}/fgs/ListDependencies?marker=0&maxitems=400

Example Responses

Status code: 200

{
  "dependencies" : [ {
    "id" : "6578de50-9a18-48fa-b84e-b2d36636e433",
    "owner" : "public",
    "link" : "https://{obs_endpoint}/functionstage-examples/fg_test_pandas_1.1.3.zip",
    "runtime" : "Python3.6",
    "etag" : "35a893d9495b3e22259b2773996bc94d-6",
    "size" : 31009808,
    "name" : "panda1.1.3"
  } ],
  "next_marker" : 43,
  "count" : 43
}