Updated on 2023-08-04 GMT+08:00

Importing Metadata from OBS (1.0.0)

Function

This API is used to import metadata from OBS.

URI

POST /v2/{project_id}/graphs/metadata/upload-from-obs

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Request Parameters

Table 2 Request header parameter

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. The token can be obtained by calling the IAM API. (The token is the value of X-Subject-Token in the response header.)

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

metadata_path

Yes

String

Path for storing the metadata

name

Yes

String

Metadata name

description

No

String

Metadata description

encryption

No

encryption object

Whether metadata is encrypted

Table 4 encryption

Parameter

Mandatory

Type

Description

enable

No

Boolean

Whether to enable data encryption

master_key_id

No

String

ID of the user master key created by the Data Encryption Workshop (DEW) on HUAWEI CLOUD in the project where the graph is created.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

id

String

Metadata ID

name

String

Metadata name

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

System prompt code.

  • If execution succeeds, this parameter may be left blank.
  • If execution fails, this parameter is used to display the error code.

error_msg

String

System prompt code.

  • If execution succeeds, this parameter may be left blank.
  • If execution fails, this parameter is used to display the error message.

Example Request

Import metadata from OBS. The metadata is stored in devdata/unionsdk/schema.xml and the metadata name is test_schema.

POST https://Endpoint/v2/{project_id}/graphs/metadata/upload-from-obs

{
  "metadata_path" : "devdata/unionsdk/schema.xml",
  "name" : "test_schema",
  "description" : "xx"
}

Example Response

Status code: 200

Example response for a successful request

{
  "id" : "d30d2e94-f2ee-4344-af49-eb27fd002eea",
  "name" : "test_schema"
}

Status code: 400

Example response for failed request

{
  "error_msg" : "test_schema The name already exists.",
  "error_code" : "GES.2067"
}

Status Code

Return Value

Description

400 Bad Request

Request error

401 Unauthorized

Authorization failed

403 Forbidden

No operation permissions

404 Not Found

No resources found

500 Internal Server Error

Internal server error

503 Service Unavailable

Service unavailable

Error Code

See Error Code.