Documentation
¶
Index ¶
- Constants
- type Client
- func (c *Client) DescribeStrategies(request *DescribeStrategiesRequest) (response *DescribeStrategiesResponse, err error)
- func (c *Client) DescribeStrategiesWithContext(ctx context.Context, request *DescribeStrategiesRequest) (response *DescribeStrategiesResponse, err error)
- func (c *Client) DescribeTaskStrategyRisks(request *DescribeTaskStrategyRisksRequest) (response *DescribeTaskStrategyRisksResponse, err error)
- func (c *Client) DescribeTaskStrategyRisksWithContext(ctx context.Context, request *DescribeTaskStrategyRisksRequest) (response *DescribeTaskStrategyRisksResponse, err error)
- type DescribeStrategie
- type DescribeStrategiesCondition
- type DescribeStrategiesRequest
- type DescribeStrategiesRequestParams
- type DescribeStrategiesResponse
- type DescribeStrategiesResponseParams
- type DescribeTaskStrategyRisksRequest
- type DescribeTaskStrategyRisksRequestParams
- type DescribeTaskStrategyRisksResponse
- type DescribeTaskStrategyRisksResponseParams
- type KeyValue
- type RiskFieldsDesc
Constants ¶
const ( // 内部错误。 INTERNALERROR = "InternalError" // 依赖的db出错。 INTERNALERROR_DEPENDSDB = "InternalError.DependsDb" // 系统错误。 INTERNALERROR_SYSTEM = "InternalError.System" // 参数错误。 INVALIDPARAMETER = "InvalidParameter" // 参数错误。 INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError" // 参数取值错误。 INVALIDPARAMETERVALUE = "InvalidParameterValue" // 资源不存在。 RESOURCENOTFOUND = "ResourceNotFound" )
const APIVersion = "2020-07-21"
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
func NewClient ¶
func NewClient(credential common.CredentialIface, region string, clientProfile *profile.ClientProfile) (client *Client, err error)
func NewClientWithSecretId ¶
Deprecated
func (*Client) DescribeStrategies ¶
func (c *Client) DescribeStrategies(request *DescribeStrategiesRequest) (response *DescribeStrategiesResponse, err error)
DescribeStrategies 用于查询评估项的信息
可能返回的错误码:
INTERNALERROR_DEPENDSDB = "InternalError.DependsDb" INTERNALERROR_SYSTEM = "InternalError.System" INVALIDPARAMETER = "InvalidParameter" RESOURCENOTFOUND = "ResourceNotFound"
func (*Client) DescribeStrategiesWithContext ¶ added in v1.0.324
func (c *Client) DescribeStrategiesWithContext(ctx context.Context, request *DescribeStrategiesRequest) (response *DescribeStrategiesResponse, err error)
DescribeStrategies 用于查询评估项的信息
可能返回的错误码:
INTERNALERROR_DEPENDSDB = "InternalError.DependsDb" INTERNALERROR_SYSTEM = "InternalError.System" INVALIDPARAMETER = "InvalidParameter" RESOURCENOTFOUND = "ResourceNotFound"
func (*Client) DescribeTaskStrategyRisks ¶
func (c *Client) DescribeTaskStrategyRisks(request *DescribeTaskStrategyRisksRequest) (response *DescribeTaskStrategyRisksResponse, err error)
DescribeTaskStrategyRisks 查询评估项风险实例列表
可能返回的错误码:
INTERNALERROR = "InternalError" INTERNALERROR_DEPENDSDB = "InternalError.DependsDb" INTERNALERROR_SYSTEM = "InternalError.System" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError" INVALIDPARAMETERVALUE = "InvalidParameterValue" RESOURCENOTFOUND = "ResourceNotFound"
func (*Client) DescribeTaskStrategyRisksWithContext ¶ added in v1.0.324
func (c *Client) DescribeTaskStrategyRisksWithContext(ctx context.Context, request *DescribeTaskStrategyRisksRequest) (response *DescribeTaskStrategyRisksResponse, err error)
DescribeTaskStrategyRisks 查询评估项风险实例列表
可能返回的错误码:
INTERNALERROR = "InternalError" INTERNALERROR_DEPENDSDB = "InternalError.DependsDb" INTERNALERROR_SYSTEM = "InternalError.System" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError" INVALIDPARAMETERVALUE = "InvalidParameterValue" RESOURCENOTFOUND = "ResourceNotFound"
type DescribeStrategie ¶
type DescribeStrategie struct {
// 评估项ID
// 注意:此字段可能返回 null,表示取不到有效值。
StrategyId *uint64 `json:"StrategyId,omitempty" name:"StrategyId"`
// 评估项名称
// 注意:此字段可能返回 null,表示取不到有效值。
Name *string `json:"Name,omitempty" name:"Name"`
// 评估项描述
// 注意:此字段可能返回 null,表示取不到有效值。
Desc *string `json:"Desc,omitempty" name:"Desc"`
// 评估项对应产品ID
// 注意:此字段可能返回 null,表示取不到有效值。
Product *string `json:"Product,omitempty" name:"Product"`
// 评估项对应产品名称
// 注意:此字段可能返回 null,表示取不到有效值。
ProductDesc *string `json:"ProductDesc,omitempty" name:"ProductDesc"`
// 评估项优化建议
// 注意:此字段可能返回 null,表示取不到有效值。
Repair *string `json:"Repair,omitempty" name:"Repair"`
// 评估项类别ID
// 注意:此字段可能返回 null,表示取不到有效值。
GroupId *uint64 `json:"GroupId,omitempty" name:"GroupId"`
// 评估项类别名称
// 注意:此字段可能返回 null,表示取不到有效值。
GroupName *string `json:"GroupName,omitempty" name:"GroupName"`
// 评估项风险列表
// 注意:此字段可能返回 null,表示取不到有效值。
Conditions []*DescribeStrategiesCondition `json:"Conditions,omitempty" name:"Conditions"`
}
type DescribeStrategiesCondition ¶
type DescribeStrategiesCondition struct {
// 警告条件ID
// 注意:此字段可能返回 null,表示取不到有效值。
ConditionId *uint64 `json:"ConditionId,omitempty" name:"ConditionId"`
// 警告级别,2:中风险,3:高风险
// 注意:此字段可能返回 null,表示取不到有效值。
Level *uint64 `json:"Level,omitempty" name:"Level"`
// 警告级别描述
// 注意:此字段可能返回 null,表示取不到有效值。
LevelDesc *string `json:"LevelDesc,omitempty" name:"LevelDesc"`
// 警告条件描述
Desc *string `json:"Desc,omitempty" name:"Desc"`
}
type DescribeStrategiesRequest ¶
type DescribeStrategiesRequest struct {
*tchttp.BaseRequest
}
func NewDescribeStrategiesRequest ¶
func NewDescribeStrategiesRequest() (request *DescribeStrategiesRequest)
func (*DescribeStrategiesRequest) FromJsonString ¶
func (r *DescribeStrategiesRequest) 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 (*DescribeStrategiesRequest) ToJsonString ¶
func (r *DescribeStrategiesRequest) ToJsonString() string
type DescribeStrategiesRequestParams ¶ added in v1.0.426
type DescribeStrategiesRequestParams struct {
}
Predefined struct for user
type DescribeStrategiesResponse ¶
type DescribeStrategiesResponse struct {
*tchttp.BaseResponse
Response *DescribeStrategiesResponseParams `json:"Response"`
}
func NewDescribeStrategiesResponse ¶
func NewDescribeStrategiesResponse() (response *DescribeStrategiesResponse)
func (*DescribeStrategiesResponse) FromJsonString ¶
func (r *DescribeStrategiesResponse) 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 (*DescribeStrategiesResponse) ToJsonString ¶
func (r *DescribeStrategiesResponse) ToJsonString() string
type DescribeStrategiesResponseParams ¶ added in v1.0.426
type DescribeStrategiesResponseParams struct {
// 评估项列表
// 注意:此字段可能返回 null,表示取不到有效值。
Strategies []*DescribeStrategie `json:"Strategies,omitempty" name:"Strategies"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}
Predefined struct for user
type DescribeTaskStrategyRisksRequest ¶
type DescribeTaskStrategyRisksRequest struct {
*tchttp.BaseRequest
// 评估项ID
StrategyId *uint64 `json:"StrategyId,omitempty" name:"StrategyId"`
// 返回数量,默认值为100,最大值为200
Limit *uint64 `json:"Limit,omitempty" name:"Limit"`
// 偏移量,默认0
Offset *uint64 `json:"Offset,omitempty" name:"Offset"`
// 环境
Env *string `json:"Env,omitempty" name:"Env"`
// 任务类型
TaskType *string `json:"TaskType,omitempty" name:"TaskType"`
}
func NewDescribeTaskStrategyRisksRequest ¶
func NewDescribeTaskStrategyRisksRequest() (request *DescribeTaskStrategyRisksRequest)
func (*DescribeTaskStrategyRisksRequest) FromJsonString ¶
func (r *DescribeTaskStrategyRisksRequest) 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 (*DescribeTaskStrategyRisksRequest) ToJsonString ¶
func (r *DescribeTaskStrategyRisksRequest) ToJsonString() string
type DescribeTaskStrategyRisksRequestParams ¶ added in v1.0.426
type DescribeTaskStrategyRisksRequestParams struct {
// 评估项ID
StrategyId *uint64 `json:"StrategyId,omitempty" name:"StrategyId"`
// 返回数量,默认值为100,最大值为200
Limit *uint64 `json:"Limit,omitempty" name:"Limit"`
// 偏移量,默认0
Offset *uint64 `json:"Offset,omitempty" name:"Offset"`
// 环境
Env *string `json:"Env,omitempty" name:"Env"`
// 任务类型
TaskType *string `json:"TaskType,omitempty" name:"TaskType"`
}
Predefined struct for user
type DescribeTaskStrategyRisksResponse ¶
type DescribeTaskStrategyRisksResponse struct {
*tchttp.BaseResponse
Response *DescribeTaskStrategyRisksResponseParams `json:"Response"`
}
func NewDescribeTaskStrategyRisksResponse ¶
func NewDescribeTaskStrategyRisksResponse() (response *DescribeTaskStrategyRisksResponse)
func (*DescribeTaskStrategyRisksResponse) FromJsonString ¶
func (r *DescribeTaskStrategyRisksResponse) 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 (*DescribeTaskStrategyRisksResponse) ToJsonString ¶
func (r *DescribeTaskStrategyRisksResponse) ToJsonString() string
type DescribeTaskStrategyRisksResponseParams ¶ added in v1.0.426
type DescribeTaskStrategyRisksResponseParams struct {
// 根据此配置,匹配风险实例列表(Risks)对应字段,例如:
// {"Response":{"RequestId":"111","RiskFieldsDesc":[{"Field":"InstanceId","FieldName":"ID","FieldType":"string","FieldDict":{}},{"Field":"InstanceName","FieldName":"名称","FieldType":"string","FieldDict":{}},{"Field":"InstanceState","FieldName":"状态","FieldType":"string","FieldDict":{"LAUNCH_FAILED":"创建失败","PENDING":"创建中","REBOOTING":"重启中","RUNNING":"运行中","SHUTDOWN":"停止待销毁","STARTING":"开机中","STOPPED":"关机","STOPPING":"关机中","TERMINATING":"销毁中"}},{"Field":"Zone","FieldName":"可用区","FieldType":"string","FieldDict":{}},{"Field":"PrivateIPAddresses","FieldName":"IP地址(内)","FieldType":"stringSlice","FieldDict":{}},{"Field":"PublicIPAddresses","FieldName":"IP地址(公)","FieldType":"stringSlice","FieldDict":{}},{"Field":"Region","FieldName":"地域","FieldType":"string","FieldDict":{}},{"Field":"Tags","FieldName":"标签","FieldType":"tags","FieldDict":{}}],"RiskTotalCount":3,"Risks":"[{\"InstanceId\":\"ins-xxx1\",\"InstanceName\":\"xxx1\",\"InstanceState\":\"RUNNING\",\"PrivateIPAddresses\":[\"1.17.64.2\"],\"PublicIPAddresses\":null,\"Region\":\"ap-shanghai\",\"Tags\":null,\"Zone\":\"ap-shanghai-2\"},{\"InstanceId\":\"ins-xxx2\",\"InstanceName\":\"xxx2\",\"InstanceState\":\"RUNNING\",\"PrivateIPAddresses\":[\"1.17.64.11\"],\"PublicIPAddresses\":null,\"Region\":\"ap-shanghai\",\"Tags\":null,\"Zone\":\"ap-shanghai-2\"}]","StrategyId":9}}
// 注意:此字段可能返回 null,表示取不到有效值。
RiskFieldsDesc []*RiskFieldsDesc `json:"RiskFieldsDesc,omitempty" name:"RiskFieldsDesc"`
// 评估项ID
// 注意:此字段可能返回 null,表示取不到有效值。
StrategyId *uint64 `json:"StrategyId,omitempty" name:"StrategyId"`
// 风险实例个数
// 注意:此字段可能返回 null,表示取不到有效值。
RiskTotalCount *uint64 `json:"RiskTotalCount,omitempty" name:"RiskTotalCount"`
// 风险实例详情列表,需要json decode
// 注意:此字段可能返回 null,表示取不到有效值。
Risks *string `json:"Risks,omitempty" name:"Risks"`
// 巡检资源数
// 注意:此字段可能返回 null,表示取不到有效值。
ResourceCount *uint64 `json:"ResourceCount,omitempty" name:"ResourceCount"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}
Predefined struct for user
type RiskFieldsDesc ¶
type RiskFieldsDesc struct {
// 字段ID
Field *string `json:"Field,omitempty" name:"Field"`
// 字段名称
FieldName *string `json:"FieldName,omitempty" name:"FieldName"`
// 字段类型,
// string: 字符串类型,例如"aa"
// int: 整形,例如 111
// stringSlice : 字符串数组类型,例如["a", "b"]
// tags: 标签类型, 例如: [{"Key":"kkk","Value":"vvv"},{"Key":"kkk2","Value":"vvv2"}]
FieldType *string `json:"FieldType,omitempty" name:"FieldType"`
// 字段值对应字典
// 注意:此字段可能返回 null,表示取不到有效值。
FieldDict []*KeyValue `json:"FieldDict,omitempty" name:"FieldDict"`
}