Het eindpunt van de gastheren

Last update: Thu Aug 10 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Onderwerpen:

Gemaakt voor:

Ontwikkelaar

NOTE

In dit document wordt beschreven hoe u hosts in de Reactor-API beheert. Voor meer algemene informatie over gastheren voor markeringen, zie de gids op Overzicht van hosts in de publicatiedocumentatie.

In de Reactor-API definieert een host een bestemming waarbij een build kan worden geleverd.

Wanneer een taggebruiker in Adobe Experience Platform om een build heeft gevraagd, controleert het systeem de Library om te bepalen welke milieu de bibliotheek moet worden gemaakt . Elke omgeving heeft een relatie met een host die aangeeft waar de build moet worden geleverd.

Een host behoort tot exact één host eigenschap, terwijl een eigenschap veel hosts kan hebben. Een eigenschap moet ten minste één host hebben voordat u deze kunt publiceren.

Een host kan door meerdere omgevingen binnen een eigenschap worden gebruikt. Het is gemeenschappelijk om één enkele gastheer op een bezit te hebben, en alle milieu's op dat bezit te hebben gebruiken de zelfde gastheer.

Aan de slag

Het eindpunt dat in deze handleiding wordt gebruikt, maakt deel uit van de Reactor-API. Controleer voordat je doorgaat de gids Aan de slag voor belangrijke informatie over hoe te voor authentiek te verklaren aan API.

Een lijst met hosts ophalen list

U kunt een lijst van gastheren voor een bezit terugwinnen door identiteitskaart van het bezit in de weg van een verzoek van de GET te omvatten.

API-indeling

GET /properties/{PROPERTY_ID}/hosts

Parameter

Beschrijving

PROPERTY_ID

De id van het bezit dat de gastheren bezit.

NOTE

Gebruikend vraagparameters, kunnen de vermelde gastheren worden gefiltreerd gebaseerd op de volgende attributen:

created_at
name
type_of
updated_at

filterreacties

Verzoek

curl -X GET \
  https://reactor.adobe.io/properties/PRd428c2a25caa4b32af61495f5809b737/hosts \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H "Content-Type: application/vnd.api+json" \
  -H 'Accept: application/vnd.api+json;revision=1'

Antwoord

Een succesvolle reactie keert een lijst van gastheren voor het gespecificeerde bezit terug.

{
  "data": [
    {
      "id": "HT405b8d9306004eb38106e66c8a4afc09",
      "type": "hosts",
      "attributes": {
        "created_at": "2020-12-14T17:42:35.239Z",
        "server": null,
        "name": "Example Akamai Host",
        "path": null,
        "port": null,
        "status": "succeeded",
        "type_of": "akamai",
        "updated_at": "2020-12-14T17:42:35.239Z",
        "username": null
      },
      "relationships": {
        "property": {
          "links": {
            "related": "https://reactor.adobe.io/hosts/HT405b8d9306004eb38106e66c8a4afc09/property"
          },
          "data": {
            "id": "PRd428c2a25caa4b32af61495f5809b737",
            "type": "properties"
          }
        }
      },
      "links": {
        "property": "https://reactor.adobe.io/properties/PRd428c2a25caa4b32af61495f5809b737",
        "self": "https://reactor.adobe.io/hosts/HT405b8d9306004eb38106e66c8a4afc09"
      }
    }
  ],
  "meta": {
    "pagination": {
      "current_page": 1,
      "next_page": null,
      "prev_page": null,
      "total_pages": 1,
      "total_count": 1
    }
  }
}

Een gastheer opzoeken lookup

U kunt een gastheer opzoeken door zijn identiteitskaart in de weg van een verzoek van de GET te verstrekken.

API-indeling

GET /hosts/{HOST_ID}

Parameter

Beschrijving

HOST_ID

De id van de host die u wilt opzoeken.

Verzoek

curl -X GET \
  https://reactor.adobe.io/hosts/HT5d90148e72224224aac9bc0b01498b84 \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H "Content-Type: application/vnd.api+json" \
  -H 'Accept: application/vnd.api+json;revision=1'

