DataRobot APIのリソース > APIリファレンスドキュメント > DataRobot REST API > Mitigation > Humility

Mitigation Humility¶

This page outlines the operations, endpoints, parameters, and example requests and responses for the Mitigation Humility.

GET /api/v2/deployments/{deploymentId}/humilityStats/¶

Retrieve humility rule service triggers statistics overview.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/humilityStats/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
start	query	string,null(date-time)	false	Start of the period to retrieve monitoring data, defaults to 7 days ago from the end of the period. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: `2019-08-01T00:00:00Z`.
end	query	string,null(date-time)	false	End of the period to retrieve monitoring data, defaults to the next top of the hour. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: `2019-08-01T00:00:00Z`.
bucketSize	query	string(duration)	false	The time duration of a bucket. Needs to be multiple of one hour. Can not be longer than the total length of the period. If not set, a default value will be calculated based on the start and end time.
modelId	query	string	false	The id of the model for which metrics are being retrieved.
segmentAttribute	query	string	false	The name of a segment attribute used for segment analysis.
segmentValue	query	string,null	false	The value of the `segmentAttribute` to segment on.
deploymentId	path	string	true	Unique identifier of the deployment.

Enumerated Values¶

Parameter	Value
segmentAttribute	[`DataRobot-Consumer`, `DataRobot-Remote-IP`, `DataRobot-Host-IP`]

Example responses¶

200 Response


{
  "data": [
    {
      "ruleId": "string",
      "ruleName": "string",
      "value": 0
    }
  ],
  "modelId": "string",
  "period": {
    "end": "2019-08-24T14:15:22Z",
    "start": "2019-08-24T14:15:22Z"
  },
  "segmentAttribute": "string",
  "segmentValue": ""
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Humility service health statistics overview retrieved.	HumilityStatsResponse
403	Forbidden	Model Deployments and/or Monitoring are not enabled.	None
404	Not Found	Either the deployment does not exist or user does not have permission to view the deployment.	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/deployments/{deploymentId}/humilityStatsOverTime/¶

Retrieve humility service statistics over time.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/humilityStatsOverTime/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
start	query	string,null(date-time)	false	Start of the period to retrieve monitoring data, defaults to 7 days ago from the end of the period. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: `2019-08-01T00:00:00Z`.
end	query	string,null(date-time)	false	End of the period to retrieve monitoring data, defaults to the next top of the hour. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: `2019-08-01T00:00:00Z`.
bucketSize	query	string(duration)	false	The time duration of a bucket. Needs to be multiple of one hour. Can not be longer than the total length of the period. If not set, a default value will be calculated based on the start and end time.
modelId	query	string	false	The id of the model for which metrics are being retrieved.
segmentAttribute	query	string	false	The name of a segment attribute used for segment analysis.
segmentValue	query	string,null	false	The value of the `segmentAttribute` to segment on.
deploymentId	path	string	true	Unique identifier of the deployment.

Enumerated Values¶

Parameter	Value
segmentAttribute	[`DataRobot-Consumer`, `DataRobot-Remote-IP`, `DataRobot-Host-IP`]

Example responses¶

200 Response


{
  "buckets": [
    {
      "period": {
        "end": "2019-08-24T14:15:22Z",
        "start": "2019-08-24T14:15:22Z"
      },
      "values": [
        {
          "ruleId": "string",
          "ruleName": "string",
          "value": 0
        }
      ]
    }
  ],
  "modelId": "string",
  "segmentAttribute": "string",
  "segmentValue": "",
  "summary": {
    "period": {
      "end": "2019-08-24T14:15:22Z",
      "start": "2019-08-24T14:15:22Z"
    },
    "values": [
      {
        "ruleId": "string",
        "ruleName": "string",
        "value": 0
      }
    ]
  }
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Humility statistics for deployment retrieved.	HumilityStatsOverTimeResponse
403	Forbidden	Model Deployments and/or Monitoring are not enabled.	None
404	Not Found	Either the deployment does not exist or user does not have permission to view the deployment.	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

Schemas¶

HumilityStatsBucket


{
  "period": {
    "end": "2019-08-24T14:15:22Z",
    "start": "2019-08-24T14:15:22Z"
  },
  "values": [
    {
      "ruleId": "string",
      "ruleName": "string",
      "value": 0
    }
  ]
}

A bucket object covering whole start/end time range

Properties¶

Name	Type	Required	Restrictions	Description
period	TimeRange	true		An object with the keys "start" and "end" defining the period.
values	[HumilityStatsRule]	true		Rules response objects.

HumilityStatsOverTimeResponse


{
  "buckets": [
    {
      "period": {
        "end": "2019-08-24T14:15:22Z",
        "start": "2019-08-24T14:15:22Z"
      },
      "values": [
        {
          "ruleId": "string",
          "ruleName": "string",
          "value": 0
        }
      ]
    }
  ],
  "modelId": "string",
  "segmentAttribute": "string",
  "segmentValue": "",
  "summary": {
    "period": {
      "end": "2019-08-24T14:15:22Z",
      "start": "2019-08-24T14:15:22Z"
    },
    "values": [
      {
        "ruleId": "string",
        "ruleName": "string",
        "value": 0
      }
    ]
  }
}

Properties¶

Name	Type	Required	Description
buckets	[HumilityStatsBucket]	true	An array of `bucket` objects, representing service health stats of the deployment over time
modelId	string	false	The id of the model for which metrics are being retrieved.
segmentAttribute	string,null	false	The name of the segment on which segment analysis is being performed.
segmentValue	string,null	false	The value of the `segmentAttribute` to segment on.
summary	HumilityStatsBucket	true	A `bucket` object covering whole `start`/`end` time range

HumilityStatsResponse


{
  "data": [
    {
      "ruleId": "string",
      "ruleName": "string",
      "value": 0
    }
  ],
  "modelId": "string",
  "period": {
    "end": "2019-08-24T14:15:22Z",
    "start": "2019-08-24T14:15:22Z"
  },
  "segmentAttribute": "string",
  "segmentValue": ""
}

Properties¶

Name	Type	Required	Description
data	[HumilityStatsRule]	true	metrics rules
modelId	string	false	The id of the model for which metrics are being retrieved.
period	TimeRange	true	An object with the keys "start" and "end" defining the period.
segmentAttribute	string,null	false	The name of the segment on which segment analysis is being performed.
segmentValue	string,null	false	The value of the `segmentAttribute` to segment on.

HumilityStatsRule


{
  "ruleId": "string",
  "ruleName": "string",
  "value": 0
}

Properties¶

Name	Type	Required	Description
ruleId	string	true	Id of the humility rule.
ruleName	string	true	Name of the rule.
value	integer	true	Number of times the rule was triggered.

TimeRange


{
  "end": "2019-08-24T14:15:22Z",
  "start": "2019-08-24T14:15:22Z"
}

An object with the keys "start" and "end" defining the period.

Properties¶

Name	Type	Required	Restrictions	Description
end	string,null(date-time)	false		End of the period to retrieve monitoring data, defaults to the next top of the hour. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: `2019-08-01T00:00:00Z`.
start	string,null(date-time)	false		Start of the period to retrieve monitoring data, defaults to 7 days ago from the end of the period. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: `2019-08-01T00:00:00Z`.

更新しました 2025年3月27日

このページは役に立ちましたか？

ありがとうございます。どのような点が役に立ちましたか？

より良いコンテンツを提供するには、どうすればよいでしょうか？

アンケートにご協力いただき、ありがとうございました。