Importing Metadata from OBS (1.0.0)

Function

This API is used to import metadata from OBS.

URI

POST /v1.0/{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** Parameters in the request header
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It is used to obtain the permission to call APIs. For details about how to obtain the token, see Authentication. The value of X-Subject-Token in the response header is the token.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
metadataPath	Yes	String	Path for storing the metadata
name	Yes	String	Metadata name
description	No	String	Metadata description
encryption	No	EncryptionReq object	Metadata encryption information.

**Table 4** EncryptionReq
Parameter	Mandatory	Type	Description
enable	No	Boolean	Whether to enable data encryption The value can be true or false. The default value is false. true: The metadata will be encrypted. false: The metadata will not be encrypted.
masterKeyId	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
errorMessage	String	System prompt. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error message.
errorCode	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.
id	String	Metadata ID
name	String	Metadata name

Example Request

POST https://Endpoint/v1.0/{project_id}/graphs/metadata/upload_from_obs
{
	"metadataPath": "devdata/unionsdk/schema.xml",
	"name": "test_schema",
	"description": "",
	"encryption": {}
}

Example Response

Example response with status code 200:

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

Status code: 404

Internal Server Error

{
	"errorCode": "GES.0016",
	"errorMessage": "Resource not found"
}

Status Code

Status Code	Description
200	Request sent.
400	Request error.
401	Authentication failed.
403	No operation permission.
404	No resources found.
500	Internal service error.
503	Service unavailable.