创建可观测可视化 Grafana 版工作区实例。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
arms:CreateGrafanaWorkspace | create |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域 ID。 | cn-hangzhou |
GrafanaWorkspaceName | string | 是 | Grafana 工作区名称。 | testgrafana |
GrafanaWorkspaceEdition | string | 是 | 版本。 枚举值:
| experts_edition |
Description | string | 否 | Grafana 工作区描述。 | test |
GrafanaVersion | string | 是 | Grafana 版本。 | 10.0.x |
Password | string | 否 | 实例的密码。长度为 8 至 30 个字符,必须同时包含大小写英文字母、数字和特殊符号中的三类字符。特殊符号可以是:()`~!@#$%^&*-_+= | Test123456! |
ResourceGroupId | string | 否 | Prometheus 实例的资源组 ID。 | rg-acfmxyexli2**** |
AliyunLang | string | 否 | 语言环境(若不填,默认为 zh):
| zh |
Tags | array<object> | 否 | 标签。 | |
object | 否 | 标签。 | ||
Key | string | 否 | 标签键。 | TestKey |
Value | string | 否 | 标签值。 | TestValue |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | ParameterMissing | You must specify the parameter. | 必选参数缺失 |
400 | ResourceIdIsIllegal | The specified ResourceId is invalid. | 参数ResourceId是非法的。 |
400 | ParameterIllegal | The specified parameter is invalid. | 参数非法 |
403 | RAMNotAuthorize | The sub-account is not authorized and must be granted AliyunARMSFullAccess by a primary account. | 子账号没有访问权限,需主账号授予AliyunARMSFullAccess。 |
403 | STSNotAuthorize | STS authorization failed. | STS权限校验失败 |
403 | IllegalUserAccess | Illegal user access. | 非法的用户访问 |
500 | InternalError | Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries. | 内部错误,建议重试。如果多次重试报错请联系钉钉服务账号。 |
500 | AccountUidAccessError | Failed to obtain the user information. Please try again. Contact the DingTalk service account if the issue persists after multiple retries. | 获取用户信息失败,建议重试。如果多次重试报错请联系钉钉服务账号。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|
暂无变更历史