@ dynatrace-sdk/客户端-平台-管理-服务
概览
关于当前登录环境的基本只读信息安装
npm install @dynatrace-sdk/client-platform-management-service
获得帮助
- 访问 用于打字的 SDK 指南中 Dynatrace 开发者
- 问个问题 Dynatrace社区
许可证
此 SDK 分布于 Apache 许可证,2.0版本,更多信息见LICENSE.
API 参考
最新版本SDK的API 完整参考文件也可在 Dynatrace 开发者。 。 。 .
有效许可
import { effectivePermissionsClient } from '@dynatrace-sdk/client-platform-management-service';
解析有效任务
在环境中获取呼叫用户的有效权限
需要以下范围之一:
- app-engine:apps:运行
- 应用程序引擎: 函数: 运行
- 平台管理: 有效许可:解决
此端点决定了调用者( 调用此端点时根据提供的 OAuth 令牌) 是否拥有请求的权限( 见 IAM 政策参考 许可清单及其条件。 它通过IAM解决许可,并使用可选上下文来评价有条件的结果. 提供的上下文包括: key 必须符合所请求许可的辅助条件的名称和 value 是指根据给定的用户政策评估该条件的价值.
对于每项请求的许可,答复表明用户是否拥有请求的许可(第1段)"granted": "true"),没有"granted": "false")或仅有条件("granted": "condition")),指为上下文条件提供的值不足以决定呼叫者是否拥有许可.
对于环境API v2 范围(即从环境-api开始的范围:),也将考虑环境和管理区一级的作用.
> i️ 设置权限 范围请求 settings:schemas:read, (中文(简体) ), settings:objects:read,以及 settings:objects:write 最终结果 "granted": "condition"。您可以使用专用的有效权限端点来进行设置.
> iQQ Apps 必须列出他们在列表中检查的所有权限 scopes 在他们的应用配置.
您可以更多地了解查询用户权限 Dynatrace 开发者。 。 。 .
参数
| 名称 | 类型 |
|---|---|
| 配置. 身体*必须 | 决议要求 |
掷出
| 错误类型 | 错误消息 |
|---|---|
| 默认错误回复 | 意外错误 |
代码示例
import { effectivePermissionsClient } from "@dynatrace-sdk/client-platform-management-service";
const data =
await effectivePermissionsClient.resolveEffectivePermissions(
{
body: {
permissions: [
{ permission: "state:app-states:write" },
],
},
},
);
环境
import { environmentInformationClient } from '@dynatrace-sdk/client-platform-management-service';
获取环境信息
获取基本环境信息
需要以下范围之一:
- app-engine:apps:运行
- 应用程序引擎: 函数: 运行
- 平台管理:环境:已读
获取当前环境的基本信息.
回返
| 返回类型 | 状态代码 | 说明 |
|---|---|---|
| 环境信息 | 200个 | 请求的环境信息 . |
掷出
| 错误类型 | 错误消息 |
|---|---|
| 错误请求 | 错误的请求 |
| 未经授权 | 认证失败 |
| 无果 | 未找到资源 |
| 服务不可用 | 后端有一个临时问题 . |
| 默认错误回复 | 意外错误 |
代码示例
import { environmentInformationClient } from "@dynatrace-sdk/client-platform-management-service";
const data =
await environmentInformationClient.getEnvironmentInformation();
环境设置
import { environmentSettingsClient } from '@dynatrace-sdk/client-platform-management-service';
获得环境安排
获取环境设置
需要以下范围之一:
- app-engine:apps:运行
- 应用程序引擎: 函数: 运行
- 平台管理:环境:已读
获取环境设置 .
回返
| 返回类型 | 状态代码 | 说明 |
|---|---|---|
| 设置响应 | 200个 | 请求环境的设置 |
掷出
| 错误类型 | 错误消息 |
|---|---|
| 错误请求 | 错误的请求 |
| 未经授权 | 认证失败 |
| 无果 | 未找到资源 |
| 服务不可用 | 后端有一个临时问题 . |
| 默认错误回复 | 意外错误 |
代码示例
import { environmentSettingsClient } from "@dynatrace-sdk/client-platform-management-service";
const data =
await environmentSettingsClient.getEnvironmentSettings();
许可证信息客户
import { licenseInformationClient } from '@dynatrace-sdk/client-platform-management-service';
获取语录
获取基本许可证信息
需要以下范围之一:
- app-engine:apps:运行
- 应用程序引擎: 函数: 运行
- 平台管理:环境:已读
获取当前环境的基本许可信息.
回返
| 返回类型 | 状态代码 | 说明 |
|---|---|---|
| 许可证 | 200个 | 申请环境的许可证信息 . |
掷出
| 错误类型 | 错误消息 |
|---|---|
| 错误请求 | 错误的请求 |
| 未经授权 | 认证失败 |
| 无果 | 未找到资源 |
| 服务不可用 | 后端有一个临时问题 . |
| 默认错误回复 | 意外错误 |
代码示例
import { licenseInformationClient } from "@dynatrace-sdk/client-platform-management-service";
const data = await licenseInformationClient.getLicense();
获得License安排
获取基本许可证设置信息
需要以下范围之一:
- app-engine:apps:运行
- 应用程序引擎: 函数: 运行
- 平台管理:环境:已读
获取当前环境的基本许可设置信息
参数
| 名称 | 类型 | 说明 |
|---|---|---|
| 配置. keys | 矩阵 <字符串> 翻译: | 用于过滤的可选密钥数组 示例 [] |
回返
| 返回类型 | 状态代码 | 说明 |
|---|---|---|
| 许可证安排回复 | 200个 | 请求环境的许可证设置信息 . |
掷出
| 错误类型 | 错误消息 |
|---|---|
| 错误请求 | 错误的请求 |
| 未经授权 | 认证失败 |
| 无果 | 未找到资源 |
| 服务不可用 | 后端有一个临时问题 . |
| 默认错误回复 | 意外错误 |
代码示例
import { licenseInformationClient } from "@dynatrace-sdk/client-platform-management-service";
const data =
await licenseInformationClient.getLicenseSettings();
类型
有效许可
| 名称 | 类型 | 说明 |
|---|---|---|
| 上下文 | 矩阵 <权限链接> 翻译: | |
| 获准*必须 | "真""假""条件" | 真:来电者有许可假:来电者没有许可条件: 呼叫者有条件地获得许可,或者在范围从"Environment-api:"开始的情况下,呼叫者只获得特定管理区的许可. 示例 true |
| 权限*必须 | 字符串 | 示例 state:app-states:write |
有效许可
类型: 阵列 <有效许可> 翻译:
环境信息
| 名称 | 类型 |
|---|---|
| 块时间 | 日期 |
| 创建时间*必须 | 日期 |
| 环境编号*必须 | 字符串 |
| 状态*必须 | "BEING CREATED""CREATED NOT-INITIALID""相去相去""相去相去""相去相去""相去相去""相去相去""相去相去相去""相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相 |
| 类型*必须 | "INTERNAL""CUSTOMER""SELF MINTORING" 互联网电影数据库(IMDB)上"CUSTOMER"的资料(英文) |
错误
标准错误反应
| 名称 | 类型 | 说明 |
|---|---|---|
| 代码*必须 | 编号 | 示例 500 |
| 细节 | 错误细节 | |
| 消息*必须 | 字符串 | 示例 Internal server error |
错误细节
| 名称 | 类型 |
|---|---|
| 失踪 | 矩阵 <字符串> 翻译: |
| 缺少缩写 | 矩阵 <字符串> 翻译: |
信封错误
| 名称 | 类型 | 说明 |
|---|---|---|
| 错误*必须 | 错误 | 标准错误反应 |
许可证
| 名称 | 类型 |
|---|---|
| 平台订阅*必须 | 布尔 |
| 审判*必须 | 布尔 |
许可证设置
| 名称 | 类型 |
|---|---|
| 键*必须 | 字符串 |
| 价值*必须 | 字符串 |
许可证安排回复
| 名称 | 类型 |
|---|---|
| 设置*必须 | 矩阵 <许可证设置> 翻译: |
权限链接
| 名称 | 类型 | 说明 |
|---|---|---|
| 键*必须 | 字符串 | 示例 shared:app-id |
| 价值*必须 | 字符串 | 示例 dynatrace.notebooks |
决议要求
| 名称 | 类型 |
|---|---|
| 权限*必须 | 矩阵 <单一许可请求> 翻译: |
设置响应
| 名称 | 类型 | 说明 |
|---|---|---|
| 正在运行的文本订阅结束 | 日期 | 试验期结束的日期. 示例 2025-04-25T10:08:09.193592Z |
| 聊天已启用*必须 | 布尔 | |
| 国家代码 | 字符串 | ISO3166-1α-2 二个字母国家代码. 见: https://en.wikipedia.org/wiki/ISO 3166-1 alpha-2 互联网档案馆的存檔,存档日期2014-12-2 示例 ES |
单一许可请求
可选的通用上下文数据集
| 名称 | 类型 | 说明 |
|---|---|---|
| 上下文 | 无效QQ阵列 <权限链接> 翻译: | |
| 权限*必须 | 字符串 | 示例 state:app-states:write |
数字
有效许可
⚠️ 折旧 使用字面值.
真:来电者有许可假:来电者没有许可条件: 呼叫者有条件地获得许可,或者在范围从"Environment-api:"开始的情况下,呼叫者只获得特定管理区的许可.
Enum 键
Condition | False | True
环境信息类型
⚠️ 折旧 使用字面值.
Enum 键
Customer | Internal | SelfMonitoring
环境状态
⚠️ 折旧 使用字面值.
Enum 键
Active | BeingCreated | BeingDeleted | Blocked | CreatedNotInitialized | Deactivated | DeletionFailed | PreAllocated