apis

package
v1.34.0 Latest Latest
Warning

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

Go to latest
Published: Jul 9, 2020 License: Apache-2.0 Imports: 2 Imported by: 12

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CreateAlarmRequest

type CreateAlarmRequest struct {
	core.JDCloudRequest

	/* 弹性伸缩组Id。注:仅ag\asg产品线内部使用 (Optional) */
	AutoScalingPolicyId *string `json:"autoScalingPolicyId"`

	/* 告警通知联系人 (Optional) */
	BaseContact []monitor.BaseContact `json:"baseContact"`

	/* 幂等性校验参数,最长36位,若两个请求clientToken相等,则返回第一次创建的规则id,只创建一次规则  */
	ClientToken string `json:"clientToken"`

	/* 资源维度,可用的维度请使用 describeProductsForAlarm接口查询 (Optional) */
	Dimension *string `json:"dimension"`

	/* 是否启用, 1表示启用规则,0表示禁用规则,默认为1 (Optional) */
	Enabled *int64 `json:"enabled"`

	/* 通知策略 (Optional) */
	NoticeOption []monitor.NoticeOption `json:"noticeOption"`

	/* 资源类型, 可用的资源类型列表请使用 describeProductsForAlarm接口查询。  */
	Product string `json:"product"`

	/*   */
	ResourceOption *monitor.ResourceOption `json:"resourceOption"`

	/* 规则名称,规则名称,最大长度42个字符,只允许中英文、数字、”-”和"_"  */
	RuleName string `json:"ruleName"`

	/*   */
	RuleOption *monitor.RuleOption `json:"ruleOption"`

	/* 规则类型, 默认为resourceMonitor (Optional) */
	RuleType *string `json:"ruleType"`

	/* 资源维度,指定监控数据实例的维度标签,如resourceId=id。(请确认资源的监控数据带有该标签,否则规则会报数据不足) (Optional) */
	Tags *interface{} `json:"tags"`

	/*  (Optional) */
	WebHookOption *monitor.WebHookOption `json:"webHookOption"`
}

func NewCreateAlarmRequest

func NewCreateAlarmRequest(
	clientToken string,
	product string,
	resourceOption *monitor.ResourceOption,
	ruleName string,
	ruleOption *monitor.RuleOption,
) *CreateAlarmRequest

