tencent cloud

Cloud Object Storage

동향 및 공지
릴리스 노트
제품 공지
제품 소개
제품 개요
기능 개요
적용 시나리오
제품 장점
기본 개념
리전 및 액세스 도메인
규격 및 제한
제품 요금
과금 개요
과금 방식
과금 항목
프리 티어
과금 예시
청구서 보기 및 다운로드
연체 안내
FAQ
빠른 시작
콘솔 시작하기
COSBrowser 시작하기
사용자 가이드
요청 생성
버킷
객체
데이터 관리
일괄 프로세스
글로벌 가속
모니터링 및 알람
운영 센터
데이터 처리
스마트 툴 박스 사용 가이드
데이터 워크플로
애플리케이션 통합
툴 가이드
툴 개요
환경 설치 및 설정
COSBrowser 툴
COSCLI 툴
COSCMD 툴
COS Migration 툴
FTP Server 툴
Hadoop 툴
COSDistCp 툴
HDFS TO COS 툴
온라인 도구 (Onrain Dogu)
자가 진단 도구
실습 튜토리얼
개요
액세스 제어 및 권한 관리
성능 최적화
AWS S3 SDK를 사용하여 COS에 액세스하기
데이터 재해 복구 백업
도메인 관리 사례
이미지 처리 사례
COS 오디오/비디오 플레이어 사례
데이터 다이렉트 업로드
데이터 보안
데이터 검증
빅 데이터 사례
COS 비용 최적화 솔루션
3rd party 애플리케이션에서 COS 사용
마이그레이션 가이드
로컬 데이터 COS로 마이그레이션
타사 클라우드 스토리지 데이터를 COS로 마이그레이션
URL이 소스 주소인 데이터를 COS로 마이그레이션
COS 간 데이터 마이그레이션
Hadoop 파일 시스템과 COS 간 데이터 마이그레이션
데이터 레이크 스토리지
클라우드 네이티브 데이터 레이크
메타데이터 가속
데이터 레이크 가속기 GooseFS
데이터 처리
데이터 처리 개요
이미지 처리
미디어 처리
콘텐츠 조정
파일 처리
문서 미리보기
장애 처리
RequestId 가져오기
공용 네트워크로 COS에 파일 업로드 시 속도가 느린 문제
COS 액세스 시 403 에러 코드 반환
리소스 액세스 오류
POST Object 자주 발생하는 오류
보안 및 컴플라이언스
데이터 재해 복구
데이터 보안
액세스 관리
자주 묻는 질문
인기 질문
일반 문제
과금
도메인 규정 준수 문제
버킷 설정 문제
도메인 및 CDN 문제
파일 작업 문제
로그 모니터링 문제
권한 관리
데이터 처리 문제
데이터 보안 문제
사전 서명 URL 관련 문제
SDK FAQ
툴 관련 문제
API 관련 문제
Agreements
Service Level Agreement
개인 정보 보호 정책
데이터 처리 및 보안 계약
연락처
용어집
문서Cloud Object Storage

Listing Objects

포커스 모드
폰트 크기
마지막 업데이트 시간: 2024-02-04 14:25:57

Overview

This document provides an overview of APIs and SDK code samples for listing objects.
API
Operation
Description
Querying objects
Queries some or all the objects in a bucket.
Querying objects and their version history
Queries some or all the objects in a bucket and their version history.

Querying an Object List

Feature description

This API (List Objects) is used to query all the objects in a specified bucket.

Method prototype

public Guzzle\\Service\\Resource\\Model listObjects(array $args = array());

Sample request

Sample 1. Querying a list of objects with the specified prefix starting from a specified object

<?php

require dirname(__FILE__) . '/../vendor/autoload.php';

$secretId = "SECRETID"; //Replace it with the actual `SecretId`, which can be viewed and managed in the CAM console at https://console.tencentcloud.com/cam/capi
$secretKey = "SECRETKEY"; //Replace it with the actual `SecretKey`, which can be viewed and managed in the CAM console at https://console.tencentcloud.com/cam/capi
$region = "ap-beijing"; //Replace it with the actual `region`, which can be viewed in the console at https://console.tencentcloud.com/cos5/bucket
$cosClient = new Qcloud\\Cos\\Client(
array(
'region' => $region,
'schema' => 'https', // Protocol header, which is http by default
'credentials'=> array(
'secretId' => $secretId ,
'secretKey' => $secretKey)));

