このページは日本語には対応しておりません。随時翻訳に取り組んでいます。翻訳に関してご質問やご意見ございましたら、お気軽にご連絡ください。

Given a service ID or service name, return basic information about the service.

Inputs

Expand All

フィールド

種類

説明

serviceIdentification [required]

 <oneOf>

Select either the Service ID or the Service Name to identify your service.

Option 1

object

option [required]

string

Service name option for service identification.

serviceName [required]

string

Filters the result, showing only the services whose name matches the query.

Option 2

object

option [required]

string

Service ID option for service identification.

serviceId [required]

string

Filters the result, showing only the services whose ID within PagerDuty matches the query.

Outputs

Expand All

フィールド

種類

説明

service [required]

object

id

string

The service's id.

summary

string,null

Summary of the service.

type [required]

string

Type of the service.

self

uri

API URL at which the service is accessible.

html_url

uri

The URL for this service within PagerDuty.

name

string

The name of the service.

description

string,null

The description of the service.

auto_resolve_timeout

number,null

Time in seconds that an incident is automatically resolved if left open for that long.

acknowledgement_timeout

number,null

Time in seconds that an incident changes to the Triggered State after being Acknowledged.

created_at

date-time

The date/time when this service was created.

updated_at

date-time

The date/time when this service was updated.

status

string

The current state of the Service.

last_incident_timestamp

date-time

The current state of the Service.

escalation_policy [required]

object

Escalation policy of the Service.

type [required]

string

Type of the escalation policy.

id [required]

string

ID of the escalation policy.

summary

string

Summary of the escalation policy.

self

uri

API URL at which the escalation policy is accessible.

html_url

uri

The URL for this escalation policy within PagerDuty.

teams

[object]

The set of teams associated with this service.

type [required]

string

The type of the team.

id [required]

string

The team's ID within PagerDuty.

summary

string

The team's name.

self

uri

API URL at which the team is accessible.

html_url

uri

The URL for the team within PagerDuty.

incident_urgency_rule

object

Incident urgency rule.

type

enum

The type of incident urgency. Allowed enum values: constant,use_support_hours

urgency

enum

The incidents' urgency, if type is constant. Allowed enum values: low,high,severity_based

during_support_hours

object

The incident urgency during support hours: whether it's constant, or it's dependent on the support hours.

type

enum

The type of incident urgency. Allowed enum values: constant,use_support_hours

urgency

enum

The incidents' urgency, if type is constant. Allowed enum values: low,high,severity_based

outside_support_hours

object

The incident urgency outside support hours: whether it's constant, or it's dependent on the support hours.

type

enum

The type of incident urgency. Allowed enum values: constant,use_support_hours

urgency

enum

The incidents' urgency, if type is constant. Allowed enum values: low,high,severity_based

support_hours

object

Support hours.

type

string

Type of support hours.

time_zone

string

The time zone for the support hours.

days_of_week

[number]

The days of the week for support.

start_time

time

The support hours' starting time of day.

end_time

time

The support hours' ending time of day.

scheduled_actions

[object]

Scheduled actions for the service.

type [required]

string

Type of the scheduled action.

at [required]

object

Represents when scheduled action will occur.

type [required]

string

Type of the scheduled action.

name [required]

string

Designates either the start or the end of support hours.

to_urgency [required]

string

Urgency level.

addons

[object]

The array of Add-ons associated with this service.

src [required]

uri

The URL source of the Addon.

name [required]

string

Name of the add-on.

type [required]

string

Type of the add-on.

id [required]

string

ID of the add-on.

summary [required]

string

Summary of the add-on.

self [required]

uri

API URL at which the add-on is accessible.

html_url [required]

uri

The URL for this add-on within PagerDuty.

alert_creation

string

Whether a service creates only incidents, or both alerts and incidents.

alert_grouping

string

Defines how alerts on this service will be automatically grouped into incidents.

alert_grouping_parameters

object

Defines how alerts on this service will be automatically grouped into incidents.

type

string

Type of the Alert grouping parameters.

config

object

Configuration for Intelligent Alert Grouping.

time_window

number

The maximum amount of time allowed between Alerts.

recommended_time_window

number

alert_grouping_timeout

number

The duration in minutes within which to automatically group incoming alerts.

response_play

[object]

Response plays associated with this service.

type [required]

string

Type of the reponse play.

id [required]

string

ID of the reponse play.

summary

string

Summary of the reponse play.

self

uri

API URL at which the reponse play is accessible.

html_url

uri

The URL for this reponse play within PagerDuty.