* param clientToken: 幂等性校验参数,最长36位,若两个请求clientToken相等,则返回第一次创建的规则id,只创建一次规则 (Required) * param product: 资源类型, 可用的资源类型列表请使用 describeProductsForAlarm接口查询。 (Required) * param resourceOption: (Required) * param ruleName: 规则名称,规则名称,最大长度42个字符,只允许中英文、数字、”-”和"_" (Required) * param ruleOption: (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewCreateAlarmRequestWithAllParams added in v1.0.7

func NewCreateAlarmRequestWithAllParams(
	autoScalingPolicyId *string,
	baseContact []monitor.BaseContact,
	clientToken string,
	dimension *string,
	enabled *int64,
	noticeOption []monitor.NoticeOption,
	product string,
	resourceOption *monitor.ResourceOption,
	ruleName string,
	ruleOption *monitor.RuleOption,
	ruleType *string,
	tags *interface{},
	webHookOption *monitor.WebHookOption,
) *CreateAlarmRequest

* param autoScalingPolicyId: 弹性伸缩组Id。注:仅ag\asg产品线内部使用 (Optional) * param baseContact: 告警通知联系人 (Optional) * param clientToken: 幂等性校验参数,最长36位,若两个请求clientToken相等,则返回第一次创建的规则id,只创建一次规则 (Required) * param dimension: 资源维度,可用的维度请使用 describeProductsForAlarm接口查询 (Optional) * param enabled: 是否启用, 1表示启用规则,0表示禁用规则,默认为1 (Optional) * param noticeOption: 通知策略 (Optional) * param product: 资源类型, 可用的资源类型列表请使用 describeProductsForAlarm接口查询。 (Required) * param resourceOption: (Required) * param ruleName: 规则名称,规则名称,最大长度42个字符,只允许中英文、数字、”-”和"_" (Required) * param ruleOption: (Required) * param ruleType: 规则类型, 默认为resourceMonitor (Optional) * param tags: 资源维度,指定监控数据实例的维度标签,如resourceId=id。(请确认资源的监控数据带有该标签,否则规则会报数据不足) (Optional) * param webHookOption: (Optional)

func NewCreateAlarmRequestWithoutParam added in v1.0.7

func NewCreateAlarmRequestWithoutParam() *CreateAlarmRequest

This constructor has better compatible ability when API parameters changed

func (CreateAlarmRequest) GetRegionId

func (r CreateAlarmRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*CreateAlarmRequest) SetAutoScalingPolicyId added in v1.16.0

func (r *CreateAlarmRequest) SetAutoScalingPolicyId(autoScalingPolicyId string)

param autoScalingPolicyId: 弹性伸缩组Id。注:仅ag\asg产品线内部使用(Optional)

func (*CreateAlarmRequest) SetBaseContact added in v1.13.0

func (r *CreateAlarmRequest) SetBaseContact(baseContact []monitor.BaseContact)

param baseContact: 告警通知联系人(Optional)

func (*CreateAlarmRequest) SetClientToken

func (r *CreateAlarmRequest) SetClientToken(clientToken string)

param clientToken: 幂等性校验参数,最长36位,若两个请求clientToken相等,则返回第一次创建的规则id,只创建一次规则(Required)

func (*CreateAlarmRequest) SetDimension added in v1.13.0

func (r *CreateAlarmRequest) SetDimension(dimension string)

param dimension: 资源维度,可用的维度请使用 describeProductsForAlarm接口查询(Optional)

func (*CreateAlarmRequest) SetEnabled added in v1.13.0

func (r *CreateAlarmRequest) SetEnabled(enabled int64)

param enabled: 是否启用, 1表示启用规则,0表示禁用规则,默认为1(Optional)

func (*CreateAlarmRequest) SetNoticeOption added in v1.13.0

func (r *CreateAlarmRequest) SetNoticeOption(noticeOption []monitor.NoticeOption)

param noticeOption: 通知策略(Optional)

func (*CreateAlarmRequest) SetProduct added in v1.13.0

func (r *CreateAlarmRequest) SetProduct(product string)

param product: 资源类型, 可用的资源类型列表请使用 describeProductsForAlarm接口查询。(Required)

func (*CreateAlarmRequest) SetResourceOption added in v1.13.0

func (r *CreateAlarmRequest) SetResourceOption(resourceOption *monitor.ResourceOption)

param resourceOption: (Required)

func (*CreateAlarmRequest) SetRuleName added in v1.13.0

func (r *CreateAlarmRequest) SetRuleName(ruleName string)

param ruleName: 规则名称,规则名称,最大长度42个字符,只允许中英文、数字、”-”和"_"(Required)

func (*CreateAlarmRequest) SetRuleOption added in v1.13.0

func (r *CreateAlarmRequest) SetRuleOption(ruleOption *monitor.RuleOption)

param ruleOption: (Required)

func (*CreateAlarmRequest) SetRuleType added in v1.13.0

func (r *CreateAlarmRequest) SetRuleType(ruleType string)

param ruleType: 规则类型, 默认为resourceMonitor(Optional)

func (*CreateAlarmRequest) SetTags added in v1.13.0

func (r *CreateAlarmRequest) SetTags(tags interface{})

param tags: 资源维度,指定监控数据实例的维度标签,如resourceId=id。(请确认资源的监控数据带有该标签,否则规则会报数据不足)(Optional)

func (*CreateAlarmRequest) SetWebHookOption added in v1.13.0

func (r *CreateAlarmRequest) SetWebHookOption(webHookOption *monitor.WebHookOption)

param webHookOption: (Optional)

type CreateAlarmResponse

type CreateAlarmResponse struct {
	RequestID string             `json:"requestId"`
	Error     core.ErrorResponse `json:"error"`
	Result    CreateAlarmResult  `json:"result"`
}

type CreateAlarmResult

type CreateAlarmResult struct {
	AlarmId string  `json:"alarmId"`
	RuleIds []int64 `json:"ruleIds"`
}

type DeleteAlarmsRequest

type DeleteAlarmsRequest struct {
	core.JDCloudRequest

	/* 规则id  */
	AlarmId string `json:"alarmId"`
}

func NewDeleteAlarmsRequest

func NewDeleteAlarmsRequest(
	alarmId string,
) *DeleteAlarmsRequest

* param alarmId: 规则id (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDeleteAlarmsRequestWithAllParams added in v1.0.7

func NewDeleteAlarmsRequestWithAllParams(
	alarmId string,
) *DeleteAlarmsRequest

* param alarmId: 规则id (Required)

func NewDeleteAlarmsRequestWithoutParam added in v1.0.7

func NewDeleteAlarmsRequestWithoutParam() *DeleteAlarmsRequest

This constructor has better compatible ability when API parameters changed

func (DeleteAlarmsRequest) GetRegionId

func (r DeleteAlarmsRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DeleteAlarmsRequest) SetAlarmId added in v1.13.0

func (r *DeleteAlarmsRequest) SetAlarmId(alarmId string)

param alarmId: 规则id(Required)

type DeleteAlarmsResponse

type DeleteAlarmsResponse struct {
	RequestID string             `json:"requestId"`
	Error     core.ErrorResponse `json:"error"`
	Result    DeleteAlarmsResult `json:"result"`
}

type DeleteAlarmsResult

type DeleteAlarmsResult struct {
	Success bool `json:"success"`
}

type DescribeAlarmContactsRequest added in v1.1.1

type DescribeAlarmContactsRequest struct {
	core.JDCloudRequest

	/* 规则id  */
	AlarmId string `json:"alarmId"`

	/* 当前所在页,默认为1 (Optional) */
	PageNumber *int `json:"pageNumber"`

	/* 页面大小,默认为20;取值范围[1, 100] (Optional) */
	PageSize *int `json:"pageSize"`

	/* 联系人类型。0,联系人分组; 1,联系人 (Optional) */
	ReferenceType *int `json:"referenceType"`
}

func NewDescribeAlarmContactsRequest added in v1.1.1

func NewDescribeAlarmContactsRequest(
	alarmId string,
) *DescribeAlarmContactsRequest

* param alarmId: 规则id (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeAlarmContactsRequestWithAllParams added in v1.1.1

func NewDescribeAlarmContactsRequestWithAllParams(
	alarmId string,
	pageNumber *int,
	pageSize *int,
	referenceType *int,
) *DescribeAlarmContactsRequest

* param alarmId: 规则id (Required) * param pageNumber: 当前所在页,默认为1 (Optional) * param pageSize: 页面大小,默认为20;取值范围[1, 100] (Optional) * param referenceType: 联系人类型。0,联系人分组; 1,联系人 (Optional)

func NewDescribeAlarmContactsRequestWithoutParam added in v1.1.1

func NewDescribeAlarmContactsRequestWithoutParam() *DescribeAlarmContactsRequest

This constructor has better compatible ability when API parameters changed

func (DescribeAlarmContactsRequest) GetRegionId added in v1.1.1

func (r DescribeAlarmContactsRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeAlarmContactsRequest) SetAlarmId added in v1.1.1

func (r *DescribeAlarmContactsRequest) SetAlarmId(alarmId string)

param alarmId: 规则id(Required)

func (*DescribeAlarmContactsRequest) SetPageNumber added in v1.1.1

func (r *DescribeAlarmContactsRequest) SetPageNumber(pageNumber int)

param pageNumber: 当前所在页,默认为1(Optional)

func (*DescribeAlarmContactsRequest) SetPageSize added in v1.1.1

func (r *DescribeAlarmContactsRequest) SetPageSize(pageSize int)

param pageSize: 页面大小,默认为20;取值范围[1, 100](Optional)

func (*DescribeAlarmContactsRequest) SetReferenceType added in v1.1.1

func (r *DescribeAlarmContactsRequest) SetReferenceType(referenceType int)

param referenceType: 联系人类型。0,联系人分组; 1,联系人(Optional)

type DescribeAlarmContactsResponse added in v1.1.1

type DescribeAlarmContactsResponse struct {
	RequestID string                      `json:"requestId"`
	Error     core.ErrorResponse          `json:"error"`
	Result    DescribeAlarmContactsResult `json:"result"`
}

type DescribeAlarmContactsResult added in v1.1.1

type DescribeAlarmContactsResult struct {
	ContactsList []monitor.DescribedNoticeContacts `json:"contactsList"`
	Total        int64                             `json:"total"`
}

type DescribeAlarmHistoryRequest

type DescribeAlarmHistoryRequest struct {
	core.JDCloudRequest

	/* 当前所在页,默认为1 (Optional) */
	PageNumber *int `json:"pageNumber"`

	/* 页面大小,默认为20;取值范围[1, 100] (Optional) */
	PageSize *int `json:"pageSize"`

	/* 产品线标识,同一个产品线下可能存在多个product,如(redis下有redis2.8cluster、redis4.0) (Optional) */
	ServiceCode *string `json:"serviceCode"`

	/* 产品标识,默认返回该product下所有dimension的数据。eg:product=redis2.8cluster(redis2.8cluster产品下包含redis2.8-shard与redis2.8-proxy、redis2.8-instance多个维度)。 (Optional) */
	Product *string `json:"product"`

	/* 维度标识、指定该参数时,查询只返回该维度的数据。如redis2.8cluster下存在实例、分片等多个维度 (Optional) */
	Dimension *string `json:"dimension"`

	/* 根据region筛选对应region的资源的报警历史 (Optional) */
	Region *string `json:"region"`

	/* 正在报警, 取值为1 (Optional) */
	IsAlarming *int `json:"isAlarming"`

	/* 报警的状态,1为报警恢复、2为报警、4为报警恢复无数据 (Optional) */
	Status *int `json:"status"`

	/* 开始时间 (Optional) */
	StartTime *string `json:"startTime"`

	/* 结束时间 (Optional) */
	EndTime *string `json:"endTime"`

	/* 规则类型,默认查询1, 1表示资源监控,6表示站点监控,7表示可用性监控 (Optional) */
	RuleType *int `json:"ruleType"`

	/* 规则名称模糊搜索 (Optional) */
	RuleName *string `json:"ruleName"`

	/* serviceCodes - 产品线servicecode,精确匹配,支持多个
	resourceIds - 资源Id,精确匹配,支持多个(必须指定serviceCode才会在该serviceCode下根据resourceIds过滤,否则该参数不生效)
	alarmIds - 规则Id,精确匹配,支持多个 (Optional) */
	Filters []monitor.Filter `json:"filters"`
}

func NewDescribeAlarmHistoryRequest

func NewDescribeAlarmHistoryRequest() *DescribeAlarmHistoryRequest

* * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeAlarmHistoryRequestWithAllParams added in v1.0.7

func NewDescribeAlarmHistoryRequestWithAllParams(
	pageNumber *int,
	pageSize *int,
	serviceCode *string,
	product *string,
	dimension *string,
	region *string,
	isAlarming *int,
	status *int,
	startTime *string,
	endTime *string,
	ruleType *int,
	ruleName *string,
	filters []monitor.Filter,
) *DescribeAlarmHistoryRequest
  • param pageNumber: 当前所在页,默认为1 (Optional)
  • param pageSize: 页面大小,默认为20;取值范围[1, 100] (Optional)
  • param serviceCode: 产品线标识,同一个产品线下可能存在多个product,如(redis下有redis2.8cluster、redis4.0) (Optional)
  • param product: 产品标识,默认返回该product下所有dimension的数据。eg:product=redis2.8cluster(redis2.8cluster产品下包含redis2.8-shard与redis2.8-proxy、redis2.8-instance多个维度)。 (Optional)
  • param dimension: 维度标识、指定该参数时,查询只返回该维度的数据。如redis2.8cluster下存在实例、分片等多个维度 (Optional)
  • param region: 根据region筛选对应region的资源的报警历史 (Optional)
  • param isAlarming: 正在报警, 取值为1 (Optional)
  • param status: 报警的状态,1为报警恢复、2为报警、4为报警恢复无数据 (Optional)
  • param startTime: 开始时间 (Optional)
  • param endTime: 结束时间 (Optional)
  • param ruleType: 规则类型,默认查询1, 1表示资源监控,6表示站点监控,7表示可用性监控 (Optional)
  • param ruleName: 规则名称模糊搜索 (Optional)
  • param filters: serviceCodes - 产品线servicecode,精确匹配,支持多个

resourceIds - 资源Id,精确匹配,支持多个(必须指定serviceCode才会在该serviceCode下根据resourceIds过滤,否则该参数不生效) alarmIds - 规则Id,精确匹配,支持多个 (Optional)

func NewDescribeAlarmHistoryRequestWithoutParam added in v1.0.7

func NewDescribeAlarmHistoryRequestWithoutParam() *DescribeAlarmHistoryRequest

This constructor has better compatible ability when API parameters changed

func (DescribeAlarmHistoryRequest) GetRegionId

func (r DescribeAlarmHistoryRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeAlarmHistoryRequest) SetDimension added in v1.13.0

func (r *DescribeAlarmHistoryRequest) SetDimension(dimension string)

param dimension: 维度标识、指定该参数时,查询只返回该维度的数据。如redis2.8cluster下存在实例、分片等多个维度(Optional)

func (*DescribeAlarmHistoryRequest) SetEndTime

func (r *DescribeAlarmHistoryRequest) SetEndTime(endTime string)

param endTime: 结束时间(Optional)

func (*DescribeAlarmHistoryRequest) SetFilters added in v1.1.1

func (r *DescribeAlarmHistoryRequest) SetFilters(filters []monitor.Filter)
param filters: serviceCodes - 产品线servicecode,精确匹配,支持多个

resourceIds - 资源Id,精确匹配,支持多个(必须指定serviceCode才会在该serviceCode下根据resourceIds过滤,否则该参数不生效) alarmIds - 规则Id,精确匹配,支持多个(Optional)

func (*DescribeAlarmHistoryRequest) SetIsAlarming added in v1.13.0

func (r *DescribeAlarmHistoryRequest) SetIsAlarming(isAlarming int)

param isAlarming: 正在报警, 取值为1(Optional)

func (*DescribeAlarmHistoryRequest) SetPageNumber

func (r *DescribeAlarmHistoryRequest) SetPageNumber(pageNumber int)

param pageNumber: 当前所在页,默认为1(Optional)

func (*DescribeAlarmHistoryRequest) SetPageSize

func (r *DescribeAlarmHistoryRequest) SetPageSize(pageSize int)

param pageSize: 页面大小,默认为20;取值范围[1, 100](Optional)

func (*DescribeAlarmHistoryRequest) SetProduct added in v1.13.0

func (r *DescribeAlarmHistoryRequest) SetProduct(product string)

param product: 产品标识,默认返回该product下所有dimension的数据。eg:product=redis2.8cluster(redis2.8cluster产品下包含redis2.8-shard与redis2.8-proxy、redis2.8-instance多个维度)。(Optional)

func (*DescribeAlarmHistoryRequest) SetRegion added in v1.16.0

func (r *DescribeAlarmHistoryRequest) SetRegion(region string)

param region: 根据region筛选对应region的资源的报警历史(Optional)

func (*DescribeAlarmHistoryRequest) SetRuleName added in v1.13.0

func (r *DescribeAlarmHistoryRequest) SetRuleName(ruleName string)

param ruleName: 规则名称模糊搜索(Optional)

func (*DescribeAlarmHistoryRequest) SetRuleType added in v1.4.0

func (r *DescribeAlarmHistoryRequest) SetRuleType(ruleType int)

param ruleType: 规则类型,默认查询1, 1表示资源监控,6表示站点监控,7表示可用性监控(Optional)

func (*DescribeAlarmHistoryRequest) SetServiceCode

func (r *DescribeAlarmHistoryRequest) SetServiceCode(serviceCode string)

param serviceCode: 产品线标识,同一个产品线下可能存在多个product,如(redis下有redis2.8cluster、redis4.0)(Optional)

func (*DescribeAlarmHistoryRequest) SetStartTime

func (r *DescribeAlarmHistoryRequest) SetStartTime(startTime string)

param startTime: 开始时间(Optional)

func (*DescribeAlarmHistoryRequest) SetStatus added in v1.13.0

func (r *DescribeAlarmHistoryRequest) SetStatus(status int)

param status: 报警的状态,1为报警恢复、2为报警、4为报警恢复无数据(Optional)

type DescribeAlarmHistoryResponse

type DescribeAlarmHistoryResponse struct {
	RequestID string                     `json:"requestId"`
	Error     core.ErrorResponse         `json:"error"`
	Result    DescribeAlarmHistoryResult `json:"result"`
}

type DescribeAlarmHistoryResult

type DescribeAlarmHistoryResult struct {
	AlarmHistoryList []monitor.DescribedAlarmHistory `json:"alarmHistoryList"`
	NumberPages      int64                           `json:"numberPages"`
	NumberRecords    int64                           `json:"numberRecords"`
	PageNumber       int64                           `json:"pageNumber"`
	PageSize         int64                           `json:"pageSize"`
}

type DescribeAlarmRequest added in v1.13.0

type DescribeAlarmRequest struct {
	core.JDCloudRequest

	/* 规则id  */
	AlarmId string `json:"alarmId"`
}

func NewDescribeAlarmRequest added in v1.13.0

func NewDescribeAlarmRequest(
	alarmId string,
) *DescribeAlarmRequest

* param alarmId: 规则id (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeAlarmRequestWithAllParams added in v1.13.0

func NewDescribeAlarmRequestWithAllParams(
	alarmId string,
) *DescribeAlarmRequest

* param alarmId: 规则id (Required)

func NewDescribeAlarmRequestWithoutParam added in v1.13.0

func NewDescribeAlarmRequestWithoutParam() *DescribeAlarmRequest

This constructor has better compatible ability when API parameters changed

func (DescribeAlarmRequest) GetRegionId added in v1.13.0

func (r DescribeAlarmRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeAlarmRequest) SetAlarmId added in v1.13.0

func (r *DescribeAlarmRequest) SetAlarmId(alarmId string)

param alarmId: 规则id(Required)

type DescribeAlarmResponse added in v1.13.0

type DescribeAlarmResponse struct {
	RequestID string              `json:"requestId"`
	Error     core.ErrorResponse  `json:"error"`
	Result    DescribeAlarmResult `json:"result"`
}

type DescribeAlarmResult added in v1.13.0

type DescribeAlarmResult struct {
	AlarmId         string                   `json:"alarmId"`
	AlarmStatus     int64                    `json:"alarmStatus"`
	AlarmStatusList []int64                  `json:"alarmStatusList"`
	BaseContact     []monitor.BaseContact    `json:"baseContact"`
	CreateTime      string                   `json:"createTime"`
	Dimension       string                   `json:"dimension"`
	DimensionName   string                   `json:"dimensionName"`
	Enabled         int64                    `json:"enabled"`
	NoticeOption    []monitor.NoticeOption   `json:"noticeOption"`
	Product         string                   `json:"product"`
	ProductName     string                   `json:"productName"`
	ResourceOption  monitor.ResourceOption   `json:"resourceOption"`
	RuleName        string                   `json:"ruleName"`
	RuleOption      monitor.RuleOptionDetail `json:"ruleOption"`
	RuleType        string                   `json:"ruleType"`
	RuleVersion     string                   `json:"ruleVersion"`
	Tags            interface{}              `json:"tags"`
	WebHookOption   monitor.WebHookOption    `json:"webHookOption"`
}

type DescribeAlarmsRequest

type DescribeAlarmsRequest struct {
	core.JDCloudRequest

	/* 当前所在页,默认为1 (Optional) */
	PageNumber *int `json:"pageNumber"`

	/* 页面大小,默认为20;取值范围[1, 100] (Optional) */
	PageSize *int `json:"pageSize"`

	/* 产品线标识,同一个产品线下可能存在多个product,如(redis下有redis2.8cluster、redis4.0) (Optional) */
	ServiceCode *string `json:"serviceCode"`

	/* 产品标识,如redis下分多个产品(redis2.8cluster、redis4.0)。同时指定serviceCode与product时,product优先生效 (Optional) */
	Product *string `json:"product"`

	/* 产品下的维度标识,指定dimension时必须指定product (Optional) */
	Dimension *string `json:"dimension"`

	/* 规则名称 (Optional) */
	RuleName *string `json:"ruleName"`

	/* 规则类型, 1表示资源监控,6表示站点监控,7表示可用性监控 (Optional) */
	RuleType *int `json:"ruleType"`

	/* 规则状态:1为启用,0为禁用 (Optional) */
	Enabled *int `json:"enabled"`

	/* 资源的规则状态  2:报警、4:数据不足 (Optional) */
	RuleStatus *int `json:"ruleStatus"`

	/* 服务码或资源Id列表
	products - 产品product,精确匹配,支持多个
	resourceIds - 资源Id,精确匹配,支持多个(必须指定serviceCode、product或dimension,否则该参数不生效)
	alarmIds - 规则id,精确匹配,支持多个 (Optional) */
	Filters []monitor.Filter `json:"filters"`
}

func NewDescribeAlarmsRequest

func NewDescribeAlarmsRequest() *DescribeAlarmsRequest

* * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeAlarmsRequestWithAllParams added in v1.0.7

func NewDescribeAlarmsRequestWithAllParams(
	pageNumber *int,
	pageSize *int,
	serviceCode *string,
	product *string,
	dimension *string,
	ruleName *string,
	ruleType *int,
	enabled *int,
	ruleStatus *int,
	filters []monitor.Filter,
) *DescribeAlarmsRequest
  • param pageNumber: 当前所在页,默认为1 (Optional)
  • param pageSize: 页面大小,默认为20;取值范围[1, 100] (Optional)
  • param serviceCode: 产品线标识,同一个产品线下可能存在多个product,如(redis下有redis2.8cluster、redis4.0) (Optional)
  • param product: 产品标识,如redis下分多个产品(redis2.8cluster、redis4.0)。同时指定serviceCode与product时,product优先生效 (Optional)
  • param dimension: 产品下的维度标识,指定dimension时必须指定product (Optional)
  • param ruleName: 规则名称 (Optional)
  • param ruleType: 规则类型, 1表示资源监控,6表示站点监控,7表示可用性监控 (Optional)
  • param enabled: 规则状态:1为启用,0为禁用 (Optional)
  • param ruleStatus: 资源的规则状态 2:报警、4:数据不足 (Optional)
  • param filters: 服务码或资源Id列表

products - 产品product,精确匹配,支持多个 resourceIds - 资源Id,精确匹配,支持多个(必须指定serviceCode、product或dimension,否则该参数不生效) alarmIds - 规则id,精确匹配,支持多个 (Optional)

func NewDescribeAlarmsRequestWithoutParam added in v1.0.7

func NewDescribeAlarmsRequestWithoutParam() *DescribeAlarmsRequest

This constructor has better compatible ability when API parameters changed

func (DescribeAlarmsRequest) GetRegionId

func (r DescribeAlarmsRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeAlarmsRequest) SetDimension added in v1.13.0

func (r *DescribeAlarmsRequest) SetDimension(dimension string)

param dimension: 产品下的维度标识,指定dimension时必须指定product(Optional)

func (*DescribeAlarmsRequest) SetEnabled

func (r *DescribeAlarmsRequest) SetEnabled(enabled int)

param enabled: 规则状态:1为启用,0为禁用(Optional)

func (*DescribeAlarmsRequest) SetFilters added in v1.1.1

func (r *DescribeAlarmsRequest) SetFilters(filters []monitor.Filter)
param filters: 服务码或资源Id列表

products - 产品product,精确匹配,支持多个 resourceIds - 资源Id,精确匹配,支持多个(必须指定serviceCode、product或dimension,否则该参数不生效) alarmIds - 规则id,精确匹配,支持多个(Optional)

func (*DescribeAlarmsRequest) SetPageNumber

func (r *DescribeAlarmsRequest) SetPageNumber(pageNumber int)

param pageNumber: 当前所在页,默认为1(Optional)

func (*DescribeAlarmsRequest) SetPageSize

func (r *DescribeAlarmsRequest) SetPageSize(pageSize int)

param pageSize: 页面大小,默认为20;取值范围[1, 100](Optional)

func (*DescribeAlarmsRequest) SetProduct added in v1.13.0

func (r *DescribeAlarmsRequest) SetProduct(product string)

param product: 产品标识,如redis下分多个产品(redis2.8cluster、redis4.0)。同时指定serviceCode与product时,product优先生效(Optional)

func (*DescribeAlarmsRequest) SetRuleName added in v1.13.0

func (r *DescribeAlarmsRequest) SetRuleName(ruleName string)

param ruleName: 规则名称(Optional)

func (*DescribeAlarmsRequest) SetRuleStatus added in v1.13.0

func (r *DescribeAlarmsRequest) SetRuleStatus(ruleStatus int)

param ruleStatus: 资源的规则状态 2:报警、4:数据不足(Optional)

func (*DescribeAlarmsRequest) SetRuleType added in v1.1.1

func (r *DescribeAlarmsRequest) SetRuleType(ruleType int)

param ruleType: 规则类型, 1表示资源监控,6表示站点监控,7表示可用性监控(Optional)

func (*DescribeAlarmsRequest) SetServiceCode

func (r *DescribeAlarmsRequest) SetServiceCode(serviceCode string)

param serviceCode: 产品线标识,同一个产品线下可能存在多个product,如(redis下有redis2.8cluster、redis4.0)(Optional)

type DescribeAlarmsResponse

type DescribeAlarmsResponse struct {
	RequestID string               `json:"requestId"`
	Error     core.ErrorResponse   `json:"error"`
	Result    DescribeAlarmsResult `json:"result"`
}

type DescribeAlarmsResult

type DescribeAlarmsResult struct {
	AlarmList     []monitor.DescribeGroupAlarm `json:"alarmList"`
	NumberPages   int64                        `json:"numberPages"`
	NumberRecords int64                        `json:"numberRecords"`
	PageNumber    int64                        `json:"pageNumber"`
	PageSize      int64                        `json:"pageSize"`
}

type DescribeMetricDataRequest

type DescribeMetricDataRequest struct {
	core.JDCloudRequest

	/* 地域 Id  */
	RegionId string `json:"regionId"`

	/* 监控项英文标识(id)  */
	Metric string `json:"metric"`

	/* 聚合方式,用于不同时间轴上的聚合。如balance产品同一个resourceId下存在port=80和port=8080等多种维度。可选值参考:sum、avg、min、max (Optional) */
	AggrType *string `json:"aggrType"`

	/* 采样方式,用于在时间轴维度上将聚合周期内的数据聚合为一个点。可选值参考:sum(聚合周期内的数据求和)、avg(求平均)、last(最新值)、min(最小值)、max(最大值) (Optional) */
	DownSampleType *string `json:"downSampleType"`

	/* 查询时间范围的开始时间, UTC时间,格式:2016-12-11T00:00:00+0800(注意在url中+要转译为%2B故url中为2016-12-11T00:00:00%2B0800) (Optional) */
	StartTime *string `json:"startTime"`

	/* 查询时间范围的结束时间, UTC时间,格式:2016-12-11T00:00:00+0800(为空时,将由startTime与timeInterval计算得出)(注意在url中+要转译为%2B故url中为2016-12-11T00:00:00%2B0800) (Optional) */
	EndTime *string `json:"endTime"`

	/* 时间间隔:1h,6h,12h,1d,3d,7d,14d,固定时间间隔,timeInterval默认为1h,当前时间往 前1h (Optional) */
	TimeInterval *string `json:"timeInterval"`

	/* 监控指标数据的维度信息,根据tags来筛选指标数据不同的维度 (Optional) */
	Tags []monitor.TagFilter `json:"tags"`

	/* 是否对查询的tags分组 (Optional) */
	GroupBy *bool `json:"groupBy"`

	/* 是否求速率 (Optional) */
	Rate *bool `json:"rate"`

	/* 资源的类型,取值vm, lb, ip, database 等,<a href="https://docs.jdcloud.com/cn/monitoring/api/describeservices?content=API&SOP=JDCloud">describeServices</a>:查询己接入云监控的产品线列表 (Optional) */
	ServiceCode *string `json:"serviceCode"`

	/* 资源的维度。查询serviceCode下可用的维度请使用describeServices接口 (Optional) */
	Dimension *string `json:"dimension"`

	/* 资源的uuid  */
	ResourceId string `json:"resourceId"`
}

func NewDescribeMetricDataRequest

func NewDescribeMetricDataRequest(
	regionId string,
	metric string,
	resourceId string,
) *DescribeMetricDataRequest

* param regionId: 地域 Id (Required) * param metric: 监控项英文标识(id) (Required) * param resourceId: 资源的uuid (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeMetricDataRequestWithAllParams added in v1.0.7

func NewDescribeMetricDataRequestWithAllParams(
	regionId string,
	metric string,
	aggrType *string,
	downSampleType *string,
	startTime *string,
	endTime *string,
	timeInterval *string,
	tags []monitor.TagFilter,
	groupBy *bool,
	rate *bool,
	serviceCode *string,
	dimension *string,
	resourceId string,
) *DescribeMetricDataRequest

* param regionId: 地域 Id (Required) * param metric: 监控项英文标识(id) (Required) * param aggrType: 聚合方式,用于不同时间轴上的聚合。如balance产品同一个resourceId下存在port=80和port=8080等多种维度。可选值参考:sum、avg、min、max (Optional) * param downSampleType: 采样方式,用于在时间轴维度上将聚合周期内的数据聚合为一个点。可选值参考:sum(聚合周期内的数据求和)、avg(求平均)、last(最新值)、min(最小值)、max(最大值) (Optional) * param startTime: 查询时间范围的开始时间, UTC时间,格式:2016-12-11T00:00:00+0800(注意在url中+要转译为%2B故url中为2016-12-11T00:00:00%2B0800) (Optional) * param endTime: 查询时间范围的结束时间, UTC时间,格式:2016-12-11T00:00:00+0800(为空时,将由startTime与timeInterval计算得出)(注意在url中+要转译为%2B故url中为2016-12-11T00:00:00%2B0800) (Optional) * param timeInterval: 时间间隔:1h,6h,12h,1d,3d,7d,14d,固定时间间隔,timeInterval默认为1h,当前时间往 前1h (Optional) * param tags: 监控指标数据的维度信息,根据tags来筛选指标数据不同的维度 (Optional) * param groupBy: 是否对查询的tags分组 (Optional) * param rate: 是否求速率 (Optional) * param serviceCode: 资源的类型,取值vm, lb, ip, database 等,<a href="https://docs.jdcloud.com/cn/monitoring/api/describeservices?content=API&SOP=JDCloud">describeServices</a>:查询己接入云监控的产品线列表 (Optional) * param dimension: 资源的维度。查询serviceCode下可用的维度请使用describeServices接口 (Optional) * param resourceId: 资源的uuid (Required)

func NewDescribeMetricDataRequestWithoutParam added in v1.0.7

func NewDescribeMetricDataRequestWithoutParam() *DescribeMetricDataRequest

This constructor has better compatible ability when API parameters changed

func (DescribeMetricDataRequest) GetRegionId

func (r DescribeMetricDataRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeMetricDataRequest) SetAggrType added in v1.2.1

func (r *DescribeMetricDataRequest) SetAggrType(aggrType string)

param aggrType: 聚合方式,用于不同时间轴上的聚合。如balance产品同一个resourceId下存在port=80和port=8080等多种维度。可选值参考:sum、avg、min、max(Optional)

func (*DescribeMetricDataRequest) SetDimension added in v1.13.0

func (r *DescribeMetricDataRequest) SetDimension(dimension string)

param dimension: 资源的维度。查询serviceCode下可用的维度请使用describeServices接口(Optional)

func (*DescribeMetricDataRequest) SetDownSampleType added in v1.4.0

func (r *DescribeMetricDataRequest) SetDownSampleType(downSampleType string)

param downSampleType: 采样方式,用于在时间轴维度上将聚合周期内的数据聚合为一个点。可选值参考:sum(聚合周期内的数据求和)、avg(求平均)、last(最新值)、min(最小值)、max(最大值)(Optional)

func (*DescribeMetricDataRequest) SetEndTime

func (r *DescribeMetricDataRequest) SetEndTime(endTime string)

param endTime: 查询时间范围的结束时间, UTC时间,格式:2016-12-11T00:00:00+0800(为空时,将由startTime与timeInterval计算得出)(注意在url中+要转译为%2B故url中为2016-12-11T00:00:00%2B0800)(Optional)

func (*DescribeMetricDataRequest) SetGroupBy added in v1.1.1

func (r *DescribeMetricDataRequest) SetGroupBy(groupBy bool)

param groupBy: 是否对查询的tags分组(Optional)

func (*DescribeMetricDataRequest) SetMetric

func (r *DescribeMetricDataRequest) SetMetric(metric string)

param metric: 监控项英文标识(id)(Required)

func (*DescribeMetricDataRequest) SetRate added in v1.4.0

func (r *DescribeMetricDataRequest) SetRate(rate bool)

param rate: 是否求速率(Optional)

func (*DescribeMetricDataRequest) SetRegionId

func (r *DescribeMetricDataRequest) SetRegionId(regionId string)

param regionId: 地域 Id(Required)

func (*DescribeMetricDataRequest) SetResourceId

func (r *DescribeMetricDataRequest) SetResourceId(resourceId string)

param resourceId: 资源的uuid(Required)

func (*DescribeMetricDataRequest) SetServiceCode

func (r *DescribeMetricDataRequest) SetServiceCode(serviceCode string)

param serviceCode: 资源的类型,取值vm, lb, ip, database 等,<a href="https://docs.jdcloud.com/cn/monitoring/api/describeservices?content=API&SOP=JDCloud">describeServices</a>:查询己接入云监控的产品线列表(Optional)

func (*DescribeMetricDataRequest) SetStartTime

func (r *DescribeMetricDataRequest) SetStartTime(startTime string)

param startTime: 查询时间范围的开始时间, UTC时间,格式:2016-12-11T00:00:00+0800(注意在url中+要转译为%2B故url中为2016-12-11T00:00:00%2B0800)(Optional)

func (*DescribeMetricDataRequest) SetTags added in v1.0.2

func (r *DescribeMetricDataRequest) SetTags(tags []monitor.TagFilter)

param tags: 监控指标数据的维度信息,根据tags来筛选指标数据不同的维度(Optional)

func (*DescribeMetricDataRequest) SetTimeInterval

func (r *DescribeMetricDataRequest) SetTimeInterval(timeInterval string)

param timeInterval: 时间间隔:1h,6h,12h,1d,3d,7d,14d,固定时间间隔,timeInterval默认为1h,当前时间往 前1h(Optional)

type DescribeMetricDataResponse

type DescribeMetricDataResponse struct {
	RequestID string                   `json:"requestId"`
	Error     core.ErrorResponse       `json:"error"`
	Result    DescribeMetricDataResult `json:"result"`
}

type DescribeMetricDataResult

type DescribeMetricDataResult struct {
	MetricDatas []monitor.MetricData `json:"metricDatas"`
}

type DescribeMetricsForAlarmRequest added in v1.13.0

type DescribeMetricsForAlarmRequest struct {
	core.JDCloudRequest

	/* 产品线 (Optional) */
	ServiceCode *string `json:"serviceCode"`

	/* 产品类型,如redis2.8cluster(集群)\redis2.8MS(主从)。当serviceCode与product同时指定时,product优先级更高 (Optional) */
	Product *string `json:"product"`

	/* 产品维度,必须指定serviceCode或product才生效。 (Optional) */
	Dimension *string `json:"dimension"`

	/* metric类型,取值0、1;默认值:0(常规指标,用于控制台创建报警规则)、1(其它) (Optional) */
	MetricType *int `json:"metricType"`
}

func NewDescribeMetricsForAlarmRequest added in v1.13.0

func NewDescribeMetricsForAlarmRequest() *DescribeMetricsForAlarmRequest

* * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeMetricsForAlarmRequestWithAllParams added in v1.13.0

func NewDescribeMetricsForAlarmRequestWithAllParams(
	serviceCode *string,
	product *string,
	dimension *string,
	metricType *int,
) *DescribeMetricsForAlarmRequest

* param serviceCode: 产品线 (Optional) * param product: 产品类型,如redis2.8cluster(集群)\redis2.8MS(主从)。当serviceCode与product同时指定时,product优先级更高 (Optional) * param dimension: 产品维度,必须指定serviceCode或product才生效。 (Optional) * param metricType: metric类型,取值0、1;默认值:0(常规指标,用于控制台创建报警规则)、1(其它) (Optional)

func NewDescribeMetricsForAlarmRequestWithoutParam added in v1.13.0

func NewDescribeMetricsForAlarmRequestWithoutParam() *DescribeMetricsForAlarmRequest

This constructor has better compatible ability when API parameters changed

func (DescribeMetricsForAlarmRequest) GetRegionId added in v1.13.0

func (r DescribeMetricsForAlarmRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeMetricsForAlarmRequest) SetDimension added in v1.13.0

func (r *DescribeMetricsForAlarmRequest) SetDimension(dimension string)

param dimension: 产品维度,必须指定serviceCode或product才生效。(Optional)

func (*DescribeMetricsForAlarmRequest) SetMetricType added in v1.13.0

func (r *DescribeMetricsForAlarmRequest) SetMetricType(metricType int)

param metricType: metric类型,取值0、1;默认值:0(常规指标,用于控制台创建报警规则)、1(其它)(Optional)

func (*DescribeMetricsForAlarmRequest) SetProduct added in v1.13.0

func (r *DescribeMetricsForAlarmRequest) SetProduct(product string)

param product: 产品类型,如redis2.8cluster(集群)\redis2.8MS(主从)。当serviceCode与product同时指定时,product优先级更高(Optional)

func (*DescribeMetricsForAlarmRequest) SetServiceCode added in v1.13.0

func (r *DescribeMetricsForAlarmRequest) SetServiceCode(serviceCode string)

param serviceCode: 产品线(Optional)

type DescribeMetricsForAlarmResponse added in v1.13.0

type DescribeMetricsForAlarmResponse struct {
	RequestID string                        `json:"requestId"`
	Error     core.ErrorResponse            `json:"error"`
	Result    DescribeMetricsForAlarmResult `json:"result"`
}

type DescribeMetricsForAlarmResult added in v1.13.0

type DescribeMetricsForAlarmResult struct {
	Metrics []monitor.RuleMetricDetail `json:"metrics"`
}

type DescribeMetricsRequest

type DescribeMetricsRequest struct {
	core.JDCloudRequest

	/* 资源的类型,取值vm, lb, ip, database 等。<a href="https://docs.jdcloud.com/cn/monitoring/api/describeservices?content=API&SOP=JDCloud">describeServices</a>:查询己接入云监控的产品线列表  */
	ServiceCode string `json:"serviceCode"`

	/*  (Optional) */
	Dimension *string `json:"dimension"`

	/* metric的类型,取值0(控制台展示)、1(内部使用,控制台不展示)、2(所有).默认取0 (Optional) */
	Type *int `json:"type"`
}

func NewDescribeMetricsRequest

func NewDescribeMetricsRequest(
	serviceCode string,
) *DescribeMetricsRequest

* param serviceCode: 资源的类型,取值vm, lb, ip, database 等。<a href="https://docs.jdcloud.com/cn/monitoring/api/describeservices?content=API&SOP=JDCloud">describeServices</a>:查询己接入云监控的产品线列表 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeMetricsRequestWithAllParams added in v1.0.7

func NewDescribeMetricsRequestWithAllParams(
	serviceCode string,
	dimension *string,
	type_ *int,
) *DescribeMetricsRequest

* param serviceCode: 资源的类型,取值vm, lb, ip, database 等。<a href="https://docs.jdcloud.com/cn/monitoring/api/describeservices?content=API&SOP=JDCloud">describeServices</a>:查询己接入云监控的产品线列表 (Required) * param dimension: (Optional) * param type_: metric的类型,取值0(控制台展示)、1(内部使用,控制台不展示)、2(所有).默认取0 (Optional)

func NewDescribeMetricsRequestWithoutParam added in v1.0.7

func NewDescribeMetricsRequestWithoutParam() *DescribeMetricsRequest

This constructor has better compatible ability when API parameters changed

func (DescribeMetricsRequest) GetRegionId

func (r DescribeMetricsRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeMetricsRequest) SetDimension added in v1.16.0

func (r *DescribeMetricsRequest) SetDimension(dimension string)

param dimension: (Optional)

func (*DescribeMetricsRequest) SetServiceCode

func (r *DescribeMetricsRequest) SetServiceCode(serviceCode string)

param serviceCode: 资源的类型,取值vm, lb, ip, database 等。<a href="https://docs.jdcloud.com/cn/monitoring/api/describeservices?content=API&SOP=JDCloud">describeServices</a>:查询己接入云监控的产品线列表(Required)

func (*DescribeMetricsRequest) SetType added in v1.11.0

func (r *DescribeMetricsRequest) SetType(type_ int)

param type_: metric的类型,取值0(控制台展示)、1(内部使用,控制台不展示)、2(所有).默认取0(Optional)

type DescribeMetricsResponse

type DescribeMetricsResponse struct {
	RequestID string                `json:"requestId"`
	Error     core.ErrorResponse    `json:"error"`
	Result    DescribeMetricsResult `json:"result"`
}

type DescribeMetricsResult

type DescribeMetricsResult struct {
	Metrics []monitor.MetricDetail `json:"metrics"`
}

type DescribeOneDataPointRequest added in v1.16.0

type DescribeOneDataPointRequest struct {
	core.JDCloudRequest

	/* 地域 Id  */
	RegionId string `json:"regionId"`

	/* 监控项英文标识(id)  */
	Metric string `json:"metric"`

	/* 资源的类型,取值vm, lb, ip, database 等。可用的serviceCode请使用describeServices接口查询  */
	ServiceCode string `json:"serviceCode"`

	/* 资源的维度。serviceCode下可用的dimension请使用describeServices接口查询 (Optional) */
	Dimension *string `json:"dimension"`

	/* 资源的uuid,支持多个resourceId批量查询,每个id用竖线分隔。 如:id1|id2|id3|id4  */
	ResourceId string `json:"resourceId"`

	/* 自定义标签 (Optional) */
	Tags []monitor.TagFilter `json:"tags"`

	/* 查询时间范围的开始时间, UTC时间,格式:2016-12-11T00:00:00+0800(早于30d时,将被重置为30d)(注意在url中+要转译为%2B故url中为2016-12-11T00:00:00%2B0800) (Optional) */
	StartTime *string `json:"startTime"`

	/* 查询时间范围的结束时间, UTC时间,格式:2016-12-11T00:00:00+0800(为空时,将由startTime与timeInterval计算得出)(注意在url中+要转译为%2B故url中为2016-12-11T00:00:00%2B0800) (Optional) */
	EndTime *string `json:"endTime"`

	/* 查询的时间间隔,最大不超过30天,支持分钟级别,小时级别,天级别,例如:1m、1h、1d (Optional) */
	TimeInterval *string `json:"timeInterval"`

	/* 聚合方式:max avg min等,用于不同维度之间聚合 (Optional) */
	AggrType *string `json:"aggrType"`

	/* 聚合方式:max avg min等,用于将维度内一个周期数据聚合为一个点的聚合方式,默认last (Optional) */
	DownAggrType *string `json:"downAggrType"`
}

func NewDescribeOneDataPointRequest added in v1.16.0

func NewDescribeOneDataPointRequest(
	regionId string,
	metric string,
	serviceCode string,
	resourceId string,
) *DescribeOneDataPointRequest

* param regionId: 地域 Id (Required) * param metric: 监控项英文标识(id) (Required) * param serviceCode: 资源的类型,取值vm, lb, ip, database 等。可用的serviceCode请使用describeServices接口查询 (Required) * param resourceId: 资源的uuid,支持多个resourceId批量查询,每个id用竖线分隔。 如:id1|id2|id3|id4 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeOneDataPointRequestWithAllParams added in v1.16.0

func NewDescribeOneDataPointRequestWithAllParams(
	regionId string,
	metric string,
	serviceCode string,
	dimension *string,
	resourceId string,
	tags []monitor.TagFilter,
	startTime *string,
	endTime *string,
	timeInterval *string,
	aggrType *string,
	downAggrType *string,
) *DescribeOneDataPointRequest

* param regionId: 地域 Id (Required) * param metric: 监控项英文标识(id) (Required) * param serviceCode: 资源的类型,取值vm, lb, ip, database 等。可用的serviceCode请使用describeServices接口查询 (Required) * param dimension: 资源的维度。serviceCode下可用的dimension请使用describeServices接口查询 (Optional) * param resourceId: 资源的uuid,支持多个resourceId批量查询,每个id用竖线分隔。 如:id1|id2|id3|id4 (Required) * param tags: 自定义标签 (Optional) * param startTime: 查询时间范围的开始时间, UTC时间,格式:2016-12-11T00:00:00+0800(早于30d时,将被重置为30d)(注意在url中+要转译为%2B故url中为2016-12-11T00:00:00%2B0800) (Optional) * param endTime: 查询时间范围的结束时间, UTC时间,格式:2016-12-11T00:00:00+0800(为空时,将由startTime与timeInterval计算得出)(注意在url中+要转译为%2B故url中为2016-12-11T00:00:00%2B0800) (Optional) * param timeInterval: 查询的时间间隔,最大不超过30天,支持分钟级别,小时级别,天级别,例如:1m、1h、1d (Optional) * param aggrType: 聚合方式:max avg min等,用于不同维度之间聚合 (Optional) * param downAggrType: 聚合方式:max avg min等,用于将维度内一个周期数据聚合为一个点的聚合方式,默认last (Optional)

func NewDescribeOneDataPointRequestWithoutParam added in v1.16.0

func NewDescribeOneDataPointRequestWithoutParam() *DescribeOneDataPointRequest

This constructor has better compatible ability when API parameters changed

func (DescribeOneDataPointRequest) GetRegionId added in v1.16.0

func (r DescribeOneDataPointRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeOneDataPointRequest) SetAggrType added in v1.16.0

func (r *DescribeOneDataPointRequest) SetAggrType(aggrType string)

param aggrType: 聚合方式:max avg min等,用于不同维度之间聚合(Optional)

func (*DescribeOneDataPointRequest) SetDimension added in v1.16.0

func (r *DescribeOneDataPointRequest) SetDimension(dimension string)

param dimension: 资源的维度。serviceCode下可用的dimension请使用describeServices接口查询(Optional)

func (*DescribeOneDataPointRequest) SetDownAggrType added in v1.16.0

func (r *DescribeOneDataPointRequest) SetDownAggrType(downAggrType string)

param downAggrType: 聚合方式:max avg min等,用于将维度内一个周期数据聚合为一个点的聚合方式,默认last(Optional)

func (*DescribeOneDataPointRequest) SetEndTime added in v1.16.0

func (r *DescribeOneDataPointRequest) SetEndTime(endTime string)

param endTime: 查询时间范围的结束时间, UTC时间,格式:2016-12-11T00:00:00+0800(为空时,将由startTime与timeInterval计算得出)(注意在url中+要转译为%2B故url中为2016-12-11T00:00:00%2B0800)(Optional)

func (*DescribeOneDataPointRequest) SetMetric added in v1.16.0

func (r *DescribeOneDataPointRequest) SetMetric(metric string)

param metric: 监控项英文标识(id)(Required)

func (*DescribeOneDataPointRequest) SetRegionId added in v1.16.0

func (r *DescribeOneDataPointRequest) SetRegionId(regionId string)

param regionId: 地域 Id(Required)

func (*DescribeOneDataPointRequest) SetResourceId added in v1.16.0

func (r *DescribeOneDataPointRequest) SetResourceId(resourceId string)

param resourceId: 资源的uuid,支持多个resourceId批量查询,每个id用竖线分隔。 如:id1|id2|id3|id4(Required)

func (*DescribeOneDataPointRequest) SetServiceCode added in v1.16.0

func (r *DescribeOneDataPointRequest) SetServiceCode(serviceCode string)

param serviceCode: 资源的类型,取值vm, lb, ip, database 等。可用的serviceCode请使用describeServices接口查询(Required)

func (*DescribeOneDataPointRequest) SetStartTime added in v1.16.0

func (r *DescribeOneDataPointRequest) SetStartTime(startTime string)

param startTime: 查询时间范围的开始时间, UTC时间,格式:2016-12-11T00:00:00+0800(早于30d时,将被重置为30d)(注意在url中+要转译为%2B故url中为2016-12-11T00:00:00%2B0800)(Optional)

func (*DescribeOneDataPointRequest) SetTags added in v1.16.0

func (r *DescribeOneDataPointRequest) SetTags(tags []monitor.TagFilter)

param tags: 自定义标签(Optional)

func (*DescribeOneDataPointRequest) SetTimeInterval added in v1.16.0

func (r *DescribeOneDataPointRequest) SetTimeInterval(timeInterval string)

param timeInterval: 查询的时间间隔,最大不超过30天,支持分钟级别,小时级别,天级别,例如:1m、1h、1d(Optional)

type DescribeOneDataPointResponse added in v1.16.0

type DescribeOneDataPointResponse struct {
	RequestID string                     `json:"requestId"`
	Error     core.ErrorResponse         `json:"error"`
	Result    DescribeOneDataPointResult `json:"result"`
}

type DescribeOneDataPointResult added in v1.16.0

type DescribeOneDataPointResult struct {
	Items []monitor.LastDownsampleRespItem `json:"items"`
}

type DescribeProductsForAlarmRequest added in v1.13.0

type DescribeProductsForAlarmRequest struct {
	core.JDCloudRequest

	/* 产品线,从产品线维度筛选 (Optional) */
	ServiceCode *string `json:"serviceCode"`

	/* 产品类型,从产品维度筛选、如redis2.8cluster\redis2.8instance。当serviceCode与product同时指定时,product优先级更高 (Optional) */
	Product *string `json:"product"`
}

func NewDescribeProductsForAlarmRequest added in v1.13.0

func NewDescribeProductsForAlarmRequest() *DescribeProductsForAlarmRequest

* * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeProductsForAlarmRequestWithAllParams added in v1.13.0

func NewDescribeProductsForAlarmRequestWithAllParams(
	serviceCode *string,
	product *string,
) *DescribeProductsForAlarmRequest

* param serviceCode: 产品线,从产品线维度筛选 (Optional) * param product: 产品类型,从产品维度筛选、如redis2.8cluster\redis2.8instance。当serviceCode与product同时指定时,product优先级更高 (Optional)

func NewDescribeProductsForAlarmRequestWithoutParam added in v1.13.0

func NewDescribeProductsForAlarmRequestWithoutParam() *DescribeProductsForAlarmRequest

This constructor has better compatible ability when API parameters changed

func (DescribeProductsForAlarmRequest) GetRegionId added in v1.13.0

func (r DescribeProductsForAlarmRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeProductsForAlarmRequest) SetProduct added in v1.13.0

func (r *DescribeProductsForAlarmRequest) SetProduct(product string)

param product: 产品类型,从产品维度筛选、如redis2.8cluster\redis2.8instance。当serviceCode与product同时指定时,product优先级更高(Optional)

func (*DescribeProductsForAlarmRequest) SetServiceCode added in v1.13.0

func (r *DescribeProductsForAlarmRequest) SetServiceCode(serviceCode string)

param serviceCode: 产品线,从产品线维度筛选(Optional)

type DescribeProductsForAlarmResponse added in v1.13.0

type DescribeProductsForAlarmResponse struct {
	RequestID string                         `json:"requestId"`
	Error     core.ErrorResponse             `json:"error"`
	Result    DescribeProductsForAlarmResult `json:"result"`
}

type DescribeProductsForAlarmResult added in v1.13.0

type DescribeProductsForAlarmResult struct {
	ProductList []monitor.Product `json:"productList"`
}

type DescribeServicesRequest added in v1.11.0

type DescribeServicesRequest struct {
	core.JDCloudRequest

	/* 服务码列表
	filter name 为serviceCodes表示查询多个产品线的规则 (Optional) */
	Filters []monitor.Filter `json:"filters"`

	/* 要查询的产品线类型   0:all    1:资源监控   2:其它   默认:1。若指定了查询的serviceCode,则忽略该参数 (Optional) */
	ProductType *int `json:"productType"`
}

func NewDescribeServicesRequest added in v1.11.0

func NewDescribeServicesRequest() *DescribeServicesRequest

* * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeServicesRequestWithAllParams added in v1.11.0

func NewDescribeServicesRequestWithAllParams(
	filters []monitor.Filter,
	productType *int,
) *DescribeServicesRequest
  • param filters: 服务码列表

filter name 为serviceCodes表示查询多个产品线的规则 (Optional)

  • param productType: 要查询的产品线类型 0:all 1:资源监控 2:其它 默认:1。若指定了查询的serviceCode,则忽略该参数 (Optional)

func NewDescribeServicesRequestWithoutParam added in v1.11.0

func NewDescribeServicesRequestWithoutParam() *DescribeServicesRequest

This constructor has better compatible ability when API parameters changed

func (DescribeServicesRequest) GetRegionId added in v1.11.0

func (r DescribeServicesRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeServicesRequest) SetFilters added in v1.11.0

func (r *DescribeServicesRequest) SetFilters(filters []monitor.Filter)
param filters: 服务码列表

filter name 为serviceCodes表示查询多个产品线的规则(Optional)

func (*DescribeServicesRequest) SetProductType added in v1.11.0

func (r *DescribeServicesRequest) SetProductType(productType int)

param productType: 要查询的产品线类型 0:all 1:资源监控 2:其它 默认:1。若指定了查询的serviceCode,则忽略该参数(Optional)

type DescribeServicesResponse added in v1.11.0

type DescribeServicesResponse struct {
	RequestID string                 `json:"requestId"`
	Error     core.ErrorResponse     `json:"error"`
	Result    DescribeServicesResult `json:"result"`
}

type DescribeServicesResult added in v1.11.0

type DescribeServicesResult struct {
	Services []monitor.ServiceInfoV2 `json:"services"`
}

type EnableAlarmsRequest added in v1.13.0

type EnableAlarmsRequest struct {
	core.JDCloudRequest

	/* 告警规则的ID列表  */
	AlarmIds []string `json:"alarmIds"`

	/* 启用:1,禁用0, (Optional) */
	State *int `json:"state"`
}

func NewEnableAlarmsRequest added in v1.13.0

func NewEnableAlarmsRequest(
	alarmIds []string,
) *EnableAlarmsRequest

* param alarmIds: 告警规则的ID列表 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewEnableAlarmsRequestWithAllParams added in v1.13.0

func NewEnableAlarmsRequestWithAllParams(
	alarmIds []string,
	state *int,
) *EnableAlarmsRequest

* param alarmIds: 告警规则的ID列表 (Required) * param state: 启用:1,禁用0, (Optional)

func NewEnableAlarmsRequestWithoutParam added in v1.13.0

func NewEnableAlarmsRequestWithoutParam() *EnableAlarmsRequest

This constructor has better compatible ability when API parameters changed

func (EnableAlarmsRequest) GetRegionId added in v1.13.0

func (r EnableAlarmsRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*EnableAlarmsRequest) SetAlarmIds added in v1.13.0

func (r *EnableAlarmsRequest) SetAlarmIds(alarmIds []string)

param alarmIds: 告警规则的ID列表(Required)

func (*EnableAlarmsRequest) SetState added in v1.13.0

func (r *EnableAlarmsRequest) SetState(state int)

param state: 启用:1,禁用0,(Optional)

type EnableAlarmsResponse added in v1.13.0

type EnableAlarmsResponse struct {
	RequestID string             `json:"requestId"`
	Error     core.ErrorResponse `json:"error"`
	Result    EnableAlarmsResult `json:"result"`
}

type EnableAlarmsResult added in v1.13.0

type EnableAlarmsResult struct {
	Success bool `json:"success"`
}

type PutCustomMetricDataRequest added in v1.16.0

type PutCustomMetricDataRequest struct {
	core.JDCloudRequest

	/* 数据参数 (Optional) */
	MetricDataList []monitor.MetricDataCm `json:"metricDataList"`
}

func NewPutCustomMetricDataRequest added in v1.16.0

func NewPutCustomMetricDataRequest() *PutCustomMetricDataRequest

* * @Deprecated, not compatible when mandatory parameters changed

func NewPutCustomMetricDataRequestWithAllParams added in v1.16.0

func NewPutCustomMetricDataRequestWithAllParams(
	metricDataList []monitor.MetricDataCm,
) *PutCustomMetricDataRequest

* param metricDataList: 数据参数 (Optional)

func NewPutCustomMetricDataRequestWithoutParam added in v1.16.0

func NewPutCustomMetricDataRequestWithoutParam() *PutCustomMetricDataRequest

This constructor has better compatible ability when API parameters changed

func (PutCustomMetricDataRequest) GetRegionId added in v1.16.0

func (r PutCustomMetricDataRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*PutCustomMetricDataRequest) SetMetricDataList added in v1.16.0

func (r *PutCustomMetricDataRequest) SetMetricDataList(metricDataList []monitor.MetricDataCm)

param metricDataList: 数据参数(Optional)

type PutCustomMetricDataResponse added in v1.16.0

type PutCustomMetricDataResponse struct {
	RequestID string                    `json:"requestId"`
	Error     core.ErrorResponse        `json:"error"`
	Result    PutCustomMetricDataResult `json:"result"`
}

type PutCustomMetricDataResult added in v1.16.0

type PutCustomMetricDataResult struct {
	Success           bool                     `json:"success"`
	ErrMetricDataList []monitor.MetricDataList `json:"errMetricDataList"`
}

type PutMetricDataRequest added in v1.0.7

type PutMetricDataRequest struct {
	core.JDCloudRequest

	/* 数据参数 (Optional) */
	MetricDataList []monitor.MetricDataCm `json:"metricDataList"`
}

func NewPutMetricDataRequest added in v1.0.7

func NewPutMetricDataRequest() *PutMetricDataRequest

* * @Deprecated, not compatible when mandatory parameters changed

func NewPutMetricDataRequestWithAllParams added in v1.0.7

func NewPutMetricDataRequestWithAllParams(
	metricDataList []monitor.MetricDataCm,
) *PutMetricDataRequest

* param metricDataList: 数据参数 (Optional)

func NewPutMetricDataRequestWithoutParam added in v1.0.7

func NewPutMetricDataRequestWithoutParam() *PutMetricDataRequest

This constructor has better compatible ability when API parameters changed

func (PutMetricDataRequest) GetRegionId added in v1.0.7

func (r PutMetricDataRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*PutMetricDataRequest) SetMetricDataList added in v1.0.7

func (r *PutMetricDataRequest) SetMetricDataList(metricDataList []monitor.MetricDataCm)

param metricDataList: 数据参数(Optional)

type PutMetricDataResponse added in v1.0.7

type PutMetricDataResponse struct {
	RequestID string              `json:"requestId"`
	Error     core.ErrorResponse  `json:"error"`
	Result    PutMetricDataResult `json:"result"`
}

type PutMetricDataResult added in v1.0.7

type PutMetricDataResult struct {
	Success           bool                     `json:"success"`
	ErrMetricDataList []monitor.MetricDataList `json:"errMetricDataList"`
}

type UpdateAlarmRequest

type UpdateAlarmRequest struct {
	core.JDCloudRequest

	/* 规则id  */
	AlarmId string `json:"alarmId"`

	/* 弹性伸缩组Id。注:仅ag\asg产品线内部使用 (Optional) */
	AutoScalingPolicyId *string `json:"autoScalingPolicyId"`

	/* 告警通知联系人 (Optional) */
	BaseContact []monitor.BaseContact `json:"baseContact"`

	/* 资源维度,可用的维度请使用 describeProductsForAlarm接口查询 (Optional) */
	Dimension *string `json:"dimension"`

	/* 是否启用, 1表示启用规则,0表示禁用规则,默认为1 (Optional) */
	Enabled *int64 `json:"enabled"`

	/* 通知策略 (Optional) */
	NoticeOption []monitor.NoticeOption `json:"noticeOption"`

	/* 资源类型, 可用的资源类型列表请使用 describeProductsForAlarm接口查询。  */
	Product string `json:"product"`

	/*   */
	ResourceOption *monitor.ResourceOption `json:"resourceOption"`

	/* 规则名称,规则名称,最大长度42个字符,只允许中英文、数字、”-”和"_"  */
	RuleName string `json:"ruleName"`

	/*   */
	RuleOption *monitor.RuleOption `json:"ruleOption"`

	/* 规则类型, 默认为resourceMonitor (Optional) */
	RuleType *string `json:"ruleType"`

	/* 资源维度,指定监控数据实例的维度标签,如resourceId=id。(请确认资源的监控数据带有该标签,否则规则会报数据不足) (Optional) */
	Tags *interface{} `json:"tags"`

	/*  (Optional) */
	WebHookOption *monitor.WebHookOption `json:"webHookOption"`
}

func NewUpdateAlarmRequest

func NewUpdateAlarmRequest(
	alarmId string,
	product string,
	resourceOption *monitor.ResourceOption,
	ruleName string,
	ruleOption *monitor.RuleOption,
) *UpdateAlarmRequest

* param alarmId: 规则id (Required) * param product: 资源类型, 可用的资源类型列表请使用 describeProductsForAlarm接口查询。 (Required) * param resourceOption: (Required) * param ruleName: 规则名称,规则名称,最大长度42个字符,只允许中英文、数字、”-”和"_" (Required) * param ruleOption: (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewUpdateAlarmRequestWithAllParams added in v1.0.7

func NewUpdateAlarmRequestWithAllParams(
	alarmId string,
	autoScalingPolicyId *string,
	baseContact []monitor.BaseContact,
	dimension *string,
	enabled *int64,
	noticeOption []monitor.NoticeOption,
	product string,
	resourceOption *monitor.ResourceOption,
	ruleName string,
	ruleOption *monitor.RuleOption,
	ruleType *string,
	tags *interface{},
	webHookOption *monitor.WebHookOption,
) *UpdateAlarmRequest

* param alarmId: 规则id (Required) * param autoScalingPolicyId: 弹性伸缩组Id。注:仅ag\asg产品线内部使用 (Optional) * param baseContact: 告警通知联系人 (Optional) * param dimension: 资源维度,可用的维度请使用 describeProductsForAlarm接口查询 (Optional) * param enabled: 是否启用, 1表示启用规则,0表示禁用规则,默认为1 (Optional) * param noticeOption: 通知策略 (Optional) * param product: 资源类型, 可用的资源类型列表请使用 describeProductsForAlarm接口查询。 (Required) * param resourceOption: (Required) * param ruleName: 规则名称,规则名称,最大长度42个字符,只允许中英文、数字、”-”和"_" (Required) * param ruleOption: (Required) * param ruleType: 规则类型, 默认为resourceMonitor (Optional) * param tags: 资源维度,指定监控数据实例的维度标签,如resourceId=id。(请确认资源的监控数据带有该标签,否则规则会报数据不足) (Optional) * param webHookOption: (Optional)

func NewUpdateAlarmRequestWithoutParam added in v1.0.7

func NewUpdateAlarmRequestWithoutParam() *UpdateAlarmRequest

This constructor has better compatible ability when API parameters changed

func (UpdateAlarmRequest) GetRegionId

func (r UpdateAlarmRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*UpdateAlarmRequest) SetAlarmId

func (r *UpdateAlarmRequest) SetAlarmId(alarmId string)

param alarmId: 规则id(Required)

func (*UpdateAlarmRequest) SetAutoScalingPolicyId added in v1.16.0

func (r *UpdateAlarmRequest) SetAutoScalingPolicyId(autoScalingPolicyId string)

param autoScalingPolicyId: 弹性伸缩组Id。注:仅ag\asg产品线内部使用(Optional)

func (*UpdateAlarmRequest) SetBaseContact added in v1.13.0

func (r *UpdateAlarmRequest) SetBaseContact(baseContact []monitor.BaseContact)

param baseContact: 告警通知联系人(Optional)

func (*UpdateAlarmRequest) SetDimension added in v1.13.0

func (r *UpdateAlarmRequest) SetDimension(dimension string)

param dimension: 资源维度,可用的维度请使用 describeProductsForAlarm接口查询(Optional)

func (*UpdateAlarmRequest) SetEnabled added in v1.13.0

func (r *UpdateAlarmRequest) SetEnabled(enabled int64)

param enabled: 是否启用, 1表示启用规则,0表示禁用规则,默认为1(Optional)

func (*UpdateAlarmRequest) SetNoticeOption added in v1.13.0

func (r *UpdateAlarmRequest) SetNoticeOption(noticeOption []monitor.NoticeOption)

param noticeOption: 通知策略(Optional)

func (*UpdateAlarmRequest) SetProduct added in v1.13.0

func (r *UpdateAlarmRequest) SetProduct(product string)

param product: 资源类型, 可用的资源类型列表请使用 describeProductsForAlarm接口查询。(Required)

func (*UpdateAlarmRequest) SetResourceOption added in v1.13.0

func (r *UpdateAlarmRequest) SetResourceOption(resourceOption *monitor.ResourceOption)

param resourceOption: (Required)

func (*UpdateAlarmRequest) SetRuleName added in v1.13.0

func (r *UpdateAlarmRequest) SetRuleName(ruleName string)

param ruleName: 规则名称,规则名称,最大长度42个字符,只允许中英文、数字、”-”和"_"(Required)

func (*UpdateAlarmRequest) SetRuleOption added in v1.13.0

func (r *UpdateAlarmRequest) SetRuleOption(ruleOption *monitor.RuleOption)

param ruleOption: (Required)

func (*UpdateAlarmRequest) SetRuleType added in v1.13.0

func (r *UpdateAlarmRequest) SetRuleType(ruleType string)

param ruleType: 规则类型, 默认为resourceMonitor(Optional)

func (*UpdateAlarmRequest) SetTags added in v1.13.0

func (r *UpdateAlarmRequest) SetTags(tags interface{})

param tags: 资源维度,指定监控数据实例的维度标签,如resourceId=id。(请确认资源的监控数据带有该标签,否则规则会报数据不足)(Optional)

func (*UpdateAlarmRequest) SetWebHookOption added in v1.13.0

func (r *UpdateAlarmRequest) SetWebHookOption(webHookOption *monitor.WebHookOption)

param webHookOption: (Optional)

type UpdateAlarmResponse

type UpdateAlarmResponse struct {
	RequestID string             `json:"requestId"`
	Error     core.ErrorResponse `json:"error"`
	Result    UpdateAlarmResult  `json:"result"`
}

type UpdateAlarmResult

type UpdateAlarmResult struct {
	AlarmId string  `json:"alarmId"`
	RuleIds []int64 `json:"ruleIds"`
	Success bool    `json:"success"`
}

Jump to

Keyboard shortcuts

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