文档

CreateGrafanaWorkspace - 创建Grafana工作区

更新时间:

创建可观测可视化 Grafana 版工作区实例。

接口说明

请确保在使用该接口前,已充分了解可观测可视化 Grafana 版产品的收费方式和价格

说明
  • 创建可观测可视化 Grafana 版实例需要通过实名认证。您可以参见账号实名认证相关文档完成认证。
  • 普通用户只支持创建开发者版、专家版、高级版 (会产生费用)。
  • 内部测试用户只支持创建内测版(免费)。
  • 调试

    您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

    授权信息

    下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

    • 操作:是指具体的权限点。
    • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
    • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
      • 对于必选的资源类型,用背景高亮的方式表示。
      • 对于不支持资源级授权的操作,用全部资源表示。
    • 条件关键字:是指云产品自身定义的条件关键字。
    • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    arms:CreateGrafanaWorkspacecreate
    • GrafanaWorkspace
      acs:arms:{#regionId}:{#AccountId}:grafanaworkspace/*

    请求参数

    名称类型必填描述示例值
    RegionIdstring

    地域 ID。

    cn-hangzhou
    GrafanaWorkspaceNamestring

    Grafana 工作区名称。

    testgrafana
    GrafanaWorkspaceEditionstring

    版本。

    枚举值:

    • standard:内测版(内测版、标准版)。
    • personal_edition:开发者版。
    • experts_edition:专家版。
    • advanced_edition:高级版。
    experts_edition
    Descriptionstring

    Grafana 工作区描述。

    test
    GrafanaVersionstring

    Grafana 版本。

    10.0.x
    Passwordstring

    实例的密码。长度为 8 至 30 个字符,必须同时包含大小写英文字母、数字和特殊符号中的三类字符。特殊符号可以是:()`~!@#$%^&*-_+=

    Test123456!
    ResourceGroupIdstring

    Prometheus 实例的资源组 ID。

    rg-acfmxyexli2****
    AliyunLangstring

    语言环境(若不填,默认为 zh):

    • zh
    • en
    zh
    Tagsarray<object>

    标签。

    object

    标签。

    Keystring

    标签键。

    TestKey
    Valuestring

    标签值。

    TestValue

    返回参数

    名称类型描述示例值
    object

    Schema 返回值。

    RequestIdstring

    请求 ID。

    D80ADAAC-8C32-5479-BD14-C28CF832****
    DataGrafanaWorkspace

    Grafana 工作区信息。

    Messagestring

    返回结果的提示信息。

    success
    Codeinteger

    状态码。200 为成功,其他状态码为异常。

    200
    Successboolean

    是否创建成功。

    • true:修改成功
    • false:修改失败
    true
    TraceIdstring

    调用链 ID,用于精确查询调用信息。

    eac0a8048716731735000007137d000b

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "D80ADAAC-8C32-5479-BD14-C28CF832****",
      "Data": {
        "status": "Starting、Running、Stop、DeleteSucceed",
        "description": "线上生产环境Grafana",
        "grafanaWorkspaceEdition": "personal_edition、experts_edition、advanced_edition、standard",
        "endTime": 1652803200000,
        "grafanaWorkspaceId": "grafana-cn-4xl3g******",
        "upgradeVersion": [
          "9.0.x"
        ],
        "grafanaWorkspaceIp": "47.110.71.***:443",
        "snatIp": "47.110.71.***",
        "grafanaWorkspaceDomain": "my-grafana.grafana.aliyuncs.com:443",
        "grafanaWorkspaceDomainStatus": "on",
        "commercial": true,
        "grafanaWorkspaceName": "线上生产环境Grafana",
        "grafanaVersion": "9.0.x",
        "gmtCreate": 1642079398000,
        "userId": "1412143830******",
        "maxAccount": "10",
        "regionId": "cn-hangzhou",
        "protocol": "http、https",
        "shareSynced": true,
        "ntmId": "grafana-cn-4xl3g******",
        "personalDomain": "my-grafana.grafana.aliyuncs.com:443",
        "personalDomainPrefix": "my-grafana",
        "resourceGroupId": "rg-aek2f4vzrfs6cla",
        "deployType": "asi",
        "tags": [
          {
            "key": "TestKey",
            "value": "TestValue"
          }
        ],
        "privateIp": "192.168.1.1\n",
        "privateDomain": "my-grafana.grafana.aliyuncs.com:80"
      },
      "Message": "success",
      "Code": 200,
      "Success": true,
      "TraceId": "eac0a8048716731735000007137d000b"
    }

    错误码

    HTTP status code错误码错误信息描述
    400ParameterMissingYou must specify the parameter.必选参数缺失
    400ResourceIdIsIllegalThe specified ResourceId is invalid.参数ResourceId是非法的。
    400ParameterIllegalThe specified parameter is invalid.参数非法
    403RAMNotAuthorizeThe sub-account is not authorized and must be granted AliyunARMSFullAccess by a primary account.子账号没有访问权限,需主账号授予AliyunARMSFullAccess。
    403STSNotAuthorizeSTS authorization failed.STS权限校验失败
    403IllegalUserAccessIllegal user access.非法的用户访问
    500InternalErrorInternal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.内部错误,建议重试。如果多次重试报错请联系钉钉服务账号。
    500AccountUidAccessErrorFailed to obtain the user information. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.获取用户信息失败,建议重试。如果多次重试报错请联系钉钉服务账号。

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    暂无变更历史