v2

package
v0.0.62 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 24, 2021 License: Apache-2.0, BSD-2-Clause, BSD-3-Clause Imports: 4 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GenReqDefForAddImageTag

func GenReqDefForAddImageTag() *def.HttpRequestDef

func GenReqDefForBatchAddMembers

func GenReqDefForBatchAddMembers() *def.HttpRequestDef

func GenReqDefForBatchAddOrDeleteTags

func GenReqDefForBatchAddOrDeleteTags() *def.HttpRequestDef

func GenReqDefForBatchDeleteMembers

func GenReqDefForBatchDeleteMembers() *def.HttpRequestDef

func GenReqDefForBatchUpdateMembers

func GenReqDefForBatchUpdateMembers() *def.HttpRequestDef

func GenReqDefForCopyImageCrossRegion

func GenReqDefForCopyImageCrossRegion() *def.HttpRequestDef

func GenReqDefForCopyImageInRegion

func GenReqDefForCopyImageInRegion() *def.HttpRequestDef

func GenReqDefForCreateDataImage

func GenReqDefForCreateDataImage() *def.HttpRequestDef

func GenReqDefForCreateImage

func GenReqDefForCreateImage() *def.HttpRequestDef

func GenReqDefForCreateOrUpdateTags

func GenReqDefForCreateOrUpdateTags() *def.HttpRequestDef

func GenReqDefForCreateWholeImage

func GenReqDefForCreateWholeImage() *def.HttpRequestDef

func GenReqDefForDeleteImageTag

func GenReqDefForDeleteImageTag() *def.HttpRequestDef

func GenReqDefForExportImage

func GenReqDefForExportImage() *def.HttpRequestDef

func GenReqDefForGlanceAddImageMember

func GenReqDefForGlanceAddImageMember() *def.HttpRequestDef

func GenReqDefForGlanceCreateImageMetadata

func GenReqDefForGlanceCreateImageMetadata() *def.HttpRequestDef

func GenReqDefForGlanceCreateTag

func GenReqDefForGlanceCreateTag() *def.HttpRequestDef

func GenReqDefForGlanceDeleteImage

func GenReqDefForGlanceDeleteImage() *def.HttpRequestDef

func GenReqDefForGlanceDeleteImageMember

func GenReqDefForGlanceDeleteImageMember() *def.HttpRequestDef

func GenReqDefForGlanceDeleteTag

func GenReqDefForGlanceDeleteTag() *def.HttpRequestDef

func GenReqDefForGlanceListImageMemberSchemas

func GenReqDefForGlanceListImageMemberSchemas() *def.HttpRequestDef

func GenReqDefForGlanceListImageMembers

func GenReqDefForGlanceListImageMembers() *def.HttpRequestDef

func GenReqDefForGlanceListImageSchemas

func GenReqDefForGlanceListImageSchemas() *def.HttpRequestDef

func GenReqDefForGlanceListImages

func GenReqDefForGlanceListImages() *def.HttpRequestDef

func GenReqDefForGlanceShowImage

func GenReqDefForGlanceShowImage() *def.HttpRequestDef

func GenReqDefForGlanceShowImageMember

func GenReqDefForGlanceShowImageMember() *def.HttpRequestDef

func GenReqDefForGlanceShowImageMemberSchemas

func GenReqDefForGlanceShowImageMemberSchemas() *def.HttpRequestDef

func GenReqDefForGlanceShowImageSchemas

func GenReqDefForGlanceShowImageSchemas() *def.HttpRequestDef

func GenReqDefForGlanceUpdateImage

func GenReqDefForGlanceUpdateImage() *def.HttpRequestDef

func GenReqDefForGlanceUpdateImageMember

func GenReqDefForGlanceUpdateImageMember() *def.HttpRequestDef

func GenReqDefForImportImageQuick

func GenReqDefForImportImageQuick() *def.HttpRequestDef

func GenReqDefForListImageByTags

func GenReqDefForListImageByTags() *def.HttpRequestDef

func GenReqDefForListImageTags

func GenReqDefForListImageTags() *def.HttpRequestDef

func GenReqDefForListImages

func GenReqDefForListImages() *def.HttpRequestDef

func GenReqDefForListImagesTags

func GenReqDefForListImagesTags() *def.HttpRequestDef

func GenReqDefForListOsVersions

func GenReqDefForListOsVersions() *def.HttpRequestDef

func GenReqDefForListTags

func GenReqDefForListTags() *def.HttpRequestDef

func GenReqDefForRegisterImage

