ベースライン ID を指定して、対応するベースラインの情報を照会します。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| BaselineId |
integer |
必須 |
ベースライン ID。この値は、ListBaselines 操作を呼び出して照会できます。 |
123456 |
| ProjectId |
integer |
必須 |
該当ベースラインが属するワークスペースの ID。この値は、ListBaselines 操作を呼び出して照会できます。 |
10000 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
OpenApiResultModel |
||
| Success |
boolean |
リクエストが成功したかどうかを示します。有効な値：
|
true |
| ErrorCode |
string |
エラーコード。 |
1031203110005 |
| ErrorMessage |
string |
エラーメッセージ。 |
The specified parameters are invalid |
| HttpStatusCode |
integer |
HTTP ステータスコード。 |
200 |
| Data |
object |
返却されるデータ。 |
|
| BaselineId |
integer |
ベースライン ID。 |
1001 |
| BaselineName |
string |
ベースライン名。 |
Test baseline |
| ProjectId |
integer |
ワークスペース ID。 |
10000 |
| Owner |
string |
オーナー。 |
9527952**** |
| Priority |
integer |
ベースラインの優先度。有効な値：1、3、5、7、8。 |
1 |
| BaselineType |
string |
ベースラインの種別。有効な値：
|
DAILY |
| OverTimeSettings |
array<object> |
ベースラインのコミット完了時刻の設定項目。 |
|
|
object |
|||
| Cycle |
integer |
コミット時刻に対応する期間。日次ベースラインでは 1、時間単位のベースラインでは最大 24 サイクルまで設定可能です。 |
1 |
| Time |
string |
コミット時刻（hh:mm 形式）。hh の有効範囲は [0, 47]、mm の有効範囲は [0, 59] です。 |
00:00 |
| Enabled |
boolean |
ベースラインが有効化されているかどうかを示します。 |
true |
| NodeIds |
array |
ノード ID のリスト。 |
|
|
integer |
ノード ID。 |
700003**** |
|
| AlertEnabled |
boolean |
アラート機能が有効化されているかどうかを示します。有効な値：
|
true |
| AlertMarginThreshold |
integer |
アラートマージンしきい値。単位：分。 |
60 |
| AlertSettings |
array<object> |
アラート設定項目。 |
|
|
array<object> |
ベースラインアラート構成 |
||
| AlertType |
string |
アラート種別
|
BASELINE |
| AlertMethods |
array |
アラート方法のリスト |
|
|
string |
アラート方法。有効な値は以下のとおりです：
|
|
|
| SilenceStartTime |
string |
サイレンス期間の開始時刻。形式：HH:mm:ss |
00:00:00 |
| SilenceEndTime |
string |
サイレンス期間の終了時刻。形式：HH:mm:ss。 |
00:00:00 |
| AlertInterval |
integer |
イベントアラート間隔（秒単位）。 |
900 |
| AlertMaximum |
integer |
イベントアラートの最大送信回数。 |
1 |
| DingRobots |
array<object> |
DingTalk ロボットのリスト。 |
|
|
object |
DingTalk ロボットの構成。 |
||
| WebUrl |
string |
DingTalk ロボットのアドレス。 |
https://oapi.dingtalk.com/robot/send?access_token=xxx |
| AtAll |
boolean |
全員に通知するかどうか。 |
true |
| Webhooks |
array |
Webhook のリスト。 |
|
|
string |
企業版 WeChat または Feishu（飛書）ロボットの Webhook アドレス。複数の Webhook アドレスをカンマ (,) で区切って指定します。alertMethods には WEBHOOKS を含める必要があります。DataWorks Enterprise Edition のみ対応しています。 対応リージョン：中国 (上海)、中国 (成都)、中国 (張家口)、中国 (北京)、中国 (杭州)、中国 (深セン)、中国 (香港)、中央ヨーロッパ 1 (フランクフルト)、東南アジア太平洋 1 (シンガポール)。 |
https://open.feishu.cn/open-apis/bot/v2/hook/xxx |
|
| TopicTypes |
array |
イベントアラートの種別リスト。 |
|
|
string |
イベントアラートの種別。
|
SLOW |
|
| BaselineAlertEnabled |
boolean |
ベースラインアラートの有効／無効スイッチ。
|
false |
| AlertRecipientType |
string |
アラート受信者の種別。
|
OWNER |
| AlertRecipient |
string |
アラート受信者の詳細情報。 AlertRecipientType が OWNER の場合：空欄 AlertRecipientType が SHIFT_SCHEDULE の場合：シフト勤務表の UID AlertRecipientType が OTHER の場合：UID のリスト（英字で区切り、複数の UID をカンマで区切ります） |
123123 |
| RequestId |
string |
リクエスト ID。 |
ecb967ec-c137-48a5-860**** |
例
成功レスポンス
JSONJSON
{
"Success": true,
"ErrorCode": "1031203110005",
"ErrorMessage": "The specified parameters are invalid",
"HttpStatusCode": 200,
"Data": {
"BaselineId": 1001,
"BaselineName": "Test baseline",
"ProjectId": 10000,
"Owner": "9527952****",
"Priority": 1,
"BaselineType": "DAILY",
"OverTimeSettings": [
{
"Cycle": 1,
"Time": "00:00"
}
],
"Enabled": true,
"NodeIds": [
0
],
"AlertEnabled": true,
"AlertMarginThreshold": 60,
"AlertSettings": [
{
"AlertType": "BASELINE",
"AlertMethods": [
"MAIL"
],
"SilenceStartTime": "00:00:00",
"SilenceEndTime": "00:00:00",
"AlertInterval": 900,
"AlertMaximum": 1,
"DingRobots": [
{
"WebUrl": "https://oapi.dingtalk.com/robot/send?access_token=xxx",
"AtAll": true
}
],
"Webhooks": [
"https://open.feishu.cn/open-apis/bot/v2/hook/xxx"
],
"TopicTypes": [
"SLOW"
],
"BaselineAlertEnabled": false,
"AlertRecipientType": "OWNER",
"AlertRecipient": "123123"
}
]
},
"RequestId": "ecb967ec-c137-48a5-860****"
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。