SWIFT API 使用文档

http://www.cnblogs.com/lxguidu/archive/2013/04/25/3042137.html

1、背景知识

OpenStack Object Storage (Swift) 是用来创建冗余的、可扩展的对象存储（引擎）的开源软件。 swift使用标准化的服务器存储 PB 级的访问数据。它并不是文件系统或者实时的数据存储系统，而是一个用于存储永久类型的静态数据的长期存储系统，这些数据可以检索、调整、必要时进行更新。最适合存储的数据类型的首要例子是虚拟机镜像，图片存储，邮件存储，存档备份。因为没有中心单元或者主控结点，swift提供了更强的扩展性、冗余和持久性。

OpenStack Object Storage (Swift)使用RESTful API对外提供服务，通过HTTP协议来进行数据间的交互，数据存放在request中。Swift支持单个无文件最大5G，大于5G的文件在客户端切分上传，并上传manifest文件。

图 1-1 SWIFT数据交互

2、API使用描述

1）获取token

接口名称：	获取一个token ID
接口定义：	curl -X POST -d ' {"auth": {"tenantName": “{租户名}”, "passwordCredentials": { "username": “{用户名}”, "password": “{用户密码}”} } }' -H "Content-type: application/json" http://localhost:35357/v2.0/tokens \| python -mjson.tool
传入参数定义：	{"tenantName": “{租户名}”, "passwordCredentials": { "username": “{用户名}”, "password": “{用户密码}”} }
返回结果：	返回的结果比较冗长，请自己在实验环境192.168.0.191上操作，并观察。而需要注意的是其中token的结果： "token": { "expires": "2012-09-27T13:41:15Z", "id": "d8444bd1ab8140ceb136d748eef86647", "tenant": { "description": null, "enabled": true, "id": "e8b18580e5b44cb79b10bd0f7a03bbdc", "name": "admin" } } 在以下的接口操作中，都需要从该token中获取它的id，以及其对应租户（tenant）的id。
协议：	http
示例：	curl -X POST -d '{"auth": {"tenantName": "admin", "passwordCredentials":{"username": "admin", "password": "pengchao"}}}' -H "Content-type: application/json" http://192.168.0.191:35357/v2.0/tokens \| python -mjson.tool

2）容器列表

接口名称：	获取容器列表
接口定义：	curl -s http://localhost:8080/v1/AUTH_{Tenant_id} \ -X GET \ -H "X-Auth-Token: { Token_id}"
传入参数定义：	Tenant_id：租户id Token_id：租户对应的token的id
返回结果：
协议：	http
示例：	curl -s http://192.168.0.191:8080/v1/AUTH_e8b18580e5b44cb79b10bd0f7a03bbdc -X GET -H "X-Auth-Token: 22ec6a37ed6b4b23a435e6b9050f21a4"

3）创建容器

接口名称：	创建容器
接口定义：	curl -s http://localhost:8080/v1/AUTH_{Tenant_id}/{Container_name} \ -X PUT \ -H "X-Auth-Token: { Token_id}"
传入参数定义：	Tenant_id：租户id Container_name: 所创建的容器名称 Token_id：租户对应的token的id
返回结果：	如果创建成功，返回“201 Created”
协议：	http
示例：	curl -s http://192.168.0.191:8080/v1/AUTH_e8b18580e5b44cb79b10bd0f7a03bbdc -X GET -H "X-Auth-Token: 22ec6a37ed6b4b23a435e6b9050f21a4"

4）删除容器

接口名称：	删除容器
接口定义：	curl -s http://localhost:8080/v1/AUTH_{Tenant_id}/{Container_name} \ -X DELETE \ -H "X-Auth-Token: { Token_id}"
传入参数定义：	Tenant_id：租户id Container_name: 所删除的容器名称 Token_id：租户对应的token的id
返回结果：	如果删除成功，什么也没返回。可以使用列出容器的api验证。
协议：	http
示例：	curl -s http://192.168.0.191:8080/v1/AUTH_e8b18580e5b44cb79b10bd0f7a03bbdc/my_container -X DELETE -H "X-Auth-Token: 22ec6a37ed6b4b23a435e6b9050f21a4"

5）列出对象

接口名称：	列出容器对象
接口定义：	curl -s http://localhost:8080/v1/AUTH_{Tenant_id}/{Container_name}[?parm=value] \ -X GET \ -H "X-Auth-Token: { Token_id}"
传入参数定义：	Tenant_id：租户id Container_name: 容器名称 Token_id：租户对应的token的id
返回结果：
协议：	http
示例：	curl -s http192.168.0.191:8080/v1/AUTH_AUTH_e8b18580e5b44cb79b10bd0f7a03bbdc/my_container?format=json -X GET -H "X-Auth-Token: 22ec6a37ed6b4b23a435e6b9050f21a4" \| python -mjson.tool

6）创建对象

接口名称：	创建对象
接口定义：	curl –X PUT -i \ -H "X-Auth-Token: { Token_id}" \ -T {obj_path} \ http://localhost:8080/v1/AUTH_{Tenant_id}/{Container_name}/{obj_name}
传入参数定义：	Tenant_id：租户id Obj_path：对象的完整路径 obj_name：对象名称 Container_name: 容器名称 Token_id：租户对应的token的id
返回结果：	<html> <head> <title>201 Created</title> </head> <body> <h1>201 Created</h1> <br /><br /> </body> </html>
协议：	http
示例：	curl -X PUT -i -H "X-Auth-Token: 22ec6a37ed6b4b23a435e6b9050f21a4" -T ufw.log http://192.168.0.191:8080/v1/AUTH_e8b18580e5b44cb79b10bd0f7a03bbdc/my_container/ufw.log

7）删除对象

接口名称：	删除对象
接口定义：	curl -s http://localhost:8080/v1/AUTH_{Tenant_id}/{Container_id}/{object_name} \ -X DELETE \ -H "X-Auth-Token: { Token_id}"
传入参数定义：	Tenant_id：租户id Obj_name：对象名称 Container_name: 所删除的容器名称 Token_id：租户对应的token的id
返回结果：	无返回
协议：	http
示例：	curl -s http://192.168.0.191:8080/v1/AUTH_e8b18580e5b44cb79b10bd0f7a03bbdc/my_container/history24 -X DELETE -H "X-Auth-Token: 22ec6a37ed6b4b23a435e6b9050f21a4"

3、实例：使用Python实现

3.1、前提条件

由于数据是存放在request中，为了方便，先构造request，使用python（urllib2）代码实现如下：

@param：server_api 根据需要定义的rest url

@param：autho_token 管理员token

@param：send_data 需要发送的数据

@param：method 定义的方法【GET、PUT、DELETE、POST】，默认是POST

def get_server_request(server_api=None, auth_token=None, send_data=None, method=None):

    if not server_api:

        return None

    server_request = urllib2.Request(server_api)

    if not server_request:

        return None

    server_request.add_header('Content-Type', 'application/json;charset=utf8')

    server_request.add_header('Accept', 'application/json')

    server_request.add_header('User-Agent', 'python-mikeyp')

    if auth_token:

        server_request.add_header('X-Auth-Token', auth_token)

    if send_data:

        server_request.add_data(send_data)

    if method:

        server_request.get_method = lambda: method

    return server_request

1）获取keystone认证，进行任何CURD操作，都需要从keystone中获取管理员的租户ID和管理员的token，用Python代码实现如下：

@param：user_name 管理员

@param：password 管理员密码

@param：tenant_name 管理员对应的租户名称

def get_keystone_token(user_name=None, password=None, tenant_name=None):

    server_api = get_Keystone_Endpoint() + 'tokens'

    send_data = None

    if user_name and password and tenant_name:

        send_data = {'auth': {'tenantName': tenant_name, 'passwordCredentials': \

                           {'username': user_name, 'password': password}}}

    if not send_data:

        return None

    server_request = get_server_request(server_api, None, json.dumps(send_data), None)

    if not server_request:

        return None

    try:

        server_response = urllib2.urlopen(server_request)

        receiver_data = server_response.read()

        if receiver_data:

            data = json.loads(receiver_data)

            token = data['access']['token']['id']

            tenant_id = data['access']['token']['tenant']['id']

            return (tenant_id, token)

        else:

            return None

    except Exception:

        return None

