tencent cloud

Cloud Object Storage

Release Notes and Announcements
Release Notes
Announcements
Product Introduction
Overview
Features
Use Cases
Strengths
Concepts
Regions and Access Endpoints
Specifications and Limits
Service Regions and Service Providers
Billing
Billing Overview
Billing Method
Billable Items
Free Tier
Billing Examples
Viewing and Downloading Bill
Payment Overdue
FAQs
Getting Started
Console
Getting Started with COSBrowser
User Guide
Creating Request
Bucket
Object
Data Management
Batch Operation
Global Acceleration
Monitoring and Alarms
Operations Center
Data Processing
Content Moderation
Smart Toolbox
Data Processing Workflow
Application Integration
User Tools
Tool Overview
Installation and Configuration of Environment
COSBrowser
COSCLI (Beta)
COSCMD
COS Migration
FTP Server
Hadoop
COSDistCp
HDFS TO COS
GooseFS-Lite
Online Tools
Diagnostic Tool
Use Cases
Overview
Access Control and Permission Management
Performance Optimization
Accessing COS with AWS S3 SDK
Data Disaster Recovery and Backup
Domain Name Management Practice
Image Processing
Audio/Video Practices
Workflow
Direct Data Upload
Content Moderation
Data Security
Data Verification
Big Data Practice
COS Cost Optimization Solutions
Using COS in the Third-party Applications
Migration Guide
Migrating Local Data to COS
Migrating Data from Third-Party Cloud Storage Service to COS
Migrating Data from URL to COS
Migrating Data Within COS
Migrating Data Between HDFS and COS
Data Lake Storage
Cloud Native Datalake Storage
Metadata Accelerator
GooseFS
Data Processing
Data Processing Overview
Image Processing
Media Processing
Content Moderation
File Processing Service
File Preview
Troubleshooting
Obtaining RequestId
Slow Upload over Public Network
403 Error for COS Access
Resource Access Error
POST Object Common Exceptions
API Documentation
Introduction
Common Request Headers
Common Response Headers
Error Codes
Request Signature
Action List
Service APIs
Bucket APIs
Object APIs
Batch Operation APIs
Data Processing APIs
Job and Workflow
Content Moderation APIs
Cloud Antivirus API
SDK Documentation
SDK Overview
Preparations
Android SDK
C SDK
C++ SDK
.NET(C#) SDK
Flutter SDK
Go SDK
iOS SDK
Java SDK
JavaScript SDK
Node.js SDK
PHP SDK
Python SDK
React Native SDK
Mini Program SDK
Error Codes
Harmony SDK
Endpoint SDK Quality Optimization
Security and Compliance
Data Disaster Recovery
Data Security
Cloud Access Management
FAQs
Popular Questions
General
Billing
Domain Name Compliance Issues
Bucket Configuration
Domain Names and CDN
Object Operations
Logging and Monitoring
Permission Management
Data Processing
Data Security
Pre-signed URL Issues
SDKs
Tools
APIs
Agreements
Service Level Agreement
Privacy Policy
Data Processing And Security Agreement
Contact Us
Glossary

HEAD Object

PDF
Mode fokus
Ukuran font
Terakhir diperbarui: 2025-12-22 17:28:14

Introduction

This document describes the sample code and description for querying object metadata via the Node.js SDK in COS.

Notes

If you want to query the metadata of the target object, you need to have read permission for the target object: when you configure the authorization policy, the action needs to be set to cos:HeadObject. For more authorization, see business interfaces supporting CAM.

Feature Overview

Query the metadata information of an object.

Preliminary Preparation

Before starting to use, ensure that you have completed SDK initialization.

Use Case

cos.headObject({
Bucket: 'examplebucket-1250000000', // Fill in your own bucket; mandatory field.
Region: 'COS_REGION', // Bucket region, for example ap-beijing; mandatory field.
Key: '1.jpg', // object key stored in the bucket (for example, 1.jpg, a/b/test.txt); mandatory field.
}, function(err, data) {
console.log(err || data);
});

Parameter Description

Parameter Name
Parameter Description
Type
Required
Bucket
The name of the bucket, in the format of BucketName-APPID; the bucket name filled in here must be in this format.
String
Yes
Region
Bucket region; for enumerated values, see Regions and Access Domains
String
Yes
Key
Object key (name of the Object), which uniquely identifies the object in the bucket. For details, see Object Overview
String
Yes
IfModifiedSince
If the object has been modified after the specified time, the metadata information of the corresponding object is returned; otherwise, 304 is returned.
String
No

Description of the callback function

function(err, data) { ... }
Parameter Name
Parameter Description
Type
err
The object returned when an error occurs in the request, including network errors and business errors. It is null if the request is successful. For more details, see Error Codes.
Object
- statusCode
HTTP status code returned by the request, such as 200, 403, 404.
Number
- headers
Header returned by the request
Object
data
The object returned when the request is successful, or null if an error occurs in the request.
Object
- ETag
The unique identifier of the returned file. For files uploaded via simple upload, the ETag is the MD5 hash of the file. The value of the ETag can be used to check whether the object was corrupted during the upload process.
For example, "09cba091df696af91549de27b8e7d0f6", Note: The ETag value string is enclosed in double quotes.
String
- VersionId
When an object is uploaded to a bucket with versioning enabled, the version ID of the object is returned; if versioning has never been enabled for the bucket, this parameter is not returned.
String
- statusCode
HTTP status code returned by the request, such as 200, 304, and so on. It returns 304 if the resource has not been modified after the specified time.
Number
- headers
Header returned by the request
Object
- - x-cos-object-type
Indicates whether the object can be appended to. Enumerated values: normal, appendable. By default, normal is not returned.
String
- - x-cos-storage-class
The storage class of the object. Enumerated values: STANDARD, STANDARD_IA, ARCHIVE, DEEP_ARCHIVE, and so on. Default: STANDARD (not returned). For more storage classes, see Storage Class Overview.
String
- - x-cos-meta-*
User-defined metadata
String
- - NotModified
Whether the object has not been modified after the specified time
Boolean

API Operations

Description of the API interface for querying object metadata, see the HEAD Object document.

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan