v20190318

package
v1.0.935 Latest Latest
Warning

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

Go to latest
Published: Jun 3, 2024 License: Apache-2.0 Imports: 7 Imported by: 2

Documentation

Index

Constants

View Source
const (

	// 数据库操作异常
	FAILEDOPERATION_DBOPERATIONFAILED = "FailedOperation.DbOperationFailed"

	// 系统内部错误
	FAILEDOPERATION_SYSTEMERROR = "FailedOperation.SystemError"

	// 内部错误
	INTERNALERROR_INTERNALERROR = "InternalError.InternalError"

	// 业务参数错误
	INVALIDPARAMETER_INVALIDPARAMETER = "InvalidParameter.InvalidParameter"

	// 参数为空
	MISSINGPARAMETER_EMPTYPARAM = "MissingParameter.EmptyParam"

	// 未提供有效的账号
	RESOURCENOTFOUND_ACCOUNTDOESNOTEXISTS = "ResourceNotFound.AccountDoesNotExists"

	// 请求的实例不存在
	RESOURCENOTFOUND_INSTANCENOTEXISTS = "ResourceNotFound.InstanceNotExists"

	// Cam鉴权失败
	UNAUTHORIZEDOPERATION_NOCAMAUTHED = "UnauthorizedOperation.NoCAMAuthed"
)
View Source
const APIVersion = "2019-03-18"

Variables

This section is empty.

Functions

This section is empty.

Types

type Client

type Client struct {
	common.Client
}

func NewClient

func NewClient(credential common.CredentialIface, region string, clientProfile *profile.ClientProfile) (client *Client, err error)

func NewClientWithSecretId

func NewClientWithSecretId(secretId, secretKey, region string) (client *Client, err error)

Deprecated

func (*Client) DescribeInstances

func (c *Client) DescribeInstances(request *DescribeInstancesRequest) (response *DescribeInstancesResponse, err error)

DescribeInstances 获取Cmem实例列表

可能返回的错误码:

FAILEDOPERATION_DBOPERATIONFAILED = "FailedOperation.DbOperationFailed"
FAILEDOPERATION_SYSTEMERROR = "FailedOperation.SystemError"
INTERNALERROR_INTERNALERROR = "InternalError.InternalError"
INVALIDPARAMETER_INVALIDPARAMETER = "InvalidParameter.InvalidParameter"
MISSINGPARAMETER_EMPTYPARAM = "MissingParameter.EmptyParam"
RESOURCENOTFOUND_ACCOUNTDOESNOTEXISTS = "ResourceNotFound.AccountDoesNotExists"
RESOURCENOTFOUND_INSTANCENOTEXISTS = "ResourceNotFound.InstanceNotExists"
UNAUTHORIZEDOPERATION_NOCAMAUTHED = "UnauthorizedOperation.NoCAMAuthed"

func (*Client) DescribeInstancesWithContext added in v1.0.324

func (c *Client) DescribeInstancesWithContext(ctx context.Context, request *DescribeInstancesRequest) (response *DescribeInstancesResponse, err error)

DescribeInstances 获取Cmem实例列表

可能返回的错误码:

FAILEDOPERATION_DBOPERATIONFAILED = "FailedOperation.DbOperationFailed"
FAILEDOPERATION_SYSTEMERROR = "FailedOperation.SystemError"
INTERNALERROR_INTERNALERROR = "InternalError.InternalError"
INVALIDPARAMETER_INVALIDPARAMETER = "InvalidParameter.InvalidParameter"
MISSINGPARAMETER_EMPTYPARAM = "MissingParameter.EmptyParam"
RESOURCENOTFOUND_ACCOUNTDOESNOTEXISTS = "ResourceNotFound.AccountDoesNotExists"
RESOURCENOTFOUND_INSTANCENOTEXISTS = "ResourceNotFound.InstanceNotExists"
UNAUTHORIZEDOPERATION_NOCAMAUTHED = "UnauthorizedOperation.NoCAMAuthed"

type DescribeInstancesRequest

type DescribeInstancesRequest struct {
	*tchttp.BaseRequest

	// 枚举范围: AddTimeStamp, InstanceName, ProjectId
	OrderBy *string `json:"OrderBy,omitnil,omitempty" name:"OrderBy"`

	// 查找的关键字
	SearchKeys []*string `json:"SearchKeys,omitnil,omitempty" name:"SearchKeys"`

	// 子网ID列表
	UniqSubnetIds []*string `json:"UniqSubnetIds,omitnil,omitempty" name:"UniqSubnetIds"`

	// VIP列表
	Vips []*string `json:"Vips,omitnil,omitempty" name:"Vips"`

	// 0倒序,1正序,默认倒序
	OrderType *int64 `json:"OrderType,omitnil,omitempty" name:"OrderType"`

	// 实例名称列表
	InstanceNames []*string `json:"InstanceNames,omitnil,omitempty" name:"InstanceNames"`

	// VPC ID列表
	UniqVpcIds []*string `json:"UniqVpcIds,omitnil,omitempty" name:"UniqVpcIds"`

	// 项目ID列表
	ProjectIds []*int64 `json:"ProjectIds,omitnil,omitempty" name:"ProjectIds"`

	// 偏移量,取Limit整数倍
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 实例列表的大小,参数默认值100
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 实例ID列表
	InstanceIds []*string `json:"InstanceIds,omitnil,omitempty" name:"InstanceIds"`
}

func NewDescribeInstancesRequest

func NewDescribeInstancesRequest() (request *DescribeInstancesRequest)

func (*DescribeInstancesRequest) FromJsonString

func (r *DescribeInstancesRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeInstancesRequest) ToJsonString

func (r *DescribeInstancesRequest) ToJsonString() string

type DescribeInstancesRequestParams added in v1.0.426

type DescribeInstancesRequestParams struct {
	// 枚举范围: AddTimeStamp, InstanceName, ProjectId
	OrderBy *string `json:"OrderBy,omitnil,omitempty" name:"OrderBy"`

	// 查找的关键字
	SearchKeys []*string `json:"SearchKeys,omitnil,omitempty" name:"SearchKeys"`

	// 子网ID列表
	UniqSubnetIds []*string `json:"UniqSubnetIds,omitnil,omitempty" name:"UniqSubnetIds"`

	// VIP列表
	Vips []*string `json:"Vips,omitnil,omitempty" name:"Vips"`

	// 0倒序,1正序,默认倒序
	OrderType *int64 `json:"OrderType,omitnil,omitempty" name:"OrderType"`

	// 实例名称列表
	InstanceNames []*string `json:"InstanceNames,omitnil,omitempty" name:"InstanceNames"`

	// VPC ID列表
	UniqVpcIds []*string `json:"UniqVpcIds,omitnil,omitempty" name:"UniqVpcIds"`

	// 项目ID列表
	ProjectIds []*int64 `json:"ProjectIds,omitnil,omitempty" name:"ProjectIds"`

	// 偏移量,取Limit整数倍
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 实例列表的大小,参数默认值100
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 实例ID列表
	InstanceIds []*string `json:"InstanceIds,omitnil,omitempty" name:"InstanceIds"`
}

Predefined struct for user

type DescribeInstancesResponse

type DescribeInstancesResponse struct {
	*tchttp.BaseResponse
	Response *DescribeInstancesResponseParams `json:"Response"`
}

func NewDescribeInstancesResponse

func NewDescribeInstancesResponse() (response *DescribeInstancesResponse)

func (*DescribeInstancesResponse) FromJsonString

func (r *DescribeInstancesResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeInstancesResponse) ToJsonString

func (r *DescribeInstancesResponse) ToJsonString() string

type DescribeInstancesResponseParams added in v1.0.426

type DescribeInstancesResponseParams struct {
	// 实例详细信息列表
	InstanceList []*InstanceListInfo `json:"InstanceList,omitnil,omitempty" name:"InstanceList"`

	// 实例数量
	TotalNum *int64 `json:"TotalNum,omitnil,omitempty" name:"TotalNum"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type InstanceListInfo

type InstanceListInfo struct {
	// 实例修改时间
	ModTimeStamp *string `json:"ModTimeStamp,omitnil,omitempty" name:"ModTimeStamp"`

	// 实例隔离时间
	IsolateTimeStamp *string `json:"IsolateTimeStamp,omitnil,omitempty" name:"IsolateTimeStamp"`

	// 实例是否设置自动续费标识,1:设置自动续费;0:未设置自动续费
	AutoRenewFlag *int64 `json:"AutoRenewFlag,omitnil,omitempty" name:"AutoRenewFlag"`

	// 仓库ID
	SetId *int64 `json:"SetId,omitnil,omitempty" name:"SetId"`

	// 实例当前状态,0:发货中;1:运行中;2:创建失败;4:销毁中;5:隔离中;6:下线中
	Status *int64 `json:"Status,omitnil,omitempty" name:"Status"`

	// 实例内置ID
	CmemId *int64 `json:"CmemId,omitnil,omitempty" name:"CmemId"`

	// 实例关联的标签信息
	// 注意:此字段可能返回 null,表示取不到有效值。
	Tags []*TagInfo `json:"Tags,omitnil,omitempty" name:"Tags"`

	// 实例ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 地域id 1--广州 4--上海 5-- 香港 6--多伦多 7--上海金融 8--北京 9-- 新加坡 11--深圳金融 15--美西(硅谷)16--成都 17--德国 18--韩国 19--重庆 21--印度 22--美东(弗吉尼亚)23--泰国   25--日本
	RegionId *int64 `json:"RegionId,omitnil,omitempty" name:"RegionId"`

	// 实例描述信息
	InstanceDesc *string `json:"InstanceDesc,omitnil,omitempty" name:"InstanceDesc"`

	// 过期策略
	Expire *int64 `json:"Expire,omitnil,omitempty" name:"Expire"`

	// vpc网络下子网id 如:46315
	SubnetId *int64 `json:"SubnetId,omitnil,omitempty" name:"SubnetId"`

	// 项目ID
	ProjectId *int64 `json:"ProjectId,omitnil,omitempty" name:"ProjectId"`

	// 实例创建时间
	AddTimeStamp *string `json:"AddTimeStamp,omitnil,omitempty" name:"AddTimeStamp"`

	// 区域ID
	ZoneId *int64 `json:"ZoneId,omitnil,omitempty" name:"ZoneId"`

	// 计费模式:0-按量计费,1-包年包月
	PayMode *int64 `json:"PayMode,omitnil,omitempty" name:"PayMode"`

	// vpc网络id 如:75101
	VpcId *int64 `json:"VpcId,omitnil,omitempty" name:"VpcId"`

	// 实例名称
	InstanceName *string `json:"InstanceName,omitnil,omitempty" name:"InstanceName"`

	// 实例截止时间
	DeadlineTimeStamp *string `json:"DeadlineTimeStamp,omitnil,omitempty" name:"DeadlineTimeStamp"`

	// vpc网络id 如:vpc-fk33jsf43kgv
	UniqVpcId *string `json:"UniqVpcId,omitnil,omitempty" name:"UniqVpcId"`

	// 实例vip
	Vip *string `json:"Vip,omitnil,omitempty" name:"Vip"`

	// vpc网络下子网id 如:subnet-fd3j6l35mm0
	UniqSubnetId *string `json:"UniqSubnetId,omitnil,omitempty" name:"UniqSubnetId"`

	// 用户AppID
	AppId *int64 `json:"AppId,omitnil,omitempty" name:"AppId"`

	// 实例端口号
	Vport *int64 `json:"Vport,omitnil,omitempty" name:"Vport"`
}

type TagInfo

type TagInfo struct {
	// 标签键
	// 注意:此字段可能返回 null,表示取不到有效值。
	TagKey *string `json:"TagKey,omitnil,omitempty" name:"TagKey"`

	// 标签值
	// 注意:此字段可能返回 null,表示取不到有效值。
	TagValue *string `json:"TagValue,omitnil,omitempty" name:"TagValue"`
}

Jump to

Keyboard shortcuts

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