Tous les produits
Search

Ce produit

    Managed Service for Prometheus:GetPrometheusInstance

    Centre de documentation

    Managed Service for Prometheus:GetPrometheusInstance

    Dernière mise à jour :Aug 18, 2026

    Obtient les informations d'une instance Prometheus spécifiée.

    Testez maintenant

    Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

    Test

    Autorisation RAM

    Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

    • Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.

    • API : l'API que vous pouvez appeler pour exécuter l'action.

    • Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.

    • Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.

      • Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.

      • Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.

    • Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.

    • Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

    arms:GetPrometheusInstance

    get

    *Prometheus.

    acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}

    		 Aucune Aucune

    Paramètres de requête

    Paramètre

    Type

    Requis

    Description

    Exemple
    RegionId

    string

    Oui

    L'identifiant de la région.

    cn-hangzhou
    ClusterId

    string

    Oui

    L'identifiant de l'instance Prometheus.

    c77f6f2397ea74672872acf5e31374a27

    Éléments de réponse

    Élément

    Type

    Description

    Exemple

    object

    Schéma de la réponse.

    RequestId

    string

    L'identifiant de la requête.

    52C422FD-6B43-524D-B8A1-A4693294318C
    Message

    string

    Le message renvoyé pour le résultat.

    message
    Code

    integer

    Le code d'état. La valeur 200 indique un succès. Les autres valeurs indiquent des erreurs.

    200
    Data

    object

    Les informations renvoyées.

    ClusterId

    string

    L'identifiant de l'instance Prometheus.

    c589a1b8db05c4561aefbb898ca8fb1cf
    RegionId

    string

    L'identifiant de la région.

    cn-beijing
    UserId

    string

    L'identifiant de l'utilisateur.

    167275301789****
    ClusterName

    string

    Le nom du cluster.

    prom1
    ClusterType

    string

    remote-write (Prometheus pour usage général).

    remote-write
    VpcId

    string

    Le VPC associé au cluster. Ce paramètre n'est renvoyé que pour les instances Prometheus pour ECS.

    vpc-8vb02uk57qbcktqcvqqqj
    VSwitchId

    string

    L'identifiant du vSwitch. Ce paramètre n'est renvoyé que pour les instances Prometheus pour ECS.

    vsw-f8z73vcja1tqnw90aav5a
    SecurityGroupId

    string

    L'identifiant du groupe de sécurité. Ce paramètre n'est renvoyé que pour les instances Prometheus pour ECS.

    sg-8vbdgmf4nraiqa9bx0jo
    SubClustersJson

    string

    La chaîne JSON des sous-instances pour l'instance GlobalView.

    [{"headers":{},"regionId":"cn-hangzhou","sourceType":"AlibabaPrometheus","extras":{},"clusterId":"c39a1048921e04fceb039db2fbb73***","sourceName":"arms-luyao-test","dataSource":"","userId":"167275301789***"},{"headers":{},"regionId":"cn-beijing","sourceType":"AlibabaPrometheus","extras":{},"clusterId":"c6b6485496d5b400abde22cb47b5****","sourceName":"agent-321-测试","dataSource":"","userId":"1672753017899***"},{"headers":{},"regionId":"cn-zhangjiakou","sourceType":"AlibabaPrometheus","extras":{},"clusterId":"c261a4f3200c446659133f1ade789b15e","sourceName":"zaifeng-cardinality-01","dataSource":"","userId":"167275301789***"}]
    RemoteReadIntraUrl

    string

    Le point de terminaison interne pour la lecture à distance.

    http://cn-beijing-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/xxx/api/v1/read
    RemoteReadInterUrl

    string

    Le point de terminaison public pour la lecture à distance.

    http://cn-beijing.arms.aliyuncs.com:9090/api/v1/prometheus/xxx/api/v1/read
    RemoteWriteIntraUrl

    string

    Le point de terminaison interne pour l'écriture à distance.

    http://cn-beijing-intranet.arms.aliyuncs.com/prometheus/xxx/api/v3/write
    RemoteWriteInterUrl

    string

    Le point de terminaison public pour l'écriture à distance.

    https://cn-beijing.arms.aliyuncs.com/prometheus/xxx/api/v3/write
    PushGatewayIntraUrl

    string

    Le point de terminaison interne pour la passerelle push.

    http://cn-beijing-intranet.arms.aliyuncs.com/prometheus/xxx/api/v2
    PushGatewayInterUrl

    string

    Le point de terminaison public pour la passerelle push.

    https://cn-beijing.arms.aliyuncs.com/prometheus/xxx/api/v2
    OpenTelemetryInterUrl

    string

    HttpApiIntraUrl

    string

    Le point de terminaison interne pour l'API HTTP.

    http://cn-beijing-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/xxx
    HttpApiInterUrl

    string

    Le point de terminaison public pour l'API HTTP.

    https://cn-beijing.arms.aliyuncs.com:9443/api/v1/prometheus/xxx
    AuthToken

    string

    La chaîne du jeton d'autorisation.

    GciOiJIUzI1NiJ9***
    AccessType

    string

    Le type d'autorisation. Valeurs valides :

    readWrite
    PaymentType

    string

    La méthode de facturation. Valeurs valides :

    PREPAY
    StorageDuration

    integer

    La durée de stockage, en jours.

    90
    ArchiveDuration

    integer

    Le nombre de jours pendant lesquels les données sont automatiquement archivées après l'expiration de la période de stockage. Valeurs valides : 60, 90, 180 et 365. La valeur 0 indique que les données ne sont pas archivées.

    60
    GrafanaInstanceId

    string

    L'identifiant de l'espace de travail Grafana.

    grafana-rnggfvhlcdl6m71***
    ResourceGroupId

    string

    L'identifiant du groupe de ressources auquel l'instance appartient.

    rg-aek2vezare****
    ResourceType

    string

    La valeur fixe : PROMETHEUS.

    PROMETHEUS
    EnableAuthToken

    string

    Indique si l'authentification par jeton d'accès est activée.

    true
    SupportAuthTypes

    array

    Les types d'authentification pris en charge.

    string

    Les types d'authentification pris en charge.

    Valeurs valides :

    • BasicAuth :

      Authentification de base HTTP.

    • AuthFree :

      Sans authentification.

    • AuthToken :

      Authentification basée sur des jetons.

    AuthFree
    EnableAuthFreeRead

    boolean

    Indique si la lecture sans authentification est activée.

    AuthFreeReadPolicy

    string

    La stratégie de liste blanche pour les adresses de lecture sans authentification.

    0.0.0.0/0
    EnableAuthFreeWrite

    boolean

    Indique si l'écriture sans authentification est activée.

    AuthFreeWritePolicy

    string

    La stratégie de liste blanche pour les adresses d'écriture sans authentification.

    0.0.0.0/0
    Product

    string

    Le produit auquel l'instance Prometheus appartient (arms ou cms).

    arms
    DbInstanceStatus

    string

    L'état du stockage des données backend.

    RUNNING
    Version

    string

    La version.

    V1
    PaymentTypeUpdateTime

    string

    L'heure à laquelle la méthode de facturation de l'instance a été modifiée pour la dernière fois.

    2025-02-26T06:05:01Z
    ExtraInfo

    object

    Les informations supplémentaires. Ce paramètre n'est renvoyé que pour les requêtes de la console.

    string

    Informations supplémentaires.

    extraKey
    Tags

    array<object>

    Les balises associées à l'instance.

    object

    La balise.

    TagKey

    string

    La clé de la balise.

    tag1
    TagValue

    string

    La valeur de la balise.

    tagValue1
    OpenTelemetryIntraUrl

    string

    Exemples

    JSON format

    {
  "RequestId": "52C422FD-6B43-524D-B8A1-A4693294318C",
  "Message": "message",
  "Code": 200,
  "Data": {
    "ClusterId": "c589a1b8db05c4561aefbb898ca8fb1cf",
    "RegionId": "cn-beijing",
    "UserId": "167275301789****",
    "ClusterName": "prom1",
    "ClusterType": "remote-write",
    "VpcId": "vpc-8vb02uk57qbcktqcvqqqj",
    "VSwitchId": "vsw-f8z73vcja1tqnw90aav5a",
    "SecurityGroupId": "sg-8vbdgmf4nraiqa9bx0jo",
    "SubClustersJson": "[{\"headers\":{},\"regionId\":\"cn-hangzhou\",\"sourceType\":\"AlibabaPrometheus\",\"extras\":{},\"clusterId\":\"c39a1048921e04fceb039db2fbb73***\",\"sourceName\":\"arms-luyao-test\",\"dataSource\":\"\",\"userId\":\"167275301789***\"},{\"headers\":{},\"regionId\":\"cn-beijing\",\"sourceType\":\"AlibabaPrometheus\",\"extras\":{},\"clusterId\":\"c6b6485496d5b400abde22cb47b5****\",\"sourceName\":\"agent-321-测试\",\"dataSource\":\"\",\"userId\":\"1672753017899***\"},{\"headers\":{},\"regionId\":\"cn-zhangjiakou\",\"sourceType\":\"AlibabaPrometheus\",\"extras\":{},\"clusterId\":\"c261a4f3200c446659133f1ade789b15e\",\"sourceName\":\"zaifeng-cardinality-01\",\"dataSource\":\"\",\"userId\":\"167275301789***\"}]",
    "RemoteReadIntraUrl": "http://cn-beijing-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/xxx/api/v1/read",
    "RemoteReadInterUrl": "http://cn-beijing.arms.aliyuncs.com:9090/api/v1/prometheus/xxx/api/v1/read",
    "RemoteWriteIntraUrl": "http://cn-beijing-intranet.arms.aliyuncs.com/prometheus/xxx/api/v3/write",
    "RemoteWriteInterUrl": "https://cn-beijing.arms.aliyuncs.com/prometheus/xxx/api/v3/write",
    "PushGatewayIntraUrl": "http://cn-beijing-intranet.arms.aliyuncs.com/prometheus/xxx/api/v2",
    "PushGatewayInterUrl": "https://cn-beijing.arms.aliyuncs.com/prometheus/xxx/api/v2",
    "OpenTelemetryInterUrl": "",
    "HttpApiIntraUrl": "http://cn-beijing-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/xxx",
    "HttpApiInterUrl": "https://cn-beijing.arms.aliyuncs.com:9443/api/v1/prometheus/xxx",
    "AuthToken": "GciOiJIUzI1NiJ9***",
    "AccessType": "readWrite",
    "PaymentType": "PREPAY",
    "StorageDuration": 90,
    "ArchiveDuration": 60,
    "GrafanaInstanceId": "grafana-rnggfvhlcdl6m71***",
    "ResourceGroupId": "rg-aek2vezare****",
    "ResourceType": "PROMETHEUS",
    "EnableAuthToken": "true",
    "SupportAuthTypes": [
      "AuthFree"
    ],
    "EnableAuthFreeRead": false,
    "AuthFreeReadPolicy": "0.0.0.0/0",
    "EnableAuthFreeWrite": false,
    "AuthFreeWritePolicy": "0.0.0.0/0",
    "Product": "arms",
    "DbInstanceStatus": "RUNNING",
    "Version": "V1",
    "PaymentTypeUpdateTime": "2025-02-26T06:05:01Z",
    "ExtraInfo": {
      "key": "extraKey"
    },
    "Tags": [
      {
        "TagKey": "tag1",
        "TagValue": "tagValue1"
      }
    ],
    "OpenTelemetryIntraUrl": ""
  }
}

    Codes d'erreur

    Consultez Codes d'erreur pour la liste complète.

    Notes de version

    Consultez Notes de version pour la liste complète.