GetServiceProvisions - - Centre de documentation Alibaba Cloud

Description

Cette rubrique explique comment interroger le statut d'activation et les rôles RAM d'un service Alibaba Cloud. Dans cet exemple, nous interrogeons le service Elastic High Performance Computing (E-HPC) déployé dans la région Chine (Hangzhou).

Remarque

Assurez-vous de disposer des autorisations nécessaires pour l'opération

GetRole

.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour plus de commodité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	GetServiceProvisions	L'action à effectuer. Définissez la valeur sur GetServiceProvisions.
RegionId	String	Yes	cn-hangzhou	ID de la région. Appelez l'opération DescribeRegions pour obtenir la liste des régions les plus récentes.
TemplateBody	String	No	{"ROSTemplateFormatVersion": "2015-09-01","Resources": {"ApiGateway": {"Type": "ALIYUN::ApiGateway::Group","Properties": { "GroupName": "ros_example" }},"FC": {"Type": "ALIYUN::FC::Service","Properties": {"ServiceName": "ros_example"}}}}	Structure contenant le corps du modèle. La taille du corps du modèle doit être comprise entre 1 et 524 288 octets. Si la taille du corps du modèle dépasse cette limite, nous vous recommandons d'ajouter les paramètres au corps de la requête HTTP POST afin d'éviter les échecs de requête dus à des URL trop longues. Spécifiez un seul des paramètres suivants : TemplateBody, TemplateURL, TemplateId ou Services.N.ServiceName.
TemplateURL	String	No	oss://ros-template/demo	URL du fichier contenant le corps du modèle. L'URL doit pointer vers un modèle hébergé sur un serveur web HTTP ou HTTPS, ou dans un bucket Alibaba Cloud Object Storage Service (OSS), par exemple oss://ros/template/demo ou oss://ros/template/demo?RegionId=cn-hangzhou. La taille du corps du modèle doit être comprise entre 1 et 524 288 octets. Si vous ne spécifiez pas l'ID de région du bucket OSS, la valeur du paramètre RegionId est utilisée. Spécifiez un seul des paramètres suivants : TemplateBody, TemplateURL, TemplateId ou Services.N.ServiceName.
TemplateId	String	No	5ecd1e10-b0e9-4389-a565-e4c15efc****	ID du modèle. Ce paramètre s'applique aux modèles partagés et privés. Spécifiez un seul des paramètres suivants : TemplateBody, TemplateURL, TemplateId ou Services.N.ServiceName.
TemplateVersion	String	No	v1	Version du modèle. Si vous ne spécifiez pas ce paramètre, la dernière version est utilisée. Ce paramètre prend effet uniquement lorsque le paramètre TemplateId est spécifié.
Parameters.N.ParameterKey	String	Yes	Amount	Nom du paramètre N. Si vous ne spécifiez pas le nom et la valeur d'un paramètre, Resource Orchestration Service (ROS) utilise les valeurs par défaut définies dans le modèle. Remarque Le paramètre Parameters est facultatif. Si vous spécifiez le paramètre Parameters, vous devez également spécifier le paramètre Parameters.N.ParameterKey.
Parameters.N.ParameterValue	String	Yes	12	Valeur du paramètre N. Remarque Le paramètre Parameters est facultatif. Si vous spécifiez le paramètre Parameters, vous devez également spécifier le paramètre Parameters.N.ParameterValue.
Services.N.ServiceName	String	Yes	EHPC	Nom du service N ou de la fonctionnalité N. Valeurs valides : AHAS : Application High Availability Service ARMS : Application Real-Time Monitoring Service (ARMS) ApiGateway : API Gateway BatchCompute : Batch Compute BrainIndustrial : Industrial Brain CloudStorageGateway : Cloud Storage Gateway (CSG) CMS : CloudMonitor CR : Container Registry CS : Container Service for Kubernetes (ACK) DCDN : Dynamic Route for CDN (DCDN) DataHub : DataHub DataWorks : DataWorks EDAS : Enterprise Distributed Application Service (EDAS) E-HPC : Elastic High Performance Computing (E-HPC) EMAS : Enterprise Mobile Application Studio (EMAS) FC : Function Compute FNF : Serverless Workflow (SWF) MaxCompute : MaxCompute MNS : Message Service (MNS) HBR : Hybrid Backup Recovery (HBR) IMM : Intelligent Media Management IOT : IoT Platform KMS : Key Management Service (KMS) NAS : Apsara File Storage NAS (NAS) NLP : Natural Language Processing (NLP) OSS : OSS OTS : Tablestore PrivateLink : PrivateLink PrivateZone : Alibaba Cloud DNS PrivateZone RocketMQ : Message Queue for Apache RocketMQ SAE : Serverless App Engine (SAE) SLS : Log Service TrafficMirror : la fonctionnalité de mise en miroir du trafic VS : Video Surveillance System Xtrace : Tracing Analysis