func GenReqDefForRegisterImage() *def.HttpRequestDef

func GenReqDefForShowImageQuota

func GenReqDefForShowImageQuota() *def.HttpRequestDef

func GenReqDefForShowJob

func GenReqDefForShowJob() *def.HttpRequestDef

func GenReqDefForUpdateImage

func GenReqDefForUpdateImage() *def.HttpRequestDef

func ImsClientBuilder

func ImsClientBuilder() *http_client.HcHttpClientBuilder

Types

type ImsClient

type ImsClient struct {
	HcClient *http_client.HcHttpClient
}

func NewImsClient

func NewImsClient(hcClient *http_client.HcHttpClient) *ImsClient

func (*ImsClient) AddImageTag

func (c *ImsClient) AddImageTag(request *model.AddImageTagRequest) (*model.AddImageTagResponse, error)

该接口用于为指定镜像添加或更新指定的单个标签

func (*ImsClient) BatchAddMembers

func (c *ImsClient) BatchAddMembers(request *model.BatchAddMembersRequest) (*model.BatchAddMembersResponse, error)

该接口为扩展接口,主要用于镜像共享时用户将多个镜像共享给多个用户。 该接口为异步接口,返回job_id说明任务下发成功,查询异步任务状态,如果是success说明任务执行成功,如果是failed说明任务执行失败。如何查询异步任务,请参见异步任务查询。

func (*ImsClient) BatchAddOrDeleteTags

该接口用于为指定镜像批量添加/更新、删除标签。

func (*ImsClient) BatchDeleteMembers

func (c *ImsClient) BatchDeleteMembers(request *model.BatchDeleteMembersRequest) (*model.BatchDeleteMembersResponse, error)

该接口为扩展接口,主要用于取消镜像共享。 该接口为异步接口,返回job_id说明任务下发成功,查询异步任务状态,如果是success说明任务执行成功,如果是failed说明任务执行失败。如何查询异步任务,请参见异步任务查询。

func (*ImsClient) BatchUpdateMembers

func (c *ImsClient) BatchUpdateMembers(request *model.BatchUpdateMembersRequest) (*model.BatchUpdateMembersResponse, error)

该接口为扩展接口,主要用于用户接受或者拒绝多个共享镜像时批量更新镜像成员的状态。 该接口为异步接口,返回job_id说明任务下发成功,查询异步任务状态,如果是success说明任务执行成功,如果是failed说明任务执行失败。如何查询异步任务,请参见异步任务查询。

func (*ImsClient) CopyImageCrossRegion

该接口为扩展接口,用户在一个区域制作的私有镜像,可以通过跨Region复制镜像将镜像复制到其他区域,在其他区域发放相同类型的云服务器,帮助用户实现区域间的业务迁移。 该接口为异步接口,返回job_id说明任务下发成功,查询异步任务状态,如果是success说明任务执行成功,如果是failed说明任务执行失败。 如何查询异步任务,请参见异步任务进度查询。

func (*ImsClient) CopyImageInRegion

func (c *ImsClient) CopyImageInRegion(request *model.CopyImageInRegionRequest) (*model.CopyImageInRegionResponse, error)

该接口为扩展接口,主要用于用户将一个已有镜像复制为另一个镜像。复制镜像时,可以更改镜像的加密等属性,以满足不同的场景。 该接口为异步接口,返回job_id说明任务下发成功,查询异步任务状态,如果是success说明任务执行成功,如果是failed说明任务执行失败。如何查询异步任务,请参见异步任务查询。

func (*ImsClient) CreateDataImage

func (c *ImsClient) CreateDataImage(request *model.CreateDataImageRequest) (*model.CreateDataImageResponse, error)

使用上传至OBS桶中的外部数据卷镜像文件制作数据镜像。作为异步接口,调用成功,只是说明后台收到了制作请求,镜像是否制作成功需要通过异步任务查询接口查询该任务的执行状态。具体请参考异步任务查询。

func (*ImsClient) CreateImage

func (c *ImsClient) CreateImage(request *model.CreateImageRequest) (*model.CreateImageResponse, error)

本接口用于制作私有镜像,支持: - 使用云服务器制作私有镜像。 - 使用上传至OBS桶中的外部镜像文件制作私有镜像。 - 使用数据卷制作系统盘镜像。 作为异步接口,调用成功,只是说明云平台收到了制作请求,镜像是否制作成功需要通过异步任务查询接口查询该任务的执行状态,具体请参考异步任务查询。 不同场景必选参数说明: - 使用云服务器制作镜像时的请求的必选参数:name,instance_id。 - 使用上传至OBS桶中的外部镜像文件时的请求必选参数:name,image_url,min_disk。 - 使用数据卷制作系统盘镜像时的请求必选参数:name,volume_id,os_version

func (*ImsClient) CreateOrUpdateTags

func (c *ImsClient) CreateOrUpdateTags(request *model.CreateOrUpdateTagsRequest) (*model.CreateOrUpdateTagsResponse, error)

该接口主要用于为某个镜像增加或修改一个自定义标签。通过自定义标签,用户可以将镜像进行分类。

func (*ImsClient) CreateWholeImage

func (c *ImsClient) CreateWholeImage(request *model.CreateWholeImageRequest) (*model.CreateWholeImageResponse, error)

使用云服务器或者云服务器备份制作整机镜像。作为异步接口,调用成功,只是说明后台收到了制作整机镜像的请求,镜像是否制作成功需要通过异步任务查询接口查询该任务的执行状态,具体请参考异步任务查询。

func (*ImsClient) DeleteImageTag

func (c *ImsClient) DeleteImageTag(request *model.DeleteImageTagRequest) (*model.DeleteImageTagResponse, error)

该接口用于为镜像删除指定的标签

func (*ImsClient) ExportImage

func (c *ImsClient) ExportImage(request *model.ExportImageRequest) (*model.ExportImageResponse, error)

该接口为扩展接口,用于用户将自己的私有镜像导出到指定的OBS桶中。

func (*ImsClient) GlanceAddImageMember

用户共享镜像给其他用户时,使用该接口向该镜像成员中添加接受镜像用户的项目ID。

func (*ImsClient) GlanceCreateImageMetadata

创建镜像元数据。调用创建镜像元数据接口成功后,只是创建了镜像的元数据,镜像对应的实际镜像文件并不存在

func (*ImsClient) GlanceCreateTag

func (c *ImsClient) GlanceCreateTag(request *model.GlanceCreateTagRequest) (*model.GlanceCreateTagResponse, error)

该接口主要用于为某个镜像添加一个自定义标签。通过自定义标签,用户可以将镜像进行分类。

func (*ImsClient) GlanceDeleteImage

func (c *ImsClient) GlanceDeleteImage(request *model.GlanceDeleteImageRequest) (*model.GlanceDeleteImageResponse, error)

该接口主要用于删除镜像,用户可以通过该接口将自己的私有镜像删除。

func (*ImsClient) GlanceDeleteImageMember

该接口用于取消对某个用户的镜像共享。

func (*ImsClient) GlanceDeleteTag

func (c *ImsClient) GlanceDeleteTag(request *model.GlanceDeleteTagRequest) (*model.GlanceDeleteTagResponse, error)

该接口主要用于删除某个镜像的自定义标签,通过该接口,用户可以将私有镜像中一些不用的标签删除。

func (*ImsClient) GlanceListImageMemberSchemas

该接口主要用于查询镜像成员列表视图,通过视图,用户可以了解到镜像成员包含哪些属性,同时也可以了解每个属性的数据类型。

func (*ImsClient) GlanceListImageMembers

该接口用于共享镜像过程中,获取接受该镜像的成员列表。

func (*ImsClient) GlanceListImageSchemas

该接口主要用于查询镜像列表视图,通过该接口用户可以了解到镜像列表的详细情况和数据结构。

func (*ImsClient) GlanceListImages

func (c *ImsClient) GlanceListImages(request *model.GlanceListImagesRequest) (*model.GlanceListImagesResponse, error)

获取镜像列表。 使用本接口查询镜像列表时,需要使用分页查询才能返回全部的镜像列表。 分页说明 分页是指返回一组镜像的一个子集,在返回的时候会存在下个子集的链接和首个子集的链接,默认返回的子集中数量为25,用户也可以通过使用limit和marker两个参数自己分页,指定返回子集中需要返回的数量。 响应中的参数first是查询首页的URL。next是查询下一页的URL。当查询镜像列表最后一页时,不存在next。

func (*ImsClient) GlanceShowImage

func (c *ImsClient) GlanceShowImage(request *model.GlanceShowImageRequest) (*model.GlanceShowImageResponse, error)

查询单个镜像详情,用户可以通过该接口查询单个私有或者公共镜像的详情

func (*ImsClient) GlanceShowImageMember

该接口主要用于镜像共享中查询某个镜像成员的详情。

func (*ImsClient) GlanceShowImageMemberSchemas

该接口主要用于查询镜像成员视图,通过视图,用户可以了解到镜像成员包含哪些属性,同时也可以了解每个属性的数据类型。