3.2、主要功能实现

以下的代码都能单独使用，实现的关键在于对request操作，实现如下：

server_response = urllib2.urlopen(server_request)

1）列出容器

'''列出swift容器列表

@param:

@type:

@return:"count","bytes","name"

@rtype:json

'''

def Container_list():

    server_api = None

    if tenant_id:

        server_api = untils.get_Swift_Endpoint() + tenant_id

    if not server_api:

        api_logger.error('Container_list server_api: %s.' % server_api)

        return untils.rest_result()

    try:

        server_request = untils.get_server_request(server_api, token)

        api_logger.info('Container_list server_request: %s.' % server_request)

        if not server_request:

            return untils.rest_result()

        server_response = urllib2.urlopen(server_request)

        api_logger.info('Container_list server_response: %s.' % server_response)

        receiver_data = server_response.read()

        if receiver_data:

            data = json.loads(receiver_data)

            con_list = []

            for d in data:

                con_list.append(d['name'])

            return con_list

        return untils.rest_result(True, False)

    except Exception:

        api_logger.critical('Container_list function caught an exception.')

        return untils.rest_result(False, True)

2）创建容器

'''创建一个容器

@param:

@type:

@return:"count","bytes","name"

@rtype:json

'''

def Container_create(name=None):

    server_api = None

    if tenant_id:

        server_api = untils.get_Swift_Endpoint() + tenant_id + "/" + name

    if not server_api:

        api_logger.error('Container_create server_api: %s.' % server_api)

        return untils.rest_result()

    try:

        server_request = untils.get_server_request(server_api, token, None, "PUT")

        api_logger.info('Container_create server_request: %s.' % server_request)

        if not server_request:

            return untils.rest_result()

        server_response = urllib2.urlopen(server_request)

        api_logger.info('Container_create server_response: %s.' % server_response)

        receiver_data = server_response.read()

        if receiver_data:

            data = json.dumps(receiver_data)

            return untils.rest_result(True, False, data)

        return untils.rest_result(True, False)

    except Exception:

        api_logger.critical('Container_create function caught an exception.')

        return untils.rest_result(False, True)

3）删除容器

'''删除一个容器

@param:

@type:

@return:"count","bytes","name"

@rtype:json

'''

def Container_delete(con_name=None):

    if con_name not in Container_list():

        return untils.rest_result()

    obj_list= Object_list(con_name)[0]

    if obj_list:

        api_logger.info("the contaniner is not empty!")

        for obj in obj_list:

            Object_delete(con_name,obj)

    server_api = None

    if tenant_id:

        server_api = untils.get_Swift_Endpoint() + tenant_id + "/" + con_name

    if not server_api:

        api_logger.error('Container_delete server_api: %s.' % server_api)

        return untils.rest_result()

    try:

        server_request = untils.get_server_request(server_api, token, None, "DELETE")

        api_logger.info('Container_delete server_request: %s.' % server_request)

        if not server_request:

            return untils.rest_result()

        server_response = urllib2.urlopen(server_request)

        api_logger.info('Container_delete server_response: %s.' % server_response)

        receiver_data = server_response.read()

        if receiver_data:

            data = json.dumps(receiver_data)

            return untils.rest_result(True, False, data)

        return untils.rest_result(True, False)

    except Exception:

        api_logger.critical('Container_delete function caught an exception.')

        return untils.rest_result(False, True)

4）列出对象

'''列出swift某容器的对象列表

@param container_name:容器名称

@type:char

@return:"bytes","last_modified","hash","name","content_type"

@rtype:json

'''

def Object_list(container_name=None):

    server_api = None

    if tenant_id:

        server_api = untils.get_Swift_Endpoint() + tenant_id + "/" + container_name

    if not server_api:

        api_logger.error('Object_list server_api: %s.' % server_api)

        return untils.rest_result()

    try:

        server_request = untils.get_server_request(server_api, token)

        api_logger.info('Object_list server_request: %s.' % server_request)

        if not server_request:

            return untils.rest_result()

        server_response = urllib2.urlopen(server_request)

        api_logger.info('Object_list server_response: %s.' % server_response)

        receiver_data = server_response.read()

        if receiver_data:

            data = json.loads(receiver_data)

            c_l = []

            for d in data:

                c_l.append(d['name'])

            return untils.rest_result(True, False, c_l)

        return untils.rest_result(True, False)

    except Exception:

        api_logger.critical('Object_list function caught an exception.')

        return untils.rest_result(False, True)

