GET Bucket

Description

This GET operation lists some or all (up to 1000) objects in the specified space. You can set request parameters to select the objects to be listed in the specified space.

Users need to have 'READ' permission on the space to use this interface.

Note: If you want to list user spaces, you can use the GET service interface.

Request

Grammar

GET / HTTP/1.1
Host: {BucketName}.{endpoint}
Date: {date}
Authorization: {SignatureValue}

Note:

• Corresponding relationship between Endpoint and Region
• SignatureValue signature algorithm

Request parameters

Request header

This interface only uses common request headers. For more information, please click Public request headers.

Request content

The interface does not use the requested content.

Response

Response header

This interface can use all common response headers. For more information,please click Public response headers.

Response content

Special errors

The interface does not return any special errors.

Example

Request example

GET / HTTP/1.1
Host: ks3-example.ks3-cn-beijing.ksyuncs.com
Date: Wed, 12 Oct 2009 17:50:00 GMT
Authorization: authorization string
Content-Type: text/plain

Response example

<?xml version="1.0" encoding="UTF-8"?>
<ListBucketResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
    <Name>ks3-example</Name>
    <Prefix/>
    <Marker/>
    <MaxKeys>1000</MaxKeys>
    <IsTruncated>false</IsTruncated>
    <Contents>
        <Key>my-image.jpg</Key>
        <LastModified>2009-10-12T17:50:30.000Z</LastModified>
        <ETag>fba9dede5f27731c9771645a39863328</ETag>
        <Size>434234</Size>
        <StorageClass>STANDARD</StorageClass>
        <Owner>
            <ID>73410125</ID>
            <DisplayName>[email protected]</DisplayName>
        </Owner>
    </Contents>
    <Contents>
       <Key>my-third-image.jpg</Key>
         <LastModified>2009-10-12T17:50:30.000Z</LastModified>
        <ETag>1b2cf535f27731c974343645a3985328</ETag>
        <Size>64994</Size>
        <StorageClass>STANDARD</StorageClass>
        <Owner>
            <ID>73410125</ID>
            <DisplayName>[email protected]</DisplayName>
        </Owner>
    </Contents>
</ListBucketResult>

Interface details

• Since max-keys can only be 1000 at most, a list operation does not necessarily list all files. When the returned 'IsTruncated' is true, the returned result is truncated. That is to say, this list has not listed all objects. If the request parameter contains' delimiter ', the returned' NextMarker 'can be used as the' marker 'parameter of the next list. If the request parameter does not contain' delimiter ', the last one of the returned' Contents' can be used as the 'marker' parameter of the next list.

• The directory structure can be simulated by using prefix and delimiter. If max-keys and delimiter are set, the number of file lists returned is not necessarily equal to max-keys, which may be less than max-keys. Suppose there are the following objects in the bucket, They are: movie/action/1.mp4
  movie/fun/2.mp4 movie/fun/3.mp4
  photo/1.jpg
  4.txt
  When only prefix = movie / fun / is provided, the returned results are movie / fun / 2.mp4, movie / fun / 3.mp4 When the delimiter = / is provided, the returned results are commonprefixes: movie /, photo / contents: 4.txt When prefix = movie /,delimiter = / are provided, the returned results are commonprefixes: movie / action /, movie / fun/

  Description of invisible character processing

1、Due to the exception of converting some invisible characters into XML, KS3 transcodes the invisible characters of the interface.

2、Rules of transcoding

Convert the hexadecimal value of the invisible character to #x{dd}; for example, convert the invisible character 0x00 (empty character) to #x00;

The conversion list is as follows:

3、Transcoding example

import java.util.ArrayList;
import java.util.List;

public class DecodeInvalidStr {

    public static void main(String[] args) {
        String str = decodeInvalidStr("test#x1f;char#x1e;hello#xfffe;transfer");
        System.out.println(str);

    }

     public static String decodeInvalidStr(String str) { 
         if(str == null) { 
             return null; 
         }
           List<Character> newChar = new ArrayList<Character>();
         char[] array = str.toCharArray(); 
         int skipIndex = -1;
         for (int i = 0, length = array.length; i < length; i++) { 
           if(i <= skipIndex){
                 continue;
           }
             if(array[i] == (char)'#'
                       && (i+1) < array.length
                       && array[i+1] == (char)'x'){
                 StringBuffer strChar = new StringBuffer();
                 for(int j = i+2;j<i+7;j++){
                       if(array[j] == (char)';'){
                             skipIndex = j;
                             char value =(char) Integer.parseInt(strChar.toString(), 16);
                             newChar.add(value);
                             break;
                       }else{
                             strChar.append(array[j]);
                       }
                 }
             }
             else{
                 newChar.add(array[i]);
             }

         } 
         return toString(newChar);
     }

   private static String toString(List<Character> newChar){
       char[] charArray = new char[newChar.size()];
       int i = 0;
       for(Character c : newChar){
           charArray[i++] = c;
       }
       return new String(charArray);
   }

}