コンテンツにスキップ

取得¶

GET /api/v1/service_manage/{service_uuid}/get

概要¶

個別のサービスリスト情報を取得します

ルートパラメータ¶

パラメータ名	型	必須	説明
service_uuid	string	Y	サービスに対応する uuid 例: xxxx 空文字列の許可: False

クエリパラメータ¶

パラメータ名	型	必須	説明
originStr	string		元の文字列を返す場合は1、構造化データを返す場合は0。デフォルトは1 空の許可: False

パラメータ補足説明¶

リクエスト本文の構造説明

パラメータ名	type	必須	説明
service_uuid	string	Y	サービスリストの一意の uuid。プレフィックスは sman_
originStr	string	N	返される serviceCatelog を元の文字列にする必要があるかどうか。1 の場合ははい、0 の場合はいいえ。デフォルトは 1

レスポンス本文の構造説明

パラメータ名	type	説明
serviceCatelog	string, dict	サービスリストの元の文字列または構造化データ
service	string	サービス名
type	string	サービスタイプ

リクエスト例¶

curl 'https://openapi.guance.com/api/v1/service_manage/sman_xxxx32/get?originStr=0' \
  -H 'Content-Type: application/json' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  --compressed

レスポンス¶

{
    "code": 200,
    "content": {
        "colour": "#40C9C9",
        "createAt": 1693798688,
        "creatorInfo": {
            "acntWsNickname": "",
            "email": "xxx",
            "iconUrl": "",
            "name": "Alibaba Cloud Monitoring Data Source",
            "username": "xxx"
        },
        "service": "test",
        "serviceCatelog": {
            "Docs": [
                {
                    "link": "https://docs.guance.com/ja",
                    "name": "guance",
                    "provider": "example_yun"
                },
                {
                    "link": "https://func.guance.com/doc",
                    "name": "func",
                    "provider": "example_yun"
                }
            ],
            "Related": {
                "AppId": "a138bcb0_47ef_11ee_9d75_31ea50b9d85a",
                "DashboardUUIDs": [
                    "dsbd_xxxx32",
                    "dsbd_xxxx32"
                ],
                "Tags": [
                    "mysql",
                    "test"
                ]
            },
            "Repos": [
                {
                    "link": "https://www.guance.com",
                    "name": "guance",
                    "provider": "example_yun"
                },
                {
                    "link": "https://func.guance.com",
                    "name": "func",
                    "provider": "example_yun"
                }
            ],
            "Team": {
                "colour": "#40C9C9",
                "oncall": [
                    {
                        "emails": [
                            "xxx@guance.com",
                            "xxx@guance.com"
                        ],
                        "name": "example_yun",
                        "type": "email"
                    },
                    {
                        "mobiles": [
                            "xxxxxxx5786",
                            "xxxxxxx4231"
                        ],
                        "name": "zhuyun",
                        "type": "mobile"
                    },
                    {
                        "name": "test",
                        "slack": "#test",
                        "type": "slack"
                    }
                ],
                "service": "jinlei_1",
                "team": "group_xxxx32",
                "type": "db"
            }
        },
        "type": "db",
        "updateAt": 1693798688,
        "updatorInfo": {
            "acntWsNickname": "",
            "email": "xxx",
            "iconUrl": "",
            "name": "Alibaba Cloud Monitoring Data Source",
            "username": "xxx"
        },
        "uuid": "sman_xxxx32"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-1255F7E2-9035-4696-B7EE-9DDBB2BC13D2"
}