5）上传对象

'''在一个容器内创建、上传一个对象

@param container_name:容器名称

@param file_name:对象名称

@type:char

@return:

@rtype:json

'''

def Object_upload(container_name=None, obj_path=None, obj_name=None):

    send_data = None

    obj_full_path = os.path.join(obj_path, obj_name)

    with open(obj_full_path) as obj:

        send_data = json.dumps(obj.read())

    server_api = None

    if tenant_id:

        server_api = untils.get_Swift_Endpoint() + tenant_id + "/" + container_name + "/" + obj_name

    if not server_api:

        api_logger.error('Object_upload server_api: %s.' % server_api)

        return untils.rest_result()

    try:

        server_request = untils.get_server_request(server_api, token, send_data, 'PUT')

        api_logger.info('Object_upload server_request: %s.' % server_request)

        if not server_request:

            return untils.rest_result()

        server_response = urllib2.urlopen(server_request)

        api_logger.info('Object_upload server_response: %s.' % server_response)

        receiver_data = server_response.read().strip()

        if receiver_data:

            data = json.dumps(receiver_data)

            return untils.rest_result(True, False, data)

        return untils.rest_result(True, False)

    except Exception:

        api_logger.critical('Object_upload function caught an exception.')

        return untils.rest_result(False, True)

6）下载对象

'''从容器下载一个对象

@param container_name:容器名称

@param file_name:对象名称

@type:char

@return:

@rtype:json

'''

def Object_download(container_name=None, obj_path=None, obj_name=None):

    server_api = None

    if tenant_id:

        server_api = untils.get_Swift_Endpoint() + tenant_id + "/" + container_name + "/" + obj_name

    if not server_api:

        api_logger.error('Object_download server_api: %s.' % server_api)

        return untils.rest_result()

    try:

        server_request = untils.get_server_request(server_api, token)

        api_logger.info('Object_download server_request: %s.' % server_request)

        if not server_request:

            return untils.rest_result()

        server_response = urllib2.urlopen(server_request)

        api_logger.info('Object_download server_response: %s.' % server_response)

        receiver_data = server_response.read()

        if receiver_data:

            obj_full_path = os.path.join(obj_path, obj_name)

            with open(obj_full_path, "wb") as code:

                code.write(receiver_data)

        return untils.rest_result(True, False)

    except Exception:

        api_logger.critical('Object_download function caught an exception.')

        return untils.rest_result(False, True)

7）删除对象

'''从容器删除一个对象

@param container_name:容器名称

@param file_name:对象名称

@type:char

@return:

@rtype:json

'''

def Object_delete(container_name=None, obj_name=None):

    server_api = None

    if tenant_id:

        server_api = untils.get_Swift_Endpoint() + tenant_id + "/" + container_name + "/" + obj_name

    if not server_api:

        api_logger.error('Object_delete server_api: %s.' % server_api)

        return untils.rest_result()

    try:

        server_request = untils.get_server_request(server_api, token, None, 'DELETE')

        api_logger.info('Object_delete server_request: %s.' % server_request)

        if not server_request:

            return untils.rest_result()

        server_response = urllib2.urlopen(server_request)

        api_logger.info('Object_delete server_response: %s.' % server_response)

        receiver_data = server_response.read()

        if receiver_data:

            data = json.dumps(receiver_data)

            return untils.rest_result(True, False, data)

        return untils.rest_result(True, False)

    except Exception:

        api_logger.critical('Object_delete function caught an exception.')

        return untils.rest_result(False, True)

查看全文
如若内容造成侵权/违法违规/事实不符，请联系编程学习网邮箱：809451989@qq.com进行投诉反馈，一经查实，立即删除！