try {
$result = $cosClient->listObjects(array(
'Bucket' => 'examplebucket-125000000', // Bucket name in the format of `BucketName-APPID`, which can be viewed in the COS console at https://console.tencentcloud.com/cos5/bucket
'Delimiter' => '/', // Delimiter: "/". // Set the delimiter to "/" to list objects in the current directory. To list all objects, leave this parameter empty.
'EncodingType' => 'url',// Encoding format, which indicates the `encoding-type` in requests
'Marker' => 'prefix/picture.jpg',// Marker of the starting object key
'Prefix' => 'prfix/', // Set a prefix to indicate that the key of the listed object starts with the prefix.
'MaxKeys' => 1000, // Set the maximum number of traversed objects (up to 1,000 per `listObjects` request)
));
// Request succeeded
print_r($result);
} catch (\\Exception $e) {
// Request failed
echo($e);
}

Parameter description

Parameter Name
Type
Description
Required
Bucket
String
Bucket name in the format of BucketName-APPID
Yes
Delimiter
String
Separator, left empty by default. For example, you can set it to / to indicate folders.
No
EncodingType
String
Encoding method of the returned value. The value is not encoded by default. Valid value: url
No
Marker
String
The object after which the returned list begins. Objects are listed in UTF-8 binary order by default.
No
Prefix
String
Key prefix to query objects by, left empty by default
No
MaxKeys
Int
The maximum number of returned objects, which is 1000 (the maximum value allowed) by default
No

Sample response

Guzzle\\Service\\Resource\\Model Object
(
[structure:protected] =>
[data:protected] => Array
(
[Name] => examplebucket-1250000000
[Prefix] => doc
[Marker] => doc/picture.jpg
[MaxKeys] => 10
[IsTruncated] => 1
[NextMarker] => doc/exampleobject
[Contents] => Array
(
[0] => Array
(
[Key] => doc/exampleobject
[LastModified] => 2019-02-14T12:20:40.000Z
[ETag] => "e37b429559d82e852af0b2f5b4d078ab72b90208"
[Size] => 6532594
[Owner] => Array
(
[ID] => 100000000001
[DisplayName] => 100000000001
)

[StorageClass] => STANDARD
)

[1] => Array
(
[Key] => doc/exampleobject2
[LastModified] => 2019-03-04T06:34:43.000Z
[ETag] => "988f9f28e68eba9b8c1f5f98ccce0a3c"
[Size] => 28
[Owner] => Array
(
[ID] => 100000000001
[DisplayName] => 100000000001
)

[StorageClass] => STANDARD
)
)
[RequestId] => NWNhMzM0MmZfOWUxYzBiMDlfOTk2YV83ZWE3ODE=
)

)

Response description

Parameter
Type
Description
Parent Node
Name
String
Bucket name in the format of BucketName-APPID
None
Delimiter
String
Separator. For example, you can set it to / to indicate folders.
None
EncodingType
String
Encoding method of the returned value
None
Marker
String
The object after which the returned list begins. Objects are listed in UTF-8 binary order by default. Set the returned Key to Marker to turn pages
None
Prefix
String
Key prefix by which objects are queried
None
MaxKeys
Int
The maximum number of returned objects, which is 1000 (the maximum value allowed) by default
None
IsTruncated
Int
Whether the returned objects are truncated
None
Contents
Array
Returned object list
None
Content
Array
List of the metadata (attributes) of all returned objects, including 'ETag', 'StorageClass', 'Key', 'Owner', 'LastModified', and 'Size'
Contents

Querying objects and their version history

Feature description

This API is used to query some or all the objects in a bucket and their version history.

Method prototype

public Guzzle\\Service\\Resource\\Model listObjectVersions(array $args = array());

Sample request

Sample 1. Querying objects and their version history

<?php

require dirname(__FILE__) . '/../vendor/autoload.php';

$secretId = "SECRETID"; //Replace it with the actual `SecretId`, which can be viewed and managed in the CAM console at https://console.tencentcloud.com/cam/capi
$secretKey = "SECRETKEY"; //Replace it with the actual `SecretKey`, which can be viewed and managed in the CAM console at https://console.tencentcloud.com/cam/capi
$region = "ap-beijing"; //Replace it with the actual `region`, which can be viewed in the console at https://console.tencentcloud.com/cos5/bucket
$cosClient = new Qcloud\\Cos\\Client(
array(
'region' => $region,
'schema' => 'https', // Protocol header, which is http by default
'credentials'=> array(
'secretId' => $secretId ,
'secretKey' => $secretKey)));