Pour plus d'informations sur les paramètres de requête communs, consultez la rubrique Paramètres communs.

Paramètres de réponse

Parameter	Type	Example	Description
RequestId	String	A9938C04-26AD-5EFA-B394-EA7866842DFF	ID de la requête.
ServiceProvisions	Array of ServiceProvision		Détails du service.
ServiceName	String	EHPC	Nom du service.
Status	String	Enabled	Statut d'activation du service. Valeurs valides : Enabled : Le service est activé. Disabled : Le service n'est pas activé. Unknown : Le statut d'activation du service est inconnu.
StatusReason	String	No permission.	Raison pour laquelle le service se trouve dans l'état Disabled ou Unknown. Remarque Ce paramètre est renvoyé si le paramètre Status est défini sur Disabled ou Unknown.
AutoEnableService	Boolean	false	Indique si l'activation automatique du service est définie dans le modèle. Valeurs valides : true : L'activation automatique du service est définie dans le modèle. false : L'activation manuelle du service est définie dans le modèle.
EnableURL	String	https://common-buy-intl.alibabacloud.com/?commodityCode=nas	URL pointant vers la page d'activation du service. Remarque Ce paramètre est renvoyé si le paramètre Status est défini sur Disabled.
RoleProvision	Object		Informations relatives au rôle RAM du service. Si ce paramètre est vide, aucun rôle RAM n'est associé au service.
AuthorizationURL	String	https://ehpc.console.alibabacloud.com/	URL d'autorisation du rôle RAM. Remarque Ce paramètre est renvoyé si le paramètre Created est défini sur false.
Roles	Array of Role		Rôles RAM du service.
RoleName	String	AliyunServiceRoleForEHPC	Nom du rôle RAM.
Created	Boolean	true	Indique si le rôle RAM a été créé. Valeurs valides : true false
Function	String	Default	Objectif d'utilisation du rôle RAM. Valeur par défaut : Default. Cette valeur indique que le rôle RAM est le rôle par défaut du service.
ApiForCreation	Object		Informations concernant l'opération API utilisée pour créer le rôle RAM.
ApiProductId	String	rds	ID du service Alibaba Cloud auquel appartient l'opération API.
ApiName	String	CreateServiceLinkedRole	Nom de l'opération API.
ApiType	String	Open	Type de l'opération API. Valeurs valides : Open : opération API publique Inner : opération API privée
Parameters	Map		Paramètres de l'opération API. Si un paramètre est une variable, utilisez le format ${Nom de la variable}. Seule la variable suivante est prise en charge : ${RegionId}.
DependentServiceNames	Array of String	NAS	Noms des services Alibaba Cloud dont dépend le service.

Exemples

Exemple de requête

http(s)://ros.aliyuncs.com/?Action=GetServiceProvisions
&RegionId=cn-hangzhou
&ServiceName=EHPC
&<Common request parameters>

Exemple de réponse réussie

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<GetServiceProvisionsResponse>
    <RequestId>A9938C04-26AD-5EFA-B394-EA7866842DFF</RequestId>
    <ServiceProvisions>
        <ServiceName>EHPC</ServiceName>
        <Status>Enabled</Status>
        <StatusReason>No permission.</StatusReason>
        <AutoEnableService>false</AutoEnableService>
        <EnableURL>https://common-buy-intl.alibabacloud.com/?commodityCode=nas</EnableURL>
        <RoleProvision>
            <AuthorizationURL>https://ehpc.console.alibabacloud.com/</AuthorizationURL>
            <Roles>
                <RoleName>AliyunServiceRoleForEHPC</RoleName>
                <Created>true</Created>
                <Function>Default</Function>
                <ApiForCreation>
                    <ApiProductId>rds</ApiProductId>
                    <ApiName>CreateServiceLinkedRole</ApiName>
                    <ApiType>Open</ApiType>
                </ApiForCreation>
            </Roles>
        </RoleProvision>
        <DependentServiceNames>NAS</DependentServiceNames>
    </ServiceProvisions>
</GetServiceProvisionsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "A9938C04-26AD-5EFA-B394-EA7866842DFF",
  "ServiceProvisions" : {
    "ServiceName" : "EHPC",
    "Status" : "Enabled",
    "StatusReason" : "No permission.",
    "AutoEnableService" : false,
    "EnableURL" : "https://common-buy-intl.alibabacloud.com/?commodityCode=nas",
    "RoleProvision" : {
      "AuthorizationURL" : "https://ehpc.console.alibabacloud.com/",
      "Roles" : {
        "RoleName" : "AliyunServiceRoleForEHPC",
        "Created" : true,
        "Function" : "Default",
        "ApiForCreation" : {
          "ApiProductId" : "rds",
          "ApiName" : "CreateServiceLinkedRole",
          "ApiType" : "Open"
        }
      }
    },
    "DependentServiceNames" : "NAS"
  }
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, consultez la rubrique Codes d'erreur de service.