創建可觀測可視化 Grafana 版工作區實例。
接口說明
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| arms:CreateGrafanaWorkspace | create | *GrafanaWorkspace acs:arms:{#regionId}:{#AccountId}:grafanaworkspace/* |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| 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! |
| AutoRenew | string | 否 | 是否自動續費。取值范圍：
默認值：true。 | false |
| PricingCycle | string | 否 | 包年包月的計費周期，取值： Month（默認值）：按月購買。 Year：按年購買。 | Month |
| Duration | string | 否 | 實例包年包月的時間，取值：
默認值：1。 | 6 |
| AccountNumber | string | 否 | 賬號數量。 取值說明：
| 10 |
| CustomAccountNumber | string | 否 | 用戶額外自定義賬號數量。 取值說明：
| 0 |
| AliyunLang | string | 否 | 語言環境（若不填，默認為 zh）：
| zh |
| ResourceGroupId | string | 否 | Prometheus 實例的資源組 ID。 | rg-acfmxyexli2**** |
| 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. | 獲取用戶信息失敗，建議重試。如果多次重試報錯請聯系釘釘服務賬號。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-12-06 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
| 2024-12-05 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |