QingCloud 文档 – Service API - kaiyun官方网站下载手机网页 /storage/object-storage/api/service/ Recent content in Service API on QingCloud 文档 Hugo -- gohugo.io Wed, 25 Nov 2020 10:08:56 +0900 Storage: GET Service /storage/object-storage/api/service/get/ Mon, 01 Jan 0001 00:00:00 +0000 /storage/object-storage/api/service/get/ <p>该 API 用于获取请求者名下的所有 Bucket 列表。</p> <h2 id="使用限制">使用限制</h2> <ul> <li>该 API 不支持匿名请求,请先注册开·云app官方版下载账号并 <a href="/storage/object-storage/api/practices/signature/#%E8%8E%B7%E5%8F%96-access-key">创建 Access Key</a> 后才能调用此 API。</li> <li>该请求可以用于查询 QingStor 对象存储的 Global Endpoint 下所有区域的 Bucket。Global Endpoint 为:<code>qingstor.com</code>。</li> <li>该请求也可以用于查询 QingStor 对象存储某个区域的 <a href="/storage/object-storage/intro/object-storage/#zone">Zone Endpoint</a> (如 pek3.qingstor.com),列出特定区域的 Bucket。</li> </ul> <h2 id="请求语法">请求语法</h2> <div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-http" data-lang="http"><span style="display:flex;"><span><span style="color:#a6e22e">GET</span> / <span style="color:#66d9ef">HTTP</span><span style="color:#f92672">/</span><span style="color:#ae81ff">1.1</span> </span></span><span style="display:flex;"><span>Host<span style="color:#f92672">:</span> <span style="color:#ae81ff">qingstor.com</span> </span></span><span style="display:flex;"><span>Date<span style="color:#f92672">:</span> <span style="color:#ae81ff">&lt;date&gt;</span> </span></span><span style="display:flex;"><span>Authorization<span style="color:#f92672">:</span> <span style="color:#ae81ff">&lt;authorization-string&gt;</span> </span></span></code></pre></div><h2 id="请求参数">请求参数</h2> <p>调用该接口时,用户可在 URL 中添加以下参数对响应内容做出限制。</p> <table> <thead> <tr> <th>参数名</th> <th>类型</th> <th>说明</th> <th>是否必须</th> </tr> </thead> <tbody> <tr> <td>offset</td> <td>Integer</td> <td>列取游标。默认值为 0,表示从头开始列取。</td> <td>否</td> </tr> <tr> <td>limit</td> <td>Integer</td> <td>限定此次返回 Bucket 的最大数量,默认值为 200。</td> <td>否</td> </tr> </tbody> </table> <h2 id="请求消息头">请求消息头</h2> <p>该 API 接口支持如下消息头:</p> <table> <thead> <tr> <th>字段</th> <th>类型</th> <th>说明</th> <th>是否必须</th> </tr> </thead> <tbody> <tr> <td>Location</td> <td>Enum</td> <td>限定 Bucket 所在的区域。目前支持:<code>pek3a</code>,<code>sh1a</code>。</td> <td>否</td> </tr> </tbody> </table> <p>除以上请求头以外,此接口还需要包含 Host、Date 等公共请求头。详细内容可参见 <a href="/storage/object-storage/api/common_header/#%E8%AF%B7%E6%B1%82%E5%A4%B4%E5%AD%97%E6%AE%B5-request-header">公共请求头</a>。</p> <h2 id="请求消息体">请求消息体</h2> <p>无。</p> <h2 id="响应头">响应头</h2> <p>此接口仅包含公共响应头。关于公共响应头的更多信息,请参见 <a href="/storage/object-storage/api/common_header/#%E5%93%8D%E5%BA%94%E5%A4%B4%E5%AD%97%E6%AE%B5-response-header">公共响应头</a>。</p> <h2 id="响应体">响应体</h2> <p>成功调用该 API 后,会返回一个 Json 消息体,其字段说明如下:</p> <table> <thead> <tr> <th>名称</th> <th>类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td>count</td> <td>Int</td> <td>Bucket 数量</td> </tr> <tr> <td>buckets</td> <td>List</td> <td>Bucket 元信息列表</td> </tr> </tbody> </table> <h2 id="错误码">错误码</h2> <p>正常会返回 200,失败的返回码参考 <a href="/storage/object-storage/api/error_code/#%E9%94%99%E8%AF%AF%E7%A0%81%E5%88%97%E8%A1%A8">错误码列表</a>。</p> <h2 id="示例">示例</h2> <h3 id="请求示例">请求示例</h3> <div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-http" data-lang="http"><span style="display:flex;"><span><span style="color:#a6e22e">GET</span> / <span style="color:#66d9ef">HTTP</span><span style="color:#f92672">/</span><span style="color:#ae81ff">1.1</span> </span></span><span style="display:flex;"><span>Host<span style="color:#f92672">:</span> <span style="color:#ae81ff">qingstor.com</span> </span></span><span style="display:flex;"><span>Date<span style="color:#f92672">:</span> <span style="color:#ae81ff">Sun, 16 Aug 2015 09:05:00 GMT</span> </span></span><span style="display:flex;"><span>Authorization<span style="color:#f92672">:</span> <span style="color:#ae81ff">authorization string</span> </span></span></code></pre></div><h3 id="响应示例">响应示例</h3> <div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-http" data-lang="http"><span style="display:flex;"><span><span style="color:#66d9ef">HTTP</span><span style="color:#f92672">/</span><span style="color:#ae81ff">1.1</span> <span style="color:#ae81ff">200</span> <span style="color:#a6e22e">OK</span> </span></span><span style="display:flex;"><span>Server<span style="color:#f92672">:</span> <span style="color:#ae81ff">QingStor</span> </span></span><span style="display:flex;"><span>Date<span style="color:#f92672">:</span> <span style="color:#ae81ff">Sun, 16 Aug 2015 09:05:00 GMT</span> </span></span><span style="display:flex;"><span>Content-Length<span style="color:#f92672">:</span> <span style="color:#ae81ff">256</span> </span></span><span style="display:flex;"><span>Connection<span style="color:#f92672">:</span> <span style="color:#ae81ff">close</span> </span></span><span style="display:flex;"><span>x-qs-request-id<span style="color:#f92672">:</span> <span style="color:#ae81ff">aa08cf7a43f611e5886952542e6ce14b</span> </span></span><span style="display:flex;"><span> </span></span><span style="display:flex;"><span>{ </span></span><span style="display:flex;"><span> &#34;count&#34;: 2, </span></span><span style="display:flex;"><span> &#34;buckets&#34;: [ </span></span><span style="display:flex;"><span> { </span></span><span style="display:flex;"><span> &#34;name&#34;: &#34;mybucket&#34;, </span></span><span style="display:flex;"><span> &#34;location&#34;: &#34;pek3a&#34;, </span></span><span style="display:flex;"><span> &#34;url&#34;: &#34;https://mybucket.pek3a.qingstor.com&#34;, </span></span><span style="display:flex;"><span> &#34;created&#34;: &#34;2015-07-11T04:45:57Z&#34; </span></span><span style="display:flex;"><span> }, </span></span><span style="display:flex;"><span> { </span></span><span style="display:flex;"><span> &#34;name&#34;: &#34;myphotos&#34;, </span></span><span style="display:flex;"><span> &#34;location&#34;: &#34;pek3a&#34;, </span></span><span style="display:flex;"><span> &#34;url&#34;: &#34;https://myphotos.pek3a.qingstor.com&#34;, </span></span><span style="display:flex;"><span> &#34;created&#34;: &#34;2015-07-12T09:40:32Z&#34; </span></span><span style="display:flex;"><span> } </span></span><span style="display:flex;"><span> ] </span></span><span style="display:flex;"><span>} </span></span></code></pre></div><h2 id="sdk">SDK</h2> <p>此接口所对应的各语言 SDK 可参考 <a href="/storage/object-storage/sdk/">SDK 文档</a>。</p> Storage: List Locations /storage/object-storage/api/service/location/ Mon, 01 Jan 0001 00:00:00 +0000 /storage/object-storage/api/service/location/ <p>该 API 用于获取 QingStor 对象存储所有部署区域的列表。</p> <h2 id="使用限制">使用限制</h2> <ul> <li>该 API 支持匿名请求。</li> <li>使用该 API 时,请求只能发送至 QingStor 对象存储服务的 Globan Endpoint,即:<code>qingstor.com</code>。</li> </ul> <h2 id="请求语法">请求语法</h2> <div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-http" data-lang="http"><span style="display:flex;"><span><span style="color:#a6e22e">GET</span> /?location&amp;lang=zh-cn <span style="color:#66d9ef">HTTP</span><span style="color:#f92672">/</span><span style="color:#ae81ff">1.1</span> </span></span><span style="display:flex;"><span>Host<span style="color:#f92672">:</span> <span style="color:#ae81ff">qingstor.com</span> </span></span></code></pre></div><h2 id="请求参数">请求参数</h2> <p>调用该接口时,用户可在 URL 中添加以下参数:</p> <table> <thead> <tr> <th>参数名</th> <th>类型</th> <th>说明</th> <th>是否必须</th> </tr> </thead> <tbody> <tr> <td>lang</td> <td>String</td> <td>返回 Location Name 的语言,默认是英文 <code>en-us</code>,可选值为:<br>- 中文:<code>zh-cn</code>/<code>zh_CN</code> <br>- 英文:<code>en-us</code>/<code>en_US</code>。</td> <td>否</td> </tr> </tbody> </table> <h2 id="请求消息头">请求消息头</h2> <p>仅包含 Host 消息头,无其他消息头。</p> <h2 id="请求消息体">请求消息体</h2> <p>无。</p> <h2 id="响应头">响应头</h2> <p>此接口仅包含公共响应头。关于公共响应头的更多信息,请参见 <a href="/storage/object-storage/api/common_header/#%E5%93%8D%E5%BA%94%E5%A4%B4%E5%AD%97%E6%AE%B5-response-header">公共响应头</a>。</p> <h2 id="响应体">响应体</h2> <p>成功调用该 API 后,会返回一个 Json 消息体,其字段说明如下:</p> <table> <thead> <tr> <th>名称</th> <th>类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td>locations</td> <td>List</td> <td>Location 列表</td> </tr> <tr> <td>id</td> <td>String</td> <td><code>Location</code> 的健值,Location ID。</td> </tr> <tr> <td>name</td> <td>String</td> <td><code>Location</code> 的健值,根据请求参数 <code>lang</code> 指定语言的翻译。</td> </tr> <tr> <td>endpoint</td> <td>String</td> <td><code>Location</code> 的健值,Location Endpoint,如 Location ID 为 pek3a 的 Endpoint 是 pek3a.qingstor.com。</td> </tr> </tbody> </table> <h2 id="错误码">错误码</h2> <p>仅返回 200。</p> <h2 id="示例">示例</h2> <h3 id="请求示例">请求示例</h3> <div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-http" data-lang="http"><span style="display:flex;"><span><span style="color:#a6e22e">GET</span> /?location&amp;lang=zh-cn <span style="color:#66d9ef">HTTP</span><span style="color:#f92672">/</span><span style="color:#ae81ff">1.1</span> </span></span><span style="display:flex;"><span>Host<span style="color:#f92672">:</span> <span style="color:#ae81ff">qingstor.com</span> </span></span></code></pre></div><h3 id="响应示例">响应示例</h3> <div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-http" data-lang="http"><span style="display:flex;"><span><span style="color:#66d9ef">HTTP</span><span style="color:#f92672">/</span><span style="color:#ae81ff">1.1</span> <span style="color:#ae81ff">200</span> <span style="color:#a6e22e">OK</span> </span></span><span style="display:flex;"><span>Server<span style="color:#f92672">:</span> <span style="color:#ae81ff">QingStor</span> </span></span><span style="display:flex;"><span>Date<span style="color:#f92672">:</span> <span style="color:#ae81ff">Mon, 23 Oct 2017 12:08:19 GMT</span> </span></span><span style="display:flex;"><span>Content-Type<span style="color:#f92672">:</span> <span style="color:#ae81ff">application/json</span> </span></span><span style="display:flex;"><span>Content-Length<span style="color:#f92672">:</span> <span style="color:#ae81ff">177</span> </span></span><span style="display:flex;"><span>x-qs-request-id<span style="color:#f92672">:</span> <span style="color:#ae81ff">dc05ee1cb7ea11e7b8da5254dda2bdf5</span> </span></span><span style="display:flex;"><span> </span></span><span style="display:flex;"><span>{ </span></span><span style="display:flex;"><span> <span style="color:#f92672">&#34;locations&#34;</span>: [ </span></span><span style="display:flex;"><span> { </span></span><span style="display:flex;"><span> <span style="color:#f92672">&#34;endpoint&#34;</span>: <span style="color:#e6db74">&#34;pek3a.qingstor.com&#34;</span>, </span></span><span style="display:flex;"><span> <span style="color:#f92672">&#34;id&#34;</span>: <span style="color:#e6db74">&#34;pek3a&#34;</span>, </span></span><span style="display:flex;"><span> <span style="color:#f92672">&#34;name&#34;</span>: <span style="color:#e6db74">&#34;\u5317\u4eac3\u533a&#34;</span> </span></span><span style="display:flex;"><span> }, </span></span><span style="display:flex;"><span> { </span></span><span style="display:flex;"><span> <span style="color:#f92672">&#34;endpoint&#34;</span>: <span style="color:#e6db74">&#34;sh1a.qingstor.com&#34;</span>, </span></span><span style="display:flex;"><span> <span style="color:#f92672">&#34;id&#34;</span>: <span style="color:#e6db74">&#34;sh1a&#34;</span>, </span></span><span style="display:flex;"><span> <span style="color:#f92672">&#34;name&#34;</span>: <span style="color:#e6db74">&#34;\u4e0a\u6d771\u533a&#34;</span> </span></span><span style="display:flex;"><span> } </span></span><span style="display:flex;"><span> ] </span></span><span style="display:flex;"><span>} </span></span></code></pre></div><h2 id="sdk">SDK</h2> <p>此接口所对应的各语言 SDK 可参考 <a href="/storage/object-storage/sdk/">SDK 文档</a>。</p>