try {
$result = $cosClient->listObjectVersions(array(
'Bucket' => 'examplebucket-1250000000', // Bucket name in the format of `BucketName-APPID`, which can be viewed in the COS console at https://console.tencentcloud.com/cos5/bucket
'Delimiter' => '',
'EncodingType' => 'url',
'KeyMarker' => 'doc/picture.jpg',
'VersionIdMarker' => 'MTg0NDUxODMyMTE2ODY0OTExOTk3W',
'Prefix' => 'doc',
'MaxKeys' => 1000,
));
print_r($result);
} catch (\\Exception $e) {
echo($e);
}

Parameter description

Parameter Name
Type
Description
Required
Bucket
String
Bucket name in the format of BucketName-APPID
Yes
Prefix
String
Key prefix to query objects by, which is left empty by default
No
Delimiter
String
Separator, left empty by default. For example, you can set it to / to indicate folders.
No
KeyMarker
String
The key of the object after which the returned object list begins. Entries are listed in UTF-8 binary order by default.
No
VersionIdMarker
String
The version ID of the object after which the returned object list begins. Entries are listed in UTF-8 binary order by default.
No
MaxKeys
Int
The maximum number of returned objects, which is 1000 (the maximum value allowed) by default
No
EncodingType
String
Encoding method of the returned value. The value is not encoded by default. Valid value: url
No

Sample response

Guzzle\\Service\\Resource\\Model Object
(
[structure:protected] =>
[data:protected] => Array
(
[Name] => examplebucket-1250000000
[Prefix] => doc
[KeyMarker] => string
[VersionIdMarker] => string
[MaxKeys] => 10
[IsTruncated] => 1
[NextKeyMarker] => string
[NextVersionIdMarker] => string
[Versions] => Array
(
[0] => Array
(
[Key] => doc/exampleobject1
[VersionId] => null
[IsLatest] => 1
[LastModified] => 2019-06-13T09:24:52.000Z
[ETag] => "96e79218965eb72c92a549dd5a330112"
[Size] => 6
[StorageClass] => STANDARD
[Owner] => Array
(
[UID] => 1250000000
)
)

[1] => Array
(
[Key] => doc/exampleobject2
[VersionId] => MTg0NDUxODMyMTE2ODY0OTExOTk
[IsLatest] => 1
[LastModified] => 2019-06-18T12:47:03.000Z
[ETag] => "698d51a19d8a121ce581499d7b701668"
[Size] => 3
[StorageClass] => STANDARD
[Owner] => Array
(
[UID] => 1250000000
)
)
)
[RequestId] => NWQwOGVkZGRfMjViMjU4NjRfODNjN18xMTE5YWI4
)

)

Response description

Parameter Name
Type
Description
Parent Node
Name
String
Bucket name in the format of BucketName-APPID
None
Delimiter
String
Separator, left empty by default. For example, you can set it to / to indicate folders.
None
EncodingType
String
Encoding method of the returned value
None
KeyMarker
String
The key of the object after which the returned object list begins. Entries are listed in UTF-8 binary order by default.
None
VersionIdMarker
String
The version ID of the object after which the returned object list begins. Entries are listed in UTF-8 binary order by default.
None
NextKeyMarker
String
The key of the object after which the next returned list begins if IsTruncated is true
None
NextVersionIdMarker
String
The version ID of the object after which the next returned list begins if IsTruncated is true
None
Prefix
String
Key prefix by which objects are queried
None
MaxKeys
Int
The maximum number of returned objects, which is 1000 (the maximum value allowed) by default
None
IsTruncated
Int
Whether the returned objects are truncated
None
Versions
Array
List of the metadata of all objects with multiple versions
None
Version
Array
List of the metadata of all objects with multiple versions, including ETag, StorageClass, Key, VersionId, IsLatest, Owner, LastModified, and Size
Versions
CommonPrefixes
Array
All objects starting with the specified prefix and ending with the specified delimiter
None


도움말 및 지원

문제 해결에 도움이 되었나요?

피드백