Documentation ¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CreateUpdateTokenRequest ¶
type CreateUpdateTokenRequest struct { // A label ( a **name** ) you assign to the token Name string `json:"name"` // An extended description of the token Description string `json:"description,omitempty"` // Specifies org token limits and thresholds. Use the form that corresponds to your pricing model: <br> * For DPM pricing, use \"dpmQuota\" * For host-based pricing, use \"categoryQuota\"<br> You can only set limits if you have an Enterprise-level account. Limits *Limit `json:"limits,omitempty"` // Array of notification settings. Each element defines a notification that SignalFx sends when your organization is within 90% of exceeding an org token limit. You can specify more than one object, and each object can be of a different type. <br> To send email notifications:<br> * For one or more individual users, use \"type\": \"Email\" * For one or more entire SignalFx teams, use \"type\": \"TeamEmail\" * For one or more members of a single team, use \"type\": \"Team\" * For one or more members of multiple teams, use \"type\": \"TeamEmail\" * To send emails to a team, the team must already exist. * To send email to specific members of a team, the team must already exist, and you must specify the team members who will receive emails. Notifications []*notification.Notification `json:"notifications,omitempty"` // Flag that controls enabling the token. If set to `true`, the token is disabled, and you can't use it for authentication. Disabled bool `json:"disabled,omitempty"` }
Properties of an org token, in the form of a JSON object
type Limit ¶
type Limit struct { // The datapoints per minute (dpm) limit for this token. If you exceed this limit, SignalFx sends out an alert. DpmQuota *int32 `json:"dpmQuota,omitempty"` // DPM level at which SignalFx sends the notification for this token. If you don't specify a notification, SignalFx sends the generic notification. DpmNotificationThreshold *int32 `json:"dpmNotificationThreshold,omitempty"` CategoryQuota *UsageLimits `json:"categoryQuota"` CategoryNotificationThreshold *UsageLimits `json:"categoryNotificationThreshold,omitempty"` }
Specifies the limit and threshold to set on an org token when you use DPM-based pricing. <br> **NOTE:** Use this object only when your organization uses DPM pricing. For any other pricing model, using this object causes your request to fail.
type RequestError ¶
type RequestError struct { // HTTP response code for the error Code int32 `json:"code,omitempty"` // Cause of the error, any one of: <br> * \"Please provide a name for this token.\" * \"Unable to create or update the given token. Please try again later.\" * \"A token with the same name already exists!\" * \"Category quota cannot be set on a DPM subscription plan\" * \"DPM quota cannot be set on a Hosts subscription plan\" * \"Host/Container quota cannot be set on a MTS subscription plan\" Message string `json:"message,omitempty"` }
Contains the response error code and a message describing the problem.
type SearchResults ¶
type SearchResults struct { // Number of token objects in the result set. This value is the number of token objects that matched your query. However, if you specify the `offset` or `limit` query parameters, or both, the number of objects you receive in the response body may be *different* from the value of `count`. Count int32 `json:"count,omitempty"` // Array of token objects. Results []Token `json:"results,omitempty"` }
JSON object that contains the response to a GET operation for the endpoint `/token`.
type ServiceNowNotification ¶
type ServiceNowNotification struct { // Tells SignalFx which external system it should use to send the notification. For a ServiceNow notification, this is always \"ServiceNow\". Type string `json:"type"` // ServiceNow integration identifier, which SignalFx assigns when you add the integration. Use the web UI or the Integrations API to find the value of `credentialId`. CredentialId string `json:"credentialId"` }
Properties for a limit threshold notification sent via ServiceNow
func (*ServiceNowNotification) GetType ¶
func (n *ServiceNowNotification) GetType() string
type Token ¶
type Token struct { // A label ( a **name** ) you assign to the token Name string `json:"name"` // An extended description of the token Description string `json:"description,omitempty"` // Specifies org token limits and thresholds. Use the form that corresponds to your pricing model: <br> * For DPM pricing, use \"dpmQuota\" * For host-based pricing, use \"categoryQuota\"<br> You can only set limits if you have an Enterprise-level account. Limits *Limit `json:"limits,omitempty"` // Array of notification settings. Each element defines a notification that SignalFx sends when your organization is within 90% of exceeding an org token limit. You can specify more than one object, and each object can be of a different type. <br> To send email notifications:<br> * For one or more individual users, use \"type\": \"Email\" * For one or more entire SignalFx teams, use \"type\": \"TeamEmail\" * For one or more members of a single team, use \"type\": \"Team\" * For one or more members of multiple teams, use \"type\": \"TeamEmail\" * To send emails to a team, the team must already exist. * To send email to specific members of a team, the team must already exist, and you must specify the team members who will receive emails. Notifications []*notification.Notification `json:"notifications,omitempty"` // Authentication secret key that protects the org token Secret string `json:"secret,omitempty"` // Flag that controls enabling the token. If set to `true`, the token is disabled, and you can't use it for authentication. Disabled bool `json:"disabled,omitempty"` // Date and time when SignalFx last rotated the secret for this token, in Unix time UTC-relative. The system sets this value, and you can't modify it. LatestRotation int64 `json:"latestRotation,omitempty"` // Date and time that the token will expire, in Unix UTC-relative. The system sets this value, and you can't modify it. Expiry int64 `json:"expiry,omitempty"` // SignalFx-assigned ID of the user that created this token Creator string `json:"creator,omitempty"` // SignalFx-assigned ID of the user that last updated this token LastUpdatedBy string `json:"lastUpdatedBy,omitempty"` // The token creation date and time, in Unix time UTC-relative. The system sets this value, and you can't modify it. Created int64 `json:"created,omitempty"` // The date and time that the token was last updated, in Unix UTC-relative. The system sets this value, and you can't modify it. LastUpdated int64 `json:"lastUpdated,omitempty"` }
Properties of an org token, in the form of a JSON object
type UsageLimits ¶
type UsageLimits struct { HostThreshold *int64 `json:"1,omitempty"` ContainerThreshold *int64 `json:"2,omitempty"` CustomMetricThreshold *int64 `json:"3,omitempty"` HighResMetricThreshold *int64 `json:"4,omitempty"` }
Usage limits for one or more aspects of host-based pricing. Each limit has a key that's a numeric string, and a numeric value: <br> * \"1\": Max number of hosts that can use this token * \"2\": Max number of Docker containers that can use this token * \"3\": Max number of custom metrics that can be sent with this token * \"4\": Max number of hi-res metrics that can be sent with this token