C语言函数参数调用顺序
浩然君前几天发过一个小文件：关于函数参数的调用顺序的int arr[] = {6,7,8,9,10};int *ptr = arr;*(ptr++) += 123;printf(“ %d %d ”, *ptr, *(++ptr));输出：8 8 函数参数入栈的顺序，一般VC的编译器是从右往左入栈，那么这个运算也自然是从右往左。++ptr之后ptr再次向后一…...
2024/4/20 14:23:29
【阅读笔记之十一】《DIRECTX.9.0.3D游戏开发编程基础》：网格（一）闲话ID3DXMesh接口
网格（一）闲话ID3DXMesh接口关于网格部分，因为非常重要，故分为几个部分来学习。网格（一）主要讲解一下网格之中使用最多的接口ID3DXMesh。在这部分关于网格的学习完成之后，最后会详细学习综合的示例。在Direct3D渲染绘制过程中，网格是一个非常重要的概念。游戏中，我们需…...
2024/4/19 9:22:59
SETUP FACTORY安装完成后自动运行软件
2012-08-09 15:47 Setup Factory自动启动安装的某个程序有朋友问我用Setup Factory制作安装程序时，怎么实现制作出的程序安装时自动运行安装程序里的某个程序或脚本？举例说明一下吧！例如：现在要使用Setup Factory 7.0制作一个安装程序，安装程序包里有一个exe需要在安装…...
2024/4/19 15:11:56
C语言_函数结构体的调用
C语言_函数结构体的调用#include<stdio.h> //定义存储函数的结构体 struct map{//定义无参数类型返回void的函数指针void (*p)(); }; /** 通过实验观察系统如何处理整数上溢，浮点数上溢和浮点数下溢*/ void one(); //编写一个程序，要求提示输入一个ASCIL码值，然后打印…...
2024/4/20 11:16:53
关于bundle id的一些说法
1. ㄧ般而言，App ID 都會以"*"結尾，例如: com.yourcompanyname.appname.* 或是乾脆只有 "*" 。如此ㄧ來，單ㄧApp ID就可以延伸出許多Bundle ID，例如: com.yourcompanyname.appname.projectname1 ; com.yourcompanyname.appname.projectname2 .....…...
2024/4/28 2:33:52
zabbix使用api添加及删除主机
1.查看zabbix监控系统的api接口在可以访问Zabbix内部的任何数据之前，需要登录并获得身份验证令牌。这可以使用user.login方法来完成。假想以标准Zabbix的Admin用户登录。那么JSON请求将是这样的：[root@server5 ~]# vim zabbix-api.shcurl -s -X POST -H Content-Type:applica…...
2024/4/17 11:45:56
手动制作mac电脑的windows安装盘,不通过系统的bootcamp
如果想在Mac上安装windows系统,通常我们是使用macOS系统自带的bootcamp工具,通过iso映像,下载windows支持软件来制作系统安装盘.但是如果电脑的macOS系统已经损坏,重新安装windows系统将会变得很麻烦. 博主分析了一下安装盘的内容,发现可以通过手动下载bootcamp文件的方式,在wi…...
2024/4/20 5:26:32
C语言的函数调用约定（stdcall+cdecl+thiscall+fastcall）
在C语言中，假设我们有这样的一个函数：int function(int a,int b)调用时只要用result = function(1,2)这样的方式就可以使用这个函数。但是，当高级语言被编译成计算机可以识别的机器码时，有一个问题就凸现出来：在CPU中，计算机没有办法知道一个函数调用需要多少个、什么样…...
2024/4/27 23:45:30
RPG手机游戏道具、物品、装备表设计
###一、游戏物品/道具系统数据模型设计特点为了让游戏更加的丰富，我们1201团队的新手机游戏设计了道具系统。于是丰富了游戏、取悦了玩家，哭了开发——道具/物品数据子系统是简单的、复杂的、不确定的： 1. 简单，说起来不就是选择一个或多个数据库产品，然后定义一种数据模…...
2024/4/19 12:54:30
安装laravel-admin
最近放假在家没事做，博主想到用laravel-admin做一个管理后台，将安装过程以及过程中遇到的坑向大家分享下，避免大家遇坑。在安装前我们先修改两点，等下在安装过程中会报错，所以我们将先修改这两点，避免遇坑，打开以下路径：config/database.php，我们找到mysql的配置，修改…...
2024/3/31 19:44:25
C语言基础知识：C语言函数调用怎么返回两个值
在C语言中，函数只能返回一个值，要返回两个值，可以改换思路，通过其它方式做到。1 建立数组，返回指针。在要返回的两个值类型相同时，可以用创建数组的方式，将要返回的值存在数组中，并返回数组首地址，这样就可以实现返回两个值的效果。需要注意的是，要返回数组首地址，…...
2024/4/19 4:30:06
java zip文件的多层级遍历和文件夹下目录的问题
java zip文件的多层级遍历和文件夹下目录的问题 package com.hgh.zip;import java.io.BufferedInputStream; import java.io.File; import java.io.FileInputStream; import java.io.FileOutputStream; import java.io.InputStream; import java.io.InputStreamReader; import …...
2024/4/19 4:19:34
RESTful API（三）——使用Swagger 2构建RESTful API文档
一、传统API接口文档存在问题 1、由于接口众多，并且细节复杂（需要考虑不同的HTTP请求类型、HTTP头部信息、HTTP请求内容等），高质量地创建这份文档本身就是件非常吃力的事，下游的抱怨声不绝于耳。 2、随着时间推移，不断修改接口实现的时候都必须同步修改接口文档，而文档与…...
2024/4/19 12:11:53
静态分析C语言生成函数调用关系的利器——cflow
除了《静态分析C语言生成函数调用关系的利器——calltree》一文中介绍的calltree，我们还可以借助cflow辅助我们阅读理解代码。（转载请指明出于breaksoftware的csdn博客）cflow的说明和安装 cflow是一款静态分析C语言代码的工具，通过它可以生成函数的调用关系。和call…...
2024/4/17 11:47:09
将多个文件重命名并放入压缩文件中
/*** 定义压缩包*/ String downloadFilename = "压缩包名称.zip"; downloadFilename = URLEncoder.encode(downloadFilename, "UTF-8"); response.setContentType("application/octet-stream"); response.setHeader("Content-Disposition&q…...
2024/4/17 11:45:51
inno setup制作安装软件防止重复安装源代码
INNO：检测程序是否已经安装，是则弹出卸载提示实现原理：探测注册表HKEY_LOCAL_MACHINE, SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall（即“添加/删除程序”）中的卸载项目，若检测到则启动卸载确认对话框。在实际应用的时候，各位需要将上面代码中“{86D79F54-E…...
2024/4/18 22:38:16
C语言函数参数和调用函数
如果函数要使用参数，则必须声明接受参数值的变量。这些变量称为函数的形式参数。形式参数在进入函数时被创建，退出函数时被销毁。当调用函数时，有两种向函数传递参数的方式：传值方式调用函数默认情况下，C 语言使用传值调用方法来传递参数。一般来说，这意味着函数内的代…...
2024/4/17 11:46:57
Hbase新旧api对比
HBase1.0.1.1 API与原来有所不同1 package com.felix.hbaseapi_test;2 3 /* 这是旧版的 API操作 */ 16 public class hbaseapifelix { 17 18 public static final String TABLE_NAME = "testapi"; 19 public static final String COLUMNFAMILY…...
2024/4/18 4:44:15
2013 Mac Air 装Win7双系统问题－安装程序无法创建新的分区，也无法定位系统 & Windows无法安装所需的文件，错误代码0x80070570
此非主讲安装过程，主说明过程中遇到的两个问题自己的解决方式。准备：准备以下Win7纯净版iso镜像，用Boot Camp方式安装Windows到16GU盘.Win7纯净版资源问题一： Boot Camp开始分区安装后，进放Windows安装界面，在加载完之前下的驱动和点南完格式化选项后显示：安装程序无…...
2024/4/17 11:46:50
ZipInputStream 解压zip java.lang.IllegalArgumentException: MALFORMED 错误
1.压缩解压ZIP文件对文件名都是以UTF-8编码方式来处理的，而WinZip对文件名只会以ASCII编码方式来处理原代码:ZipInputStream zis = new ZipInputStream(in);jdk1.7：ZipInputStream(InputStream in, Charset) 增加GBK编码：ZipInputStream zis = new ZipInputStream(in,Charse…...
2024/4/19 9:07:43

SWIFT API 使用文档

相关文章

最新文章