Référence de l'API HappyOyster-Directing-Delete World - Alibaba Cloud Model Studio

Supprimer un monde de mise en scène sous le compte principal actuel. Lorsque le monde n'existe plus sous le même compte, l'opération retourne deleted=false de manière idempotente.

Scope

Supprimer un monde de mise en scène sous le compte principal actuel. Avant d'effectuer l'appel, confirmer les points suivants :

Authentification : Seule la clé API principale est prise en charge ; les clés API temporaires ne peuvent pas être utilisées (code d'erreur 403003).
- Obtenir la clé API principale : Obtenir et configurer une clé API.
Prérequis : Supprimer avec l'encryptedWorldId retourné par Créer un monde.
Appelant : Appelé par votre serveur. Ce point de terminaison n'accepte pas le champ de corps de requête userAgent.

Requête HTTP

Singapore

POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/worlds/delete

Remplacez {WorkspaceId} par votre véritable ID d'espace de travail.

États-Unis (Virginie)

POST https://{WorkspaceId}.us-east-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/worlds/delete

Remplacez {WorkspaceId} par votre véritable ID d'espace de travail.

Paramètres de la requête	Supprimer le Monde `curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/worlds/delete' \ -H "Authorization: Bearer $DASHSCOPE_API_KEY" \ -H 'Content-Type: application/json' \ -d '{ "encryptedWorldId": "{encryptedWorldId}" }'`
Content-Type`string`(Requis) Type de contenu de la requête. Ce paramètre doit être défini sur `application/json`.
Authorization `string` (Requis) Authentification par clé API. Seule la clé API principale est prise en charge ; elle commence par `sk-`, par ex. `sk-xxx`. Elle est généralement configurée comme variable d'environnement `$DASHSCOPE_API_KEY`. Une clé API temporaire (commençant par `st-`) renvoie `403003`.
Corps de la requête
encryptedWorldId `string` (Requis) L'ID de monde chiffré de mise en scène à supprimer. Retourné par Créer un monde.

Paramètres de réponse

Supprimé avec succès

{
    "code": 0,
    "message": null,
    "data": {
        "encryptedWorldId": "enc_a1b2****",
        "deleted": true
    }
}

Le Monde n'existe plus

{
    "code": 0,
    "message": null,
    "data": {
        "encryptedWorldId": "enc_a1b2****",
        "deleted": false
    }
}

code integer

Code de retour. 0 indique un succès ; une valeur non nulle correspond à un code d'erreur.

message string

Message d'erreur. null en cas de succès.

data object

Données de réponse. null en cas d'échec.

Propriétés

encryptedWorldId string

L'ID de Monde chiffré provenant de la requête.

deleted boolean

true signifie qu'il a été supprimé ; false signifie qu'aucun Monde n'a été supprimé cette fois-ci.

États préalables et notes d'appel

Lorsque le Monde n'existe plus sous le même compte, cela renvoie code=0 et deleted=false, et non 403001.
Lorsque l'ID est analysable mais appartient à un autre compte, ne correspond pas à l'espace de travail, ou que la ressource n'est pas un monde de mise en scène, 403001 est retourné.
Après la suppression, les requêtes ultérieures sur ce monde sont traitées comme une ressource inexistante ou supprimée.

Codes d'erreur

Si l'appel du modèle échoue et renvoie une erreur, consultez Codes d'erreur HappyOyster pour la résoudre.

Étapes suivantes

Interroger la liste des mondes : consulter les mondes de mise en scène restants.
Créer un monde : créer un nouveau monde de mise en scène.