Antwoord

Een geslaagde reactie retourneert de details van de host.

{
  "data": {
    "id": "HT5d90148e72224224aac9bc0b01498b84",
    "type": "hosts",
    "attributes": {
      "created_at": "2020-12-14T17:42:25.353Z",
      "server": "https://server.example.com",
      "name": "Example Akamai Host",
      "path": "/akamai",
      "port": 8000,
      "status": "succeeded",
      "type_of": "akamai",
      "updated_at": "2020-12-14T17:42:25.353Z",
      "username": null
    },
    "relationships": {
      "property": {
        "links": {
          "related": "https://reactor.adobe.io/hosts/HT5d90148e72224224aac9bc0b01498b84/property"
        },
        "data": {
          "id": "PRd7cf174259f34057b5c435ef873a79bf",
          "type": "properties"
        }
      }
    },
    "links": {
      "property": "https://reactor.adobe.io/properties/PRd7cf174259f34057b5c435ef873a79bf",
      "self": "https://reactor.adobe.io/hosts/HT5d90148e72224224aac9bc0b01498b84"
    }
  }
}

Een host maken create

U kunt een nieuwe gastheer tot stand brengen door een verzoek van de POST te doen.

API-indeling

POST /properties/{PROPERTY_ID}/hosts

Parameter

Beschrijving

PROPERTY_ID

De id van de eigenschap dat u de host onder definieert.

Verzoek

Met het volgende verzoek wordt een nieuwe host voor de opgegeven eigenschap gemaakt. De vraag associeert ook de gastheer met een bestaande uitbreiding door relationships eigenschap. Zie de handleiding op relaties voor meer informatie .

curl -X POST \
  https://reactor.adobe.io/properties/PRb25a704c0b7c4562835ccdf96d3afd31/hosts \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'Content-Type: application/json' \
  -d '{
        "data": {
          "attributes": {
            "name": "Example SFTP Host",
            "type_of": "sftp",
            "username": "John Doe",
            "encrypted_private_key": "{PRIVATE_KEY}",
            "server": "https://example.com",
            "skip_symlinks": true,
            "path": "assets",
            "port": 22
          },
          "type": "hosts"
        }
      }'

Eigenschap

Beschrijving

attributes.name

(Vereist) Een leesbare naam voor de host.

attributes.type_of

(Vereist) Het type host. U kunt uit twee opties kiezen:

akamai for Door Adobe beheerde hosts
sftp for SFTP-hosts

attributes.encrypted_private_key

Een optionele persoonlijke sleutel die moet worden gebruikt voor hostverificatie.

attributes.path

Het pad dat aan de server URL.

attributes.port

Een geheel getal dat de specifieke serverpoort aangeeft die moet worden gebruikt.

attributes.server

De host-URL voor de server.

attributes.skip_symlinks

(Alleen voor SFTP-hosts)

Standaard gebruiken alle SFTP-hosts symbolische koppelingen (symbolische koppelingen) om te verwijzen naar bibliotheekbuilds die op de server zijn opgeslagen. Niet alle servers ondersteunen echter het gebruik van symlinks. Wanneer dit kenmerk wordt opgenomen en ingesteld op true, gebruikt de gastheer een exemplaarverrichting om de bouwstijlactiva direct bij te werken in plaats van symlinks te gebruiken.

attributes.username

Een optionele gebruikersnaam voor verificatie.

type

Het type resource dat wordt bijgewerkt. Voor dit eindpunt, moet de waarde hosts.

Antwoord

Een geslaagde reactie retourneert de details van de zojuist gemaakte host.

{
  "data": {
    "id": "HT69bfe634dead4a9a8c659f5d4d94cecd",
    "type": "hosts",
    "attributes": {
      "created_at": "2020-12-14T17:42:07.033Z",
      "server": "//example.com",
      "name": "Example SFTP Host",
      "path": "assets",
      "port": 22,
      "status": "pending",
      "skip_symlinks": true,
      "type_of": "sftp",
      "updated_at": "2020-12-14T17:42:07.033Z",
      "username": "John Doe"
    },
    "relationships": {
      "property": {
        "links": {
          "related": "https://reactor.adobe.io/hosts/HT69bfe634dead4a9a8c659f5d4d94cecd/property"
        },
        "data": {
          "id": "PRb25a704c0b7c4562835ccdf96d3afd31",
          "type": "properties"
        }
      }
    },
    "links": {
      "property": "https://reactor.adobe.io/properties/PRb25a704c0b7c4562835ccdf96d3afd31",
      "self": "https://reactor.adobe.io/hosts/HT69bfe634dead4a9a8c659f5d4d94cecd"
    }
  }
}

Een host bijwerken update

NOTE

Alleen SFTP-hosts kunnen worden bijgewerkt.

U kunt een gastheer bijwerken door zijn identiteitskaart in de weg van een verzoek van de PATCH te omvatten.

API-indeling

PATCH /hosts/{HOST_ID}

Parameter

Beschrijving

HOST_ID

De id van de host die u wilt bijwerken.

Verzoek

De volgende aanvraag werkt de name voor een bestaande host.

curl -X PATCH \
  https://reactor.adobe.io/hosts/HT5d90148e72224224aac9bc0b01498b84 \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'Content-Type: application/json' \
  -d '{
        "data": {
          "attributes": {
            "name": "New host Name"
          },
          "id": "HT5d90148e72224224aac9bc0b01498b84",
          "type": "hosts"
        }
      }'

Eigenschap

Beschrijving

attributes

Een object waarvan de eigenschappen de kenmerken vertegenwoordigen die voor de host moeten worden bijgewerkt. De volgende kenmerken kunnen voor een host worden bijgewerkt:

encrypted_private_key
name
path
port
server
type_of
username

id

De id van de gastheer wilt bijwerken. Dit moet overeenkomen met de {HOST_ID} waarde opgegeven in het aanvraagpad.

type

Het type resource dat wordt bijgewerkt. Voor dit eindpunt, moet de waarde hosts.

Antwoord

Een geslaagde reactie retourneert de details van de bijgewerkte host.

{
  "data": {
    "id": "HTb14e136a6fe147459b298a4645d2a6f5",
    "type": "hosts",
    "attributes": {
      "created_at": "2020-12-14T17:42:45.087Z",
      "server": null,
      "name": "My SFTP host",
      "path": null,
      "port": null,
      "status": "succeeded",
      "skip_symlinks": true,
      "type_of": "sftp",
      "updated_at": "2020-12-14T17:42:45.696Z",
      "username": null
    },
    "relationships": {
      "property": {
        "links": {
          "related": "https://reactor.adobe.io/hosts/HTb14e136a6fe147459b298a4645d2a6f5/property"
        },
        "data": {
          "id": "PR8f240526f7b54a4dbd46965e79519fde",
          "type": "properties"
        }
      }
    },
    "links": {
      "property": "https://reactor.adobe.io/properties/PR8f240526f7b54a4dbd46965e79519fde",
      "self": "https://reactor.adobe.io/hosts/HTb14e136a6fe147459b298a4645d2a6f5"
    }
  }
}

Een host verwijderen

U kunt een gastheer schrappen door zijn identiteitskaart in de weg van een verzoek van de DELETE op te nemen.

API-indeling

DELETE /hosts/{HOST_ID}

Parameter

Beschrijving

HOST_ID

De id van de host die u wilt verwijderen.

Verzoek

curl -X DELETE \
  https://reactor.adobe.io/hosts/HT5d90148e72224224aac9bc0b01498b84 \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}'

Antwoord

Een geslaagde reactie retourneert HTTP-status 204 (Geen inhoud) zonder antwoord, wat aangeeft dat de host is verwijderd.

Verwante bronnen voor een host ophalen related

De volgende vraag toont aan hoe te om de verwante middelen voor een gastheer terug te winnen. Wanneer zoeken naar een host, worden deze relaties vermeld in het relationships eigenschap.

Zie de relatiehulplijn voor meer informatie over relaties in de Reactor-API.

De verwante eigenschap voor een host opzoeken property

U kunt de eigenschap die eigenaar is van een host opzoeken door deze toe te voegen /property naar het pad van een opzoekverzoek.

API-indeling

GET /hosts/{HOST_ID}/property

Parameter

Beschrijving

{HOST_ID}

De id van de host waarvan u de eigenschap wilt opzoeken.

Verzoek

curl -X GET \
  https://reactor.adobe.io/hosts/HT5d90148e72224224aac9bc0b01498b84/property \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H "Content-Type: application/vnd.api+json" \
  -H 'Accept: application/vnd.api+json;revision=1'

Antwoord

Een succesvolle reactie keert de details van het gespecificeerde bezit van de gastheer terug.

{
  "data": {
    "id": "PRbdfaffb7bf374b87be50e672f0cf9309",
    "type": "properties",
    "attributes": {
      "created_at": "2020-12-14T17:52:05.900Z",
      "enabled": true,
      "name": "Kessel Example Property",
      "updated_at": "2020-12-14T17:52:05.900Z",
      "platform": "web",
      "development": false,
      "token": "47d65c7c98db",
      "domains": [
        "example.com"
      ],
      "undefined_vars_return_empty": false,
      "rule_component_sequencing_enabled": false
    },
    "relationships": {
      "company": {
        "links": {
          "related": "https://reactor.adobe.io/properties/PRbdfaffb7bf374b87be50e672f0cf9309/company"
        },
        "data": {
          "id": "CO2bf094214ffd4785bb4bcf88c952a7c1",
          "type": "companies"
        }
      },
      "callbacks": {
        "links": {
          "related": "https://reactor.adobe.io/properties/PRbdfaffb7bf374b87be50e672f0cf9309/callbacks"
        }
      },
      "hosts": {
        "links": {
          "related": "https://reactor.adobe.io/properties/PRbdfaffb7bf374b87be50e672f0cf9309/hosts"
        }
      },
      "environments": {
        "links": {
          "related": "https://reactor.adobe.io/properties/PRbdfaffb7bf374b87be50e672f0cf9309/environments"
        }
      },
      "libraries": {
        "links": {
          "related": "https://reactor.adobe.io/properties/PRbdfaffb7bf374b87be50e672f0cf9309/libraries"
        }
      },
      "data_elements": {
        "links": {
          "related": "https://reactor.adobe.io/properties/PRbdfaffb7bf374b87be50e672f0cf9309/data_elements"
        }
      },
      "extensions": {
        "links": {
          "related": "https://reactor.adobe.io/properties/PRbdfaffb7bf374b87be50e672f0cf9309/extensions"
        }
      },
      "rules": {
        "links": {
          "related": "https://reactor.adobe.io/properties/PRbdfaffb7bf374b87be50e672f0cf9309/rules"
        }
      },
      "notes": {
        "links": {
          "related": "https://reactor.adobe.io/properties/PRbdfaffb7bf374b87be50e672f0cf9309/notes"
        }
      }
    },
    "links": {
      "company": "https://reactor.adobe.io/companies/CO2bf094214ffd4785bb4bcf88c952a7c1",
      "data_elements": "https://reactor.adobe.io/properties/PRbdfaffb7bf374b87be50e672f0cf9309/data_elements",
      "environments": "https://reactor.adobe.io/properties/PRbdfaffb7bf374b87be50e672f0cf9309/environments",
      "extensions": "https://reactor.adobe.io/properties/PRbdfaffb7bf374b87be50e672f0cf9309/extensions",
      "rules": "https://reactor.adobe.io/properties/PRbdfaffb7bf374b87be50e672f0cf9309/rules",
      "self": "https://reactor.adobe.io/properties/PRbdfaffb7bf374b87be50e672f0cf9309"
    },
    "meta": {
      "rights": [
        "approve",
        "develop",
        "manage_environments",
        "manage_extensions",
        "publish"
      ]
    }
  }
}

recommendation-more-help

12b4e4a9-5028-4d88-8ce6-64a580811743