이 페이지는 아직 한국어로 제공되지 않으며 번역 작업 중입니다. 번역에 관한 질문이나 의견이 있으시면 언제든지 저희에게 연락해 주십시오.

Software Catalog

API to create, update, retrieve and delete Software Catalog entities.

Get a list of entities

v2 (latest)

GET https://api.ap1.datadoghq.com/api/v2/catalog/entityhttps://api.datadoghq.eu/api/v2/catalog/entityhttps://api.ddog-gov.com/api/v2/catalog/entityhttps://api.datadoghq.com/api/v2/catalog/entityhttps://api.us3.datadoghq.com/api/v2/catalog/entityhttps://api.us5.datadoghq.com/api/v2/catalog/entity

개요

Get a list of entities from Software Catalog. This endpoint requires the apm_service_catalog_read authorization scope.

인수

쿼리 문자열

이름

유형

설명

page[offset]

integer

Specific offset to use as the beginning of the returned page.

page[limit]

integer

Maximum number of entities in the response.

fitler[id]

string

Filter entities by UUID

fitler[ref]

string

Filter entities by reference

fitler[name]

string

Filter entities by name

fitler[kind]

string

Filter entities by kind

fitler[owner]

string

Filter entities by owner

fitler[relation][type]

enum

Filter entities by relation type
Allowed enum values: RelationTypeOwns, RelationTypeOwnedBy, RelationTypeDependsOn, RelationTypeDependencyOf, RelationTypePartsOf, RelationTypeHasPart, RelationTypeOtherOwns, RelationTypeOtherOwnedBy, RelationTypeImplementedBy, RelationTypeImplements

fitler[exclude_snapshot]

string

Filter entities by excluding snapshotted entities

include

enum

include relationship data
Allowed enum values: schema, raw_schema, oncall, incident, relation

응답

List entity response.

Expand All

항목

유형

설명

data

[object]

List of entity data.

included

[ <oneOf>]

List entity response included.

Option 1

object

Included detail entity schema.

attributes

object

Included schema.

schema

<oneOf>

Entity schema v3.

Option 1

object

Schema for service entities

Option 2

object

Schema for datastore entities

Option 3

object

Schema for queue entities

Option 4

object

Schema for system entities

links

object

List entity response links.

meta

object

Entity metadata.

{
  "data": [
    {
      "attributes": {
        "apiVersion": "string",
        "description": "string",
        "displayName": "string",
        "kind": "string",
        "name": "string",
        "namespace": "string",
        "owner": "string",
        "tags": []
      },
      "id": "string",
      "meta": {
        "createdAt": "string",
        "ingestionSource": "string",
        "modifiedAt": "string",
        "origin": "string"
      },
      "relationships": {
        "incidents": {
          "data": [
            {
              "id": "string",
              "type": "string"
            }
          ]
        },
        "oncall": {
          "data": [
            {
              "id": "string",
              "type": "string"
            }
          ]
        },
        "rawSchema": {
          "data": {
            "id": "string",
            "type": "string"
          }
        },
        "relatedEntities": {
          "data": [
            {
              "id": "string",
              "type": "string"
            }
          ]
        },
        "schema": {
          "data": {
            "id": "string",
            "type": "string"
          }
        }
      },
      "type": "string"
    }
  ],
  "included": [
    {
      "attributes": {
        "schema": {
          "apiVersion": "v3",
          "datadog": {
            "codeLocations": [
              {
                "paths": [],
                "repositoryURL": "string"
              }
            ],
            "events": [
              {
                "name": "string",
                "query": "string"
              }
            ],
            "logs": [
              {
                "name": "string",
                "query": "string"
              }
            ],
            "performanceData": {
              "tags": []
            },
            "pipelines": {
              "fingerprints": []
            }
          },
          "extensions": {},
          "integrations": {
            "opsgenie": {
              "region": "string",
              "serviceURL": "https://www.opsgenie.com/service/shopping-cart"
            },
            "pagerduty": {
              "serviceURL": "https://www.pagerduty.com/service-directory/Pshopping-cart"
            }
          },
          "kind": "service",
          "metadata": {
            "additionalOwners": [
              {
                "name": "",
                "type": "string"
              }
            ],
            "contacts": [
              {
                "contact": "https://slack/",
                "name": "string",
                "type": "slack"
              }
            ],
            "description": "string",
            "displayName": "string",
            "id": "4b163705-23c0-4573-b2fb-f6cea2163fcb",
            "inheritFrom": "application:default/myapp",
            "links": [
              {
                "name": "mylink",
                "provider": "string",
                "type": "link",
                "url": "https://mylink"
              }
            ],
            "managed": {},
            "name": "myService",
            "namespace": "default",
            "owner": {
              "name": "string"
            },
            "tags": [
              "this:tag",
              "that:tag"
            ]
          },
          "spec": {
            "dependsOn": [],
            "languages": [],
            "lifecycle": "string",
            "tier": "string",
            "type": "string"
          }
        }
      },
      "id": "string",
      "type": "string"
    }
  ],
  "links": {
    "next": "string",
    "previous": "string",
    "self": "string"
  },
  "meta": {
    "count": "integer",
    "includeCount": "integer"
  }
}

Forbidden

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

코드 사례

                  # Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/catalog/entity" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

                

Create or update entities

v2 (latest)

POST https://api.ap1.datadoghq.com/api/v2/catalog/entityhttps://api.datadoghq.eu/api/v2/catalog/entityhttps://api.ddog-gov.com/api/v2/catalog/entityhttps://api.datadoghq.com/api/v2/catalog/entityhttps://api.us3.datadoghq.com/api/v2/catalog/entityhttps://api.us5.datadoghq.com/api/v2/catalog/entity

개요

Create or update entities in Software Catalog. This endpoint requires the apm_service_catalog_write authorization scope.

요청

Body Data (required)

Entity YAML/JSON.

Expand All

항목

유형

설명

Option 1

<oneOf>

Entity schema v3.

Option 1

object

Schema for service entities

Option 2

object

Schema for datastore entities

Option 3

object

Schema for queue entities

Option 4

object

Schema for system entities

Option 2

string

Entity definition in raw JSON/YAML representation.

{
  "apiVersion": "v3",
  "datadog": {
    "codeLocations": [
      {
        "paths": []
      }
    ],
    "events": [
      {}
    ],
    "logs": [
      {}
    ],
    "performanceData": {
      "tags": []
    },
    "pipelines": {
      "fingerprints": []
    }
  },
  "integrations": {
    "opsgenie": {
      "serviceURL": "https://www.opsgenie.com/service/shopping-cart"
    },
    "pagerduty": {
      "serviceURL": "https://www.pagerduty.com/service-directory/Pshopping-cart"
    }
  },
  "kind": "service",
  "metadata": {
    "additionalOwners": [],
    "contacts": [
      {
        "contact": "https://slack/",
        "type": "slack"
      }
    ],
    "id": "4b163705-23c0-4573-b2fb-f6cea2163fcb",
    "inheritFrom": "application:default/myapp",
    "links": [
      {
        "name": "mylink",
        "type": "link",
        "url": "https://mylink"
      }
    ],
    "name": "service-examplesoftwarecatalog",
    "tags": [
      "this:tag",
      "that:tag"
    ]
  },
  "spec": {
    "dependsOn": [],
    "languages": []
  }
}

응답

ACCEPTED

Upsert entity response.

Expand All

항목

유형

설명

data

[object]

List of entity data.

included

[ <oneOf>]

Upsert entity response included.

Option 1

object

Included detail entity schema.

attributes

object

Included schema.

schema

<oneOf>

Entity schema v3.

Option 1

object

Schema for service entities

Option 2

object

Schema for datastore entities

Option 3

object

Schema for queue entities

Option 4

object

Schema for system entities

meta

object

Entity metadata.

{
  "data": [
    {
      "attributes": {
        "apiVersion": "string",
        "description": "string",
        "displayName": "string",
        "kind": "string",
        "name": "string",
        "namespace": "string",
        "owner": "string",
        "tags": []
      },
      "id": "string",
      "meta": {
        "createdAt": "string",
        "ingestionSource": "string",
        "modifiedAt": "string",
        "origin": "string"
      },
      "relationships": {
        "incidents": {
          "data": [
            {
              "id": "string",
              "type": "string"
            }
          ]
        },
        "oncall": {
          "data": [
            {
              "id": "string",
              "type": "string"
            }
          ]
        },
        "rawSchema": {
          "data": {
            "id": "string",
            "type": "string"
          }
        },
        "relatedEntities": {
          "data": [
            {
              "id": "string",
              "type": "string"
            }
          ]
        },
        "schema": {
          "data": {
            "id": "string",
            "type": "string"
          }
        }
      },
      "type": "string"
    }
  ],
  "included": [
    {
      "attributes": {
        "schema": {
          "apiVersion": "v3",
          "datadog": {
            "codeLocations": [
              {
                "paths": [],
                "repositoryURL": "string"
              }
            ],
            "events": [
              {
                "name": "string",
                "query": "string"
              }
            ],
            "logs": [
              {
                "name": "string",
                "query": "string"
              }
            ],
            "performanceData": {
              "tags": []
            },
            "pipelines": {
              "fingerprints": []
            }
          },
          "extensions": {},
          "integrations": {
            "opsgenie": {
              "region": "string",
              "serviceURL": "https://www.opsgenie.com/service/shopping-cart"
            },
            "pagerduty": {
              "serviceURL": "https://www.pagerduty.com/service-directory/Pshopping-cart"
            }
          },
          "kind": "service",
          "metadata": {
            "additionalOwners": [
              {
                "name": "",
                "type": "string"
              }
            ],
            "contacts": [
              {
                "contact": "https://slack/",
                "name": "string",
                "type": "slack"
              }
            ],
            "description": "string",
            "displayName": "string",
            "id": "4b163705-23c0-4573-b2fb-f6cea2163fcb",
            "inheritFrom": "application:default/myapp",
            "links": [
              {
                "name": "mylink",
                "provider": "string",
                "type": "link",
                "url": "https://mylink"
              }
            ],
            "managed": {},
            "name": "myService",
            "namespace": "default",
            "owner": {
              "name": "string"
            },
            "tags": [
              "this:tag",
              "that:tag"
            ]
          },
          "spec": {
            "dependsOn": [],
            "languages": [],
            "lifecycle": "string",
            "tier": "string",
            "type": "string"
          }
        }
      },
      "id": "string",
      "type": "string"
    }
  ],
  "meta": {
    "count": "integer",
    "includeCount": "integer"
  }
}

Bad Request

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Forbidden

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

코드 사례

                          # Curl command
curl -X POST "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/catalog/entity" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
  "apiVersion": "v3",
  "datadog": {
    "codeLocations": [
      {
        "paths": []
      }
    ],
    "events": [
      {}
    ],
    "logs": [
      {}
    ],
    "performanceData": {
      "tags": []
    },
    "pipelines": {
      "fingerprints": []
    }
  },
  "integrations": {
    "opsgenie": {
      "serviceURL": "https://www.opsgenie.com/service/shopping-cart"
    },
    "pagerduty": {
      "serviceURL": "https://www.pagerduty.com/service-directory/Pshopping-cart"
    }
  },
  "kind": "service",
  "metadata": {
    "additionalOwners": [],
    "contacts": [
      {
        "contact": "https://slack/",
        "type": "slack"
      }
    ],
    "id": "4b163705-23c0-4573-b2fb-f6cea2163fcb",
    "inheritFrom": "application:default/myapp",
    "links": [
      {
        "name": "mylink",
        "type": "link",
        "url": "https://mylink"
      }
    ],
    "name": "service-examplesoftwarecatalog",
    "tags": [
      "this:tag",
      "that:tag"
    ]
  },
  "spec": {
    "dependsOn": [],
    "languages": []
  }
}
EOF

                        

Delete a single entity

v2 (latest)

DELETE https://api.ap1.datadoghq.com/api/v2/catalog/entity/{entity_id}https://api.datadoghq.eu/api/v2/catalog/entity/{entity_id}https://api.ddog-gov.com/api/v2/catalog/entity/{entity_id}https://api.datadoghq.com/api/v2/catalog/entity/{entity_id}https://api.us3.datadoghq.com/api/v2/catalog/entity/{entity_id}https://api.us5.datadoghq.com/api/v2/catalog/entity/{entity_id}

개요

Delete a single entity in Software Catalog. This endpoint requires the apm_service_catalog_write authorization scope.

인수

경로 파라미터

이름

유형

설명

entity_id [required]

string

UUID or Entity Ref

응답

Bad Request

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Forbidden

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Not Found

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

코드 사례

                  # Path parameters
export entity_id="service:myservice"
# Curl command
curl -X DELETE "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/catalog/entity/${entity_id}" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

                

Software Catalog

Get a list of entities

개요

인수

쿼리 문자열

응답

코드 사례

Get a list of entities

Create or update entities

개요

요청

Body Data (required)

응답

코드 사례

Create or update software catalog entity using schema v3 returns "ACCEPTED" response

Delete a single entity

개요

인수

경로 파라미터

응답

코드 사례

Delete a single entity