Querying an Image

You can use the API to check whether an image exists in the image library with the image path.

POST /v1/{project_id}/{instance_name}/image/check

**Table 1** Path parameters
Name	Mandatory	Type	Description
instance_name	Yes	String	Instance name
project_id	Yes	String	Project ID. See Obtaining a Project ID and Name.

**Table 2** Request header parameters
Name	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token 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
Name	Mandatory	Type	Description
path	No	String	Image URL, which is used as the ID of an image in the image library

Status code: 200

**Table 4** Response body parameter
Name	Type	Description
exist	String	Calling result when the API call succeeds. This parameter is not included when the API fails to be called. The value can be true or false. The default value is false. true: the queried image exists in the image library. false: the queried image does not exist in the image library.

Status code: 400

**Table 5** Response body parameter
Name	Type	Description
error_code	String	Error code of a failed API call. For details, see Error Codes. This parameter is not included when the API is successfully called.
error_msg	String	Error message when the API call fails. This parameter is not included when the API is successfully called.

Query an image in the index library based on the image path (https://bucketName.obs.myhuaweicloud.com/image/test1.jpg).

POST https://{endpoint}/v1/{project_id}/{instance_name}/image/check

{
  "path" : "https://bucketName.obs.myhuaweicloud.com/image/test1.jpg"
}

Status code: 200

Example of a successful response

{
  "exist" : "true"
}

Status code: 400

Example of a failed response

{
  "error_code" : "IS.0003",
  "error_msg" : "Arguments of path can not be null."
}

Status Code	Description
200	Successful response
400	Failed response

For details, see Error Codes.

Parent topic: APIs

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.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

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