func (*ImsClient) GlanceShowImageSchemas

该接口主要用于查询镜像视图,通过视图,用户可以了解到镜像包含哪些属性,同时也可以了解每个属性的数据类型等。

func (*ImsClient) GlanceUpdateImage

func (c *ImsClient) GlanceUpdateImage(request *model.GlanceUpdateImageRequest) (*model.GlanceUpdateImageResponse, error)

修改镜像信息

func (*ImsClient) GlanceUpdateImageMember

用户接受或者拒绝共享镜像时,使用该接口更新镜像成员的状态。

func (*ImsClient) ImportImageQuick

func (c *ImsClient) ImportImageQuick(request *model.ImportImageQuickRequest) (*model.ImportImageQuickResponse, error)

使用上传至OBS桶中的超大外部镜像文件制作私有镜像,目前仅支持RAW或ZVHD2格式镜像文件。且要求镜像文件大小不能超过1TB。 由于快速导入功能要求提前转换镜像文件格式为RAW或ZVHD2格式,因此镜像文件小于128GB时推荐您优先使用常规的创建私有镜像的方式。 作为异步接口,调用成功,只是说明后台收到了制作请求,镜像是否制作成功需要通过异步任务查询接口查询该任务的执行状态,具体请参考异步任务查询。

func (*ImsClient) ListImageByTags

func (c *ImsClient) ListImageByTags(request *model.ListImageByTagsRequest) (*model.ListImageByTagsResponse, error)

该接口用于按标签或其他条件对镜像进行过滤或者计数使用。

func (*ImsClient) ListImageTags

func (c *ImsClient) ListImageTags(request *model.ListImageTagsRequest) (*model.ListImageTagsResponse, error)

该接口用于为查询指定镜像上的所有标签

func (*ImsClient) ListImages

func (c *ImsClient) ListImages(request *model.ListImagesRequest) (*model.ListImagesResponse, error)

根据不同条件查询镜像列表信息。 可以在URI后面用‘?’和‘&’添加不同的查询条件组合,请参考请求样例。

func (*ImsClient) ListImagesTags

func (c *ImsClient) ListImagesTags(request *model.ListImagesTagsRequest) (*model.ListImagesTagsResponse, error)

该接口用于为查询租户的所有镜像上的标签。

func (*ImsClient) ListOsVersions

func (c *ImsClient) ListOsVersions(request *model.ListOsVersionsRequest) (*model.ListOsVersionsResponse, error)

查询当前区域弹性云服务器的OS兼容性列表。

func (*ImsClient) ListTags

func (c *ImsClient) ListTags(request *model.ListTagsRequest) (*model.ListTagsResponse, error)

根据不同条件查询镜像标签列表信息。

func (*ImsClient) RegisterImage

func (c *ImsClient) RegisterImage(request *model.RegisterImageRequest) (*model.RegisterImageResponse, error)

该接口用于将镜像文件注册为云平台未初始化的私有镜像。 使用该接口注册镜像的具体步骤如下: 将镜像文件上传到OBS个人桶中。具体操作请参见《对象存储服务客户端指南(OBS Browser)》或《对象存储服务API参考》。 使用创建镜像元数据接口创建镜像元数据。调用成功后,保存该镜像的ID。创建镜像元数据请参考创建镜像元数据(OpenStack原生)。 根据2得到的镜像ID,使用注册镜像接口注册OBS桶中的镜像文件。 注册镜像接口作为异步接口,调用成功后,说明后台收到了注册请求。需要根据镜像ID查询该镜像状态验证镜像注册是否成功。当镜像状态变为“active”时,表示镜像注册成功。 如何查询异步任务,请参见异步任务查询。

func (*ImsClient) ShowImageQuota

func (c *ImsClient) ShowImageQuota(request *model.ShowImageQuotaRequest) (*model.ShowImageQuotaResponse, error)

该接口为扩展接口,主要用于查询租户在当前Region的私有镜像的配额数量。

func (*ImsClient) ShowJob

func (c *ImsClient) ShowJob(request *model.ShowJobRequest) (*model.ShowJobResponse, error)

该接口为扩展接口,主要用于查询异步接口执行情况,比如查询导出镜像任务的执行状态。

func (*ImsClient) UpdateImage

func (c *ImsClient) UpdateImage(request *model.UpdateImageRequest) (*model.UpdateImageResponse, error)

更新镜像信息接口,主要用于镜像属性的修改。当前仅支持可用(active)状态的镜像更新相关信息。

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL