Résiliez un seul siège inutilisé.
Prérequis
Vous avez obtenu l'AccessKey d'un compte Alibaba Cloud ou d'un utilisateur RAM, et l'identité s'est vu accorder les autorisations RAM nécessaires pour appeler BssOpenApi. Nous vous recommandons de définir l'AccessKey comme variables d'environnement ALIBABA_CLOUD_ACCESS_KEY_ID et ALIBABA_CLOUD_ACCESS_KEY_SECRET plutôt que de le coder en dur.
Vous avez obtenu l'InstanceId du siège à résilier. Vous pouvez l'obtenir à partir de l'InstanceCode renvoyé par Obtenir les détails des sièges de l'abonnement. Seuls les sièges n'ayant pas utilisé de Credits peuvent être résiliés.
Description de la requête
-
Méthode HTTP:POST
-
URL de la requête
Région
Endpoint
Singapour
-
Authentification
Cette opération appartient à BssOpenApi (version
2023-09-30) et utilise des signatures RPC AccessKey (HMAC-SHA1). Le schémaAuthorization: Bearer {API_KEY}n'est pas pris en charge. Nous vous recommandons de l'appeler avec la classeCommonRequestd'un SDK Alibaba Cloud. Le SDK génère les paramètres communs et calcule la signature automatiquement.
Paramètres de la requête
Tous les paramètres sont transmis sous forme de données de formulaire ou dans la chaîne de requête. Les paramètres de tableau utilisent le format Flat : Configs.1.Code et Configs.1.Value, l'index commençant à 1.
Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
ProductCode | string | Oui | Code produit. Obtenez-le en appelant |
ProductType | string | Oui | Type de produit. Obtenez-le en appelant |
SubscriptionType | string | Oui | Type d'abonnement. Obtenez-le en appelant |
ClientToken | string | Oui | Jeton d'idempotence. Générez-le côté client et rendez-le unique entre les requêtes. Longueur maximale : 64 caractères ASCII. |
InstanceId | string | Oui | ID de l'instance de siège à résilier. Seuls les sièges n'ayant pas utilisé de Credits sont pris en charge. |
Le Success externe indique si la requête a été acceptée. Utilisez Data.Success pour déterminer le résultat du remboursement. En cas d'échec, consultez Data.ErrorInfo et Data.ErrorCode.
Paramètres de réponse
Paramètre | Type | Description |
|---|---|---|
RequestId | string | ID de la requête. |
Success | boolean | Indique si la requête a réussi. |
Code | string | Code de résultat. La valeur est |
Message | string | Message de résultat. |
Data | object | Données métier. |
Data.InstanceId | string | ID d'instance. |
Data.Success | boolean | Indique si le remboursement a réussi. |
Data.ErrorInfo | string | Informations d’erreur renvoyées lorsque le remboursement échoue. |
Data.ErrorCode | string | Code d'erreur renvoyé lorsque le remboursement échoue. |
Data.HostId | string | Identifiant du site. Ce champ peut être omis dans certaines réponses. |
AccessDeniedDetail | string | Informations détaillées sur l'erreur renvoyées lorsque les autorisations RAM sont refusées. |
Exemple de requête
Cette opération utilise les signatures RPC de BssOpenApi. Dans l'exemple suivant, ${SIGNATURE} doit être calculé avec l'algorithme de signature, et SignatureNonce et Timestamp doivent être remplacés par des valeurs réelles. Un SDK Alibaba Cloud gère automatiquement les paramètres communs et la signature.
curl -X POST "https://business.ap-southeast-1.aliyuncs.com/" \
--data-urlencode "Action=ReduceCreditSeats" \
--data-urlencode "Version=2023-09-30" \
--data-urlencode "Format=JSON" \
--data-urlencode "AccessKeyId=${ALIBABA_CLOUD_ACCESS_KEY_ID}" \
--data-urlencode "SignatureMethod=HMAC-SHA1" \
--data-urlencode "SignatureVersion=1.0" \
--data-urlencode "SignatureNonce=${SIGNATURE_NONCE}" \
--data-urlencode "Timestamp=2026-01-01T12:00:00Z" \
--data-urlencode "Signature=${SIGNATURE}" \
--data-urlencode "ProductCode=sfm" \
--data-urlencode "ProductType=sfm_tokenplanteams_dp_intl" \
--data-urlencode "SubscriptionType=Subscription" \
--data-urlencode "ClientToken=example-client-token-001" \
--data-urlencode "InstanceId=subs-example0000000004"
Exemple de réponse
{
"RequestId": "request-id-example",
"Success": true,
"Code": "Success",
"Message": "Successful!",
"Data": {
"Success": true
}
}
Codes d'erreur
Si l'appel échoue, un message d'erreur est renvoyé. Pour plus de codes d'erreur et de solutions, consultez Codes d'erreur BssOpenApi.