虚拟化网络功能性能管理接口 (VNF PM) v2¶
虚拟化网络功能性能管理接口 (VNF PM)¶
此接口管理 VNF 实例的 VNF 性能管理操作。
此接口允许提供与 VNF 相关的性能管理(测量结果收集和通知)。该接口的详细信息在 SOL002 v3.3.1 第 6 条中描述。某些特定标准的参数需要参考 SOL013 v3.4.1 第 5 条。
POST 方法创建新的 PM 作业。PM 作业将性能收集和报告信息的详细信息分组在一起。
成功执行此方法后,应已创建新的 PM 作业,并返回详细的 PM 作业数据。如果失败,包括无效的通知端点,将在响应中提供适当的错误信息。
响应代码¶
成功¶
代码 |
原因 |
|---|---|
201 - 已创建 |
资源已创建并准备好使用。 |
错误¶
代码 |
原因 |
|---|---|
400 - 请求错误 |
请求中的某些内容无效。 |
401 - 未授权 |
用户必须在发出请求之前进行身份验证。 |
404 - Not Found |
找不到请求的资源。 |
406 - 不可接受 |
不可接受,请求的资源只能生成根据请求中发送的“Accept”标头不可接受的内容。 |
409 - Conflict |
此操作与此资源的另一个操作冲突。 |
422 - 无法处理的实体 |
有效负载体的 content type 受支持,并且请求的有效负载体包含语法上正确的数据(例如,格式良好的 JSON),但无法处理该数据(例如,因为它无法通过模式验证)。 |
503 - 服务不可用 |
服务不可用。这通常是由服务配置错误引起的,导致服务无法成功启动。 |
请求参数¶
名称 |
入参 |
类型 |
描述 |
|---|---|---|---|
objectType |
body |
字符串 |
被测对象的类型。 |
objectInstanceIds |
body |
数组 |
请求收集性能信息的被测对象实例的标识符。 |
subObjectInstanceIds (可选) |
body |
数组 |
对于结构化的被测对象,被测对象实例的标识符。 |
criteria |
body |
对象 |
性能信息收集的标准。 |
performanceMetric (可选) |
body |
数组 |
这定义了指定对象实例的性能指标类型。至少应存在两个属性中的一个(性能指标或组)。 |
performanceMetricGroup (可选) |
body |
数组 |
性能指标组。指标组是 API 生产者已知可以分解为单个指标的预定义指标列表。至少应存在两个属性中的一个(性能指标或组)。 |
collectionPeriod |
body |
整数 |
指定 API 生产者将收集性能信息的周期性。单位应为秒。 |
reportingPeriod |
body |
整数 |
指定 API 生产者将向 API 消费者报告性能信息的周期性。单位应为秒。reportingPeriod 应等于或为 collectionPeriod 的倍数。 |
reportingBoundary (可选) |
body |
字符串 |
标识报告停止的时间边界。边界应允许单个报告以及直到边界的周期性报告(格式:日期时间)。 |
callbackUri (可选) |
body |
字符串 |
发送通知的端点的 URI。请求体中至少应存在“callbackUri”和“authentication”属性中的一个。 |
authentication (可选) |
body |
对象 |
用于配置在使用授权时发送通知的身份验证参数。请求体中至少应存在“callbackUri”和“authentication”属性中的一个。 |
authType |
body |
数组 |
定义 API 消费者在接收通知时愿意接受的身份验证/授权类型。允许的值 BASIC:在每个 HTTP 请求中,使用客户端凭据进行 HTTP Basic 身份验证。 OAUTH2_CLIENT_CREDENTIALS:在向通知端点发送的每个 HTTP 请求中,使用使用客户端凭据授权类型在向令牌端点使用客户端标识符和客户端密码进行身份验证后获得的 OAuth 2.0 令牌。 OAUTH2_CLIENT_CERT:在向通知端点发送的每个 HTTP 请求中,使用使用客户端凭据授权类型在向令牌端点使用客户端标识符和 X.509 证书进行相互身份验证后获得的 OAuth 2.0 令牌。 TLS_CERT 不受支持。 |
paramsBasic (可选) |
body |
对象 |
使用 BASIC 进行身份验证/授权的参数。如果 authType 为“BASIC”且包含的信息未通过其他方式配置,则应存在。否则,应不存在。 |
userName (可选) |
body |
字符串 |
用于 HTTP Basic 身份验证的用户名。如果未通过其他方式配置,则应存在。 |
密码 (可选) |
body |
字符串 |
用于 HTTP Basic 身份验证的密码。如果未通过其他方式配置,则应存在。 |
paramsOauth2ClientCredentials (可选) |
body |
对象 |
使用 OAUTH2_CLIENT_CREDENTIALS 进行身份验证/授权的参数。如果 authType 为“OAUTH2_CLIENT_CREDENTIALS”且包含的信息未通过其他方式配置,则应存在。否则,应不存在。 |
clientId (可选) |
body |
字符串 |
OAuth 2.0 客户端凭据授权类型访问令牌请求中使用的客户端标识符。如果未通过其他方式配置,则应存在。 |
clientPassword (可选) |
body |
字符串 |
OAuth 2.0 客户端凭据授权类型访问令牌请求中使用的客户端密码。如果未通过其他方式配置,则应存在。 |
tokenEndpoint (可选) |
body |
字符串 |
可以获取访问令牌的令牌端点。如果未通过其他方式配置,则应存在。 |
paramsOauth2ClientCert (可选) |
body |
对象 |
用于使用 OAUTH2_CLIENT_CERT 进行身份验证/授权的参数。如果 authType 为“OAUTH2_CLIENT_CERT”且包含的信息未通过其他方式配置,则应存在。否则,应不存在。 |
clientId |
body |
字符串 |
OAuth 2.0 客户端凭据授权类型访问令牌请求中使用的客户端标识符。如果未通过其他方式配置,则应存在。 |
certificateRef |
body |
对象 |
客户端证书的指纹。哈希函数应使用 SHA256 或更高版本。如果未通过其他方式配置,则应存在。 |
type |
body |
字符串 |
指纹类型。允许的值 x5t#S256:根据 IETF RFC 7515 第 4.1.8 节定义的 X.509 证书的 SHA-256 拇指码。 |
value |
body |
字符串 |
根据类型定义的指纹值。如果未通过其他方式配置,则应存在。 |
tokenEndpoint |
body |
字符串 |
可以获取访问令牌的令牌端点。如果未通过其他方式配置,则应存在。 |
metadata (可选) |
body |
键值对 |
此属性提供 Prometheus 服务器的访问信息。 |
请求示例¶
{
"objectType": "Vnf",
"objectInstanceIds": ["da459819-a2eb-442b-b9a2-0c1c02466baf"],
"subObjectInstanceIds": [],
"criteria": {
"performanceMetric": [
"VCpuUsageMeanVnf.25b9b9d0-2461-4109-866e-a7767375415b"],
"performanceMetricGroup": ["VirtualisedComputeResource"],
"collectionPeriod": 5,
"reportingPeriod": 10,
"reportingBoundary": "2022-08-05T02:24:46Z"
},
"callbackUri": "https://:9990/notification/callback/callbackUri",
"authentication": {
"authType": [
"BASIC"
],
"paramsBasic": {
"password": "ubuntu",
"userName": "ubuntu"
}
},
"metadata": {
"monitor": {
"monitorName": "prometheus",
"driverType": "external",
"targetsInfo": [
{
"prometheusHost": "prometheus.example",
"alertmanagerHost": "prometheus.example",
"authInfo": {
"ssh_username": "ubuntu",
"ssh_password": "ubuntu"
},
"metricsEndpointConfigPath":
"/etc/prometheus/prometheus.yml",
"alertRuleConfigPath":
"/etc/prometheus/rules/tacker-rule.yml",
"receiverConfigPath":
"/etc/prometheus/alertmanager.yml",
"prometheusReloadApiEndpoint":
"https://:9990/-/reload",
"alertmanagerReloadApiEndpoint":
"http://prometheus.example:9093/-/reload"
}
]
}
}
}
响应参数¶
名称 |
入参 |
类型 |
描述 |
|---|---|---|---|
id |
body |
字符串 |
此 PM 作业的标识符。 |
objectType |
body |
字符串 |
被测对象的类型。 |
objectInstanceIds |
body |
数组 |
请求收集性能信息的被测对象实例的标识符。 |
subObjectInstanceIds (可选) |
body |
数组 |
对于结构化的被测对象,被测对象实例的标识符。 |
criteria |
body |
对象 |
性能信息收集的标准。 |
performanceMetric (可选) |
body |
数组 |
这定义了指定对象实例的性能指标类型。至少应存在两个属性中的一个(性能指标或组)。 |
performanceMetricGroup (可选) |
body |
数组 |
性能指标组。指标组是 API 生产者已知可以分解为单个指标的预定义指标列表。至少应存在两个属性中的一个(性能指标或组)。 |
collectionPeriod |
body |
整数 |
指定 API 生产者将收集性能信息的周期性。单位应为秒。 |
reportingPeriod |
body |
整数 |
指定 API 生产者将向 API 消费者报告性能信息的周期性。单位应为秒。reportingPeriod 应等于或为 collectionPeriod 的倍数。 |
reportingBoundary (可选) |
body |
字符串 |
标识报告停止的时间边界。边界应允许单个报告以及直到边界的周期性报告(格式:日期时间)。 |
callbackUri (可选) |
body |
字符串 |
发送通知的端点的 URI。 |
reports (可选) |
body |
数组 |
此 PM 作业收集到的可用报告信息。 |
href |
body |
字符串 |
可以获取报告的 URI。 |
readyTime |
body |
字符串 |
报告可用时间。 |
expiryTime (可选) |
body |
字符串 |
报告将过期的时间。 |
fileSize (可选) |
body |
整数 |
如果已知,报告文件的大小(以字节为单位)。 |
_links |
body |
数组 |
此资源的链接。 |
self |
body |
对象 |
此资源的 URI。 |
objects (可选) |
body |
数组 |
链接到表示收集性能信息的被测对象实例的资源。如果被测对象实例信息可以作为资源访问,则应存在。 |
响应示例¶
{
"id": "aa474574-a2eb-442b-b9a2-0c1c02466baf",
"objectType": "Vnf",
"objectInstanceIds": ["da459819-a2eb-442b-b9a2-0c1c02466baf"],
"criteria": {
"performanceMetric": [
"VCpuUsageMeanVnf.25b9b9d0-2461-4109-866e-a7767375415b"
],
"performanceMetricGroup": [
"VirtualisedComputeResource"
],
"collectionPeriod": 5,
"reportingPeriod": 10,
"reportingBoundary": "2022-08-05T02:24:46Z"
},
"callbackUri":"http://127.0.0.1/",
"_links": {
"href": "http://127.0.0.1:9890/vnfpm/v2/pm_jobs/aa474574-a2eb-442b-b9a2-0c1c02466baf"
},
}
GET 方法允许用户根据请求中的查询参数过滤 PM 作业。
它支持 ETSI NFV SOL013 v3.4.1 中定义的基于属性的过滤和属性选择器。基于属性的过滤的详细信息在 SOL013 v3.4.1 第 5.2 条中描述。属性选择器的详细信息在 SOL013 v3.4.1 第 5.3 条中描述。
属性选择器允许 API 消费者选择响应中包含哪些属性。可以设置 *all_fields*、*fields*、*exclude_fields* 和 *exclude_default* 作为查询参数。
响应代码¶
成功¶
代码 |
原因 |
|---|---|
200 - 正常 |
请求成功。 |
错误¶
代码 |
原因 |
|---|---|
400 - 请求错误 |
请求中的某些内容无效。 |
401 - 未授权 |
用户必须在发出请求之前进行身份验证。 |
406 - 不可接受 |
不可接受,请求的资源只能生成根据请求中发送的“Accept”标头不可接受的内容。 |
响应参数¶
名称 |
入参 |
类型 |
描述 |
|---|---|---|---|
id |
body |
字符串 |
此 PM 作业的标识符。 |
objectType |
body |
字符串 |
被测对象的类型。 |
objectInstanceIds |
body |
数组 |
请求收集性能信息的被测对象实例的标识符。 |
subObjectInstanceIds (可选) |
body |
数组 |
对于结构化的被测对象,被测对象实例的标识符。 |
criteria |
body |
对象 |
性能信息收集的标准。 |
performanceMetric (可选) |
body |
数组 |
这定义了指定对象实例的性能指标类型。至少应存在两个属性中的一个(性能指标或组)。 |
performanceMetricGroup (可选) |
body |
数组 |
性能指标组。指标组是 API 生产者已知可以分解为单个指标的预定义指标列表。至少应存在两个属性中的一个(性能指标或组)。 |
collectionPeriod |
body |
整数 |
指定 API 生产者将收集性能信息的周期性。单位应为秒。 |
reportingPeriod |
body |
整数 |
指定 API 生产者将向 API 消费者报告性能信息的周期性。单位应为秒。reportingPeriod 应等于或为 collectionPeriod 的倍数。 |
reportingBoundary (可选) |
body |
字符串 |
标识报告停止的时间边界。边界应允许单个报告以及直到边界的周期性报告(格式:日期时间)。 |
callbackUri (可选) |
body |
字符串 |
发送通知的端点的 URI。 |
reports (可选) |
body |
数组 |
此 PM 作业收集到的可用报告信息。 |
href |
body |
字符串 |
可以获取报告的 URI。 |
readyTime |
body |
字符串 |
报告可用时间。 |
expiryTime (可选) |
body |
字符串 |
报告将过期的时间。 |
fileSize (可选) |
body |
整数 |
如果已知,报告文件的大小(以字节为单位)。 |
_links |
body |
数组 |
此资源的链接。 |
self |
body |
对象 |
此资源的 URI。 |
objects (可选) |
body |
数组 |
链接到表示收集性能信息的被测对象实例的资源。如果被测对象实例信息可以作为资源访问,则应存在。 |
响应示例¶
[
{
"id": "aa474574-a2eb-442b-b9a2-0c1c02466baf",
"objectType": "Vnf",
"objectInstanceIds": ["da459819-a2eb-442b-b9a2-0c1c02466baf"],
"criteria": {
"performanceMetric": [
"VCpuUsageMeanVnf.25b9b9d0-2461-4109-866e-a7767375415b"
],
"performanceMetricGroup": [
"VirtualisedComputeResource"
],
"collectionPeriod": 5,
"reportingPeriod": 10,
"reportingBoundary": "2022-08-05T02:24:46Z"
},
"callbackUri":"http://127.0.0.1/",
"_links": {
"href": "http://127.0.0.1:9890/vnfpm/v2/pm_jobs/aa474574-a2eb-442b-b9a2-0c1c02466baf"
}
}
]
GET 方法获取单个 PM 作业。
如果 API 消费者打算读取特定 PM 作业的信息,它会将 GET 请求发送到“单个 PM 作业”资源,并通过资源 URI 中的适当 PM 作业标识符进行寻址。VNFM 会向 API 消费者返回“200 OK”响应,并在有效负载主体中包含一个类型为“PmJob”的数据结构。如果失败,将在响应中提供适当的错误信息。
响应代码¶
成功¶
代码 |
原因 |
|---|---|
200 - 正常 |
请求成功。 |
错误¶
代码 |
原因 |
|---|---|
400 - 请求错误 |
请求中的某些内容无效。 |
401 - 未授权 |
用户必须在发出请求之前进行身份验证。 |
404 - Not Found |
找不到请求的资源。 |
请求参数¶
名称 |
入参 |
类型 |
描述 |
|---|---|---|---|
pmJobId |
路径 |
字符串 |
此 PM 作业的标识符。 |
响应参数¶
名称 |
入参 |
类型 |
描述 |
|---|---|---|---|
id |
body |
字符串 |
此 PM 作业的标识符。 |
objectType |
body |
字符串 |
被测对象的类型。 |
objectInstanceIds |
body |
数组 |
请求收集性能信息的被测对象实例的标识符。 |
subObjectInstanceIds (可选) |
body |
数组 |
对于结构化的被测对象,被测对象实例的标识符。 |
criteria |
body |
对象 |
性能信息收集的标准。 |
performanceMetric (可选) |
body |
数组 |
这定义了指定对象实例的性能指标类型。至少应存在两个属性中的一个(性能指标或组)。 |
performanceMetricGroup (可选) |
body |
数组 |
性能指标组。指标组是 API 生产者已知可以分解为单个指标的预定义指标列表。至少应存在两个属性中的一个(性能指标或组)。 |
collectionPeriod |
body |
整数 |
指定 API 生产者将收集性能信息的周期性。单位应为秒。 |
reportingPeriod |
body |
整数 |
指定 API 生产者将向 API 消费者报告性能信息的周期性。单位应为秒。reportingPeriod 应等于或为 collectionPeriod 的倍数。 |
reportingBoundary (可选) |
body |
字符串 |
标识报告停止的时间边界。边界应允许单个报告以及直到边界的周期性报告(格式:日期时间)。 |
callbackUri (可选) |
body |
字符串 |
发送通知的端点的 URI。 |
reports (可选) |
body |
数组 |
此 PM 作业收集到的可用报告信息。 |
href |
body |
字符串 |
可以获取报告的 URI。 |
readyTime |
body |
字符串 |
报告可用时间。 |
expiryTime (可选) |
body |
字符串 |
报告将过期的时间。 |
fileSize (可选) |
body |
整数 |
如果已知,报告文件的大小(以字节为单位)。 |
_links |
body |
数组 |
此资源的链接。 |
self |
body |
对象 |
此资源的 URI。 |
objects (可选) |
body |
数组 |
链接到表示收集性能信息的被测对象实例的资源。如果被测对象实例信息可以作为资源访问,则应存在。 |
响应示例¶
{
"id": "aa474574-a2eb-442b-b9a2-0c1c02466baf",
"objectType": "Vnf",
"objectInstanceIds": ["da459819-a2eb-442b-b9a2-0c1c02466baf"],
"criteria": {
"performanceMetric": [
"VCpuUsageMeanVnf.25b9b9d0-2461-4109-866e-a7767375415b"
],
"performanceMetricGroup": [
"VirtualisedComputeResource"
],
"collectionPeriod": 5,
"reportingPeriod": 10,
"reportingBoundary": "2022-08-05T02:24:46Z"
},
"callbackUri":"http://127.0.0.1/",
"_links": {
"href": "http://127.0.0.1:9890/vnfpm/v2/pm_jobs/aa474574-a2eb-442b-b9a2-0c1c02466baf"
}
}
PATCH 方法修改 PM 作业。
如果 API 消费者打算更新 PM 作业中的回调 URI,它会将 PATCH 请求发送到“单个 PM 作业”资源,并在有效负载主体中包含一个类型为“PmJobModifications”的数据结构。VNFM 会向 API 消费者返回“200 OK”响应,并在有效负载主体中包含一个类型为“PmJobModifications”的数据结构,以指示执行的修改。但是,身份验证参数不得出现在响应主体中。
响应码¶
成功¶
代码 |
原因 |
|---|---|
200 - 正常 |
请求成功。 |
错误¶
代码 |
原因 |
|---|---|
400 - 请求错误 |
请求中的某些内容无效。 |
401 - 未授权 |
用户必须在发出请求之前进行身份验证。 |
422 - 无法处理的实体 |
有效负载体的 content type 受支持,并且请求的有效负载体包含语法上正确的数据(例如,格式良好的 JSON),但无法处理该数据(例如,因为它无法通过模式验证)。 |
请求参数¶
名称 |
入参 |
类型 |
描述 |
|---|---|---|---|
pmJobId |
路径 |
字符串 |
此 PM 作业的标识符。 |
callbackUri (可选) |
body |
字符串 |
发送通知的端点的 URI。请求体中至少应存在“callbackUri”和“authentication”属性中的一个。 |
authentication (可选) |
body |
对象 |
用于配置在使用授权时发送通知的身份验证参数。请求体中至少应存在“callbackUri”和“authentication”属性中的一个。 |
authType |
body |
数组 |
定义 API 消费者在接收通知时愿意接受的身份验证/授权类型。允许的值 BASIC:在每个 HTTP 请求中,使用客户端凭据进行 HTTP Basic 身份验证。 OAUTH2_CLIENT_CREDENTIALS:在向通知端点发送的每个 HTTP 请求中,使用使用客户端凭据授权类型在向令牌端点使用客户端标识符和客户端密码进行身份验证后获得的 OAuth 2.0 令牌。 OAUTH2_CLIENT_CERT:在向通知端点发送的每个 HTTP 请求中,使用使用客户端凭据授权类型在向令牌端点使用客户端标识符和 X.509 证书进行相互身份验证后获得的 OAuth 2.0 令牌。 TLS_CERT 不受支持。 |
paramsBasic (可选) |
body |
对象 |
使用 BASIC 进行身份验证/授权的参数。如果 authType 为“BASIC”且包含的信息未通过其他方式配置,则应存在。否则,应不存在。 |
userName (可选) |
body |
字符串 |
用于 HTTP Basic 身份验证的用户名。如果未通过其他方式配置,则应存在。 |
密码 (可选) |
body |
字符串 |
用于 HTTP Basic 身份验证的密码。如果未通过其他方式配置,则应存在。 |
paramsOauth2ClientCredentials (可选) |
body |
对象 |
使用 OAUTH2_CLIENT_CREDENTIALS 进行身份验证/授权的参数。如果 authType 为“OAUTH2_CLIENT_CREDENTIALS”且包含的信息未通过其他方式配置,则应存在。否则,应不存在。 |
clientId (可选) |
body |
字符串 |
OAuth 2.0 客户端凭据授权类型访问令牌请求中使用的客户端标识符。如果未通过其他方式配置,则应存在。 |
clientPassword (可选) |
body |
字符串 |
OAuth 2.0 客户端凭据授权类型访问令牌请求中使用的客户端密码。如果未通过其他方式配置,则应存在。 |
tokenEndpoint (可选) |
body |
字符串 |
可以获取访问令牌的令牌端点。如果未通过其他方式配置,则应存在。 |
paramsOauth2ClientCert (可选) |
body |
对象 |
用于使用 OAUTH2_CLIENT_CERT 进行身份验证/授权的参数。如果 authType 为“OAUTH2_CLIENT_CERT”且包含的信息未通过其他方式配置,则应存在。否则,应不存在。 |
clientId |
body |
字符串 |
OAuth 2.0 客户端凭据授权类型访问令牌请求中使用的客户端标识符。如果未通过其他方式配置,则应存在。 |
certificateRef |
body |
对象 |
客户端证书的指纹。哈希函数应使用 SHA256 或更高版本。如果未通过其他方式配置,则应存在。 |
type |
body |
字符串 |
指纹类型。允许的值 x5t#S256:根据 IETF RFC 7515 第 4.1.8 节定义的 X.509 证书的 SHA-256 拇指码。 |
value |
body |
字符串 |
根据类型定义的指纹值。如果未通过其他方式配置,则应存在。 |
tokenEndpoint |
body |
字符串 |
可以获取访问令牌的令牌端点。如果未通过其他方式配置,则应存在。 |
请求示例¶
{
"callbackUri": "https://:9990/notification/callback/callbackUri"
}
响应参数¶
名称 |
入参 |
类型 |
描述 |
|---|---|---|---|
callbackUri (可选) |
body |
字符串 |
发送通知的端点的 URI。 |
响应示例¶
{
"callbackUri": "https://:9990/notification/callback/callbackUri"
}
DELETE 方法删除 PM 作业。
如果 API 消费者打算删除 PM 作业,它会将 DELETE 请求发送到“单个 PM 作业”资源,并通过资源 URI 中的适当 PM 作业标识符进行寻址。VNFM 会向 API 消费者返回一个带有“204 No Content”响应代码和空有效负载主体的响应。
响应代码¶
成功¶
代码 |
原因 |
|---|---|
204 - No Content |
服务器已通过删除资源来满足请求。 |
错误¶
代码 |
原因 |
|---|---|
400 - 请求错误 |
请求中的某些内容无效。 |
401 - 未授权 |
用户必须在发出请求之前进行身份验证。 |
404 - Not Found |
找不到请求的资源。 |
请求参数¶
名称 |
入参 |
类型 |
描述 |
|---|---|---|---|
pmJobId |
路径 |
字符串 |
此 PM 作业的标识符。 |
GET 方法获取单个性能报告。
API 消费者会将 GET 请求发送到 VNFM 的 URI,以读取“单个性能报告”资源。VNFM 会向 API 消费者返回“200 OK”响应,并在有效负载主体中包含一个类型为“PerformanceReport”的数据结构。
响应代码¶
成功¶
代码 |
原因 |
|---|---|
200 - 正常 |
请求成功。 |
错误¶
代码 |
原因 |
|---|---|
400 - 请求错误 |
请求中的某些内容无效。 |
401 - 未授权 |
用户必须在发出请求之前进行身份验证。 |
404 - Not Found |
找不到请求的资源。 |
请求参数¶
名称 |
入参 |
类型 |
描述 |
|---|---|---|---|
pmJobId |
路径 |
字符串 |
此 PM 作业的标识符。 |
reportId |
路径 |
字符串 |
此 PM 作业报告的标识符。 |
响应参数¶
名称 |
入参 |
类型 |
描述 |
|---|---|---|---|
entries |
body |
数组 |
性能信息条目列表。 |
objectType |
body |
字符串 |
被测对象的类型。 |
objectInstanceId |
body |
字符串 |
报告性能指标的被测对象实例的标识符。 |
subObjectInstanceId (可选) |
body |
字符串 |
报告性能指标的被测对象实例的子对象实例的标识符。 |
performanceMetric |
body |
字符串 |
收集的指标名称。 |
performanceValues |
body |
数组 |
带有相关时间戳的性能值列表。 |
timeStamp |
body |
字符串 |
指示收集数据的时间戳。 |
value |
body |
字符串 |
收集的指标值。 |
context (可选) |
body |
键值对 |
与测量值相关的测量上下文信息。 |
响应示例¶
[
{
"objectType": "Vnf",
"objectInstanceId": "da459819-a2eb-442b-b9a2-0c1c02466baf",
"performanceMetric": "VCpuUsageMeanVnf.25b9b9d0-2461-4109-866e-a7767375415b",
"performanceValues": {
"timeStamp": "2022-08-05T02:24:46Z",
"value": "value_test",
"context": "{'test': 'test'}"
}
}
]
POST 方法创建新的 PM 阈值。
成功执行此方法后,应已创建新的 PM 阈值,并返回详细的 PM 阈值数据。如果失败,包括无效的通知端点,将在响应中提供适当的错误信息。
响应代码¶
成功¶
代码 |
原因 |
|---|---|
201 - 已创建 |
资源已创建并准备好使用。 |
错误¶
代码 |
原因 |
|---|---|
400 - 请求错误 |
请求中的某些内容无效。 |
401 - 未授权 |
用户必须在发出请求之前进行身份验证。 |
404 - Not Found |
找不到请求的资源。 |
406 - 不可接受 |
不可接受,请求的资源只能生成根据请求中发送的“Accept”标头不可接受的内容。 |
409 - Conflict |
此操作与此资源的另一个操作冲突。 |
422 - 无法处理的实体 |
有效负载体的 content type 受支持,并且请求的有效负载体包含语法上正确的数据(例如,格式良好的 JSON),但无法处理该数据(例如,因为它无法通过模式验证)。 |
503 - 服务不可用 |
服务不可用。这通常是由服务配置错误引起的,导致服务无法成功启动。 |
请求参数¶
名称 |
入参 |
类型 |
描述 |
|---|---|---|---|
objectType |
body |
字符串 |
被测对象的类型。 |
objectInstanceId |
body |
字符串 |
报告性能指标的被测对象实例的标识符。 |
subObjectInstanceIds (可选) |
body |
数组 |
对于结构化的被测对象,被测对象实例的标识符。 |
criteria |
body |
对象 |
性能信息收集的标准。 |
performanceMetric |
body |
字符串 |
这定义了与阈值关联的性能指标类型。 |
thresholdType |
body |
字符串 |
阈值类型。此属性确定数据结构中存在哪些其他属性。“SIMPLE:单值静态阈值”是被允许的。 |
simpleThresholdDetails (可选) |
body |
对象 |
简单阈值的详细信息。如果 thresholdType=”SIMPLE”,则应存在。 |
thresholdValue |
body |
数字 |
阈值。应表示为浮点数。 |
hysteresis |
body |
数字 |
阈值的滞后。应表示为非负浮点数。 |
callbackUri |
body |
字符串 |
发送通知的端点的 URI。 |
authentication (可选) |
body |
对象 |
用于配置在使用授权时发送通知的身份验证参数。 |
authType |
body |
数组 |
定义 API 消费者在接收通知时愿意接受的身份验证/授权类型。允许的值 BASIC:在每个 HTTP 请求中,使用客户端凭据进行 HTTP Basic 身份验证。 OAUTH2_CLIENT_CREDENTIALS:在向通知端点发送的每个 HTTP 请求中,使用使用客户端凭据授权类型在向令牌端点使用客户端标识符和客户端密码进行身份验证后获得的 OAuth 2.0 令牌。 OAUTH2_CLIENT_CERT:在向通知端点发送的每个 HTTP 请求中,使用使用客户端凭据授权类型在向令牌端点使用客户端标识符和 X.509 证书进行相互身份验证后获得的 OAuth 2.0 令牌。 TLS_CERT 不受支持。 |
paramsBasic (可选) |
body |
对象 |
使用 BASIC 进行身份验证/授权的参数。如果 authType 为“BASIC”且包含的信息未通过其他方式配置,则应存在。否则,应不存在。 |
userName (可选) |
body |
字符串 |
用于 HTTP Basic 身份验证的用户名。如果未通过其他方式配置,则应存在。 |
密码 (可选) |
body |
字符串 |
用于 HTTP Basic 身份验证的密码。如果未通过其他方式配置,则应存在。 |
paramsOauth2ClientCredentials (可选) |
body |
对象 |
使用 OAUTH2_CLIENT_CREDENTIALS 进行身份验证/授权的参数。如果 authType 为“OAUTH2_CLIENT_CREDENTIALS”且包含的信息未通过其他方式配置,则应存在。否则,应不存在。 |
clientId (可选) |
body |
字符串 |
OAuth 2.0 客户端凭据授权类型访问令牌请求中使用的客户端标识符。如果未通过其他方式配置,则应存在。 |
clientPassword (可选) |
body |
字符串 |
OAuth 2.0 客户端凭据授权类型访问令牌请求中使用的客户端密码。如果未通过其他方式配置,则应存在。 |
tokenEndpoint (可选) |
body |
字符串 |
可以获取访问令牌的令牌端点。如果未通过其他方式配置,则应存在。 |
paramsOauth2ClientCert (可选) |
body |
对象 |
用于使用 OAUTH2_CLIENT_CERT 进行身份验证/授权的参数。如果 authType 为“OAUTH2_CLIENT_CERT”且包含的信息未通过其他方式配置,则应存在。否则,应不存在。 |
clientId |
body |
字符串 |
OAuth 2.0 客户端凭据授权类型访问令牌请求中使用的客户端标识符。如果未通过其他方式配置,则应存在。 |
certificateRef |
body |
对象 |
客户端证书的指纹。哈希函数应使用 SHA256 或更高版本。如果未通过其他方式配置,则应存在。 |
type |
body |
字符串 |
指纹类型。允许的值 x5t#S256:根据 IETF RFC 7515 第 4.1.8 节定义的 X.509 证书的 SHA-256 拇指码。 |
value |
body |
字符串 |
根据类型定义的指纹值。如果未通过其他方式配置,则应存在。 |
tokenEndpoint |
body |
字符串 |
可以获取访问令牌的令牌端点。如果未通过其他方式配置,则应存在。 |
metadata |
body |
键值对 |
此属性提供 Prometheus 服务器的访问信息。 |
请求示例¶
{
"objectType": "Vnf",
"objectInstanceId": "4fcf78d6-52d9-4b6a-b3a6-49b2bef65843",
"criteria": {
"performanceMetric": "VCpuUsageMeanVnf.4fcf78d6-52d9-4b6a-b3a6-49b2bef65843",
"thresholdType": "SIMPLE",
"simpleThresholdDetails": {
"thresholdValue": 55,
"hysteresis": 30
}
},
"callbackUri": "https://:9990/notification/callbackuri/4fcf78d6-52d9-4b6a-b3a6-49b2bef65843",
"authentication": {
"authType": [
"BASIC"
],
"paramsBasic": {
"password": "ubuntu",
"userName": "ubuntu"
}
},
"metadata": {
"monitoring": {
"monitorName": "prometheus",
"driverType": "external",
"targetsInfo": [
{
"prometheusHost": "prometheus.example",
"prometheusHostPort": 50022,
"authInfo": {
"ssh_username": "ubuntu",
"ssh_password": "ubuntu"
},
"alertRuleConfigPath":
"/etc/prometheus/rule",
"prometheusReloadApiEndpoint":
"http://prometheus.example:9990/-/reload",
}
]
}
}
}
响应参数¶
名称 |
入参 |
类型 |
描述 |
|---|---|---|---|
id |
body |
字符串 |
此 PM 阈值的标识符。 |
objectType |
body |
字符串 |
被测对象的类型。 |
objectInstanceId |
body |
字符串 |
报告性能指标的被测对象实例的标识符。 |
subObjectInstanceIds (可选) |
body |
数组 |
对于结构化的被测对象,被测对象实例的标识符。 |
criteria |
body |
对象 |
性能信息收集的标准。 |
performanceMetric |
body |
字符串 |
这定义了与阈值关联的性能指标类型。 |
thresholdType |
body |
字符串 |
阈值类型。此属性确定数据结构中存在哪些其他属性。“SIMPLE:单值静态阈值”是被允许的。 |
simpleThresholdDetails (可选) |
body |
对象 |
简单阈值的详细信息。如果 thresholdType=”SIMPLE”,则应存在。 |
thresholdValue |
body |
数字 |
阈值。应表示为浮点数。 |
hysteresis |
body |
数字 |
阈值的滞后。应表示为非负浮点数。 |
callbackUri |
body |
字符串 |
发送通知的端点的 URI。 |
_links |
body |
数组 |
此资源的链接。 |
self |
body |
对象 |
此资源的 URI。 |
object (可选) |
body |
对象 |
链接到表示收集性能信息的被测对象实例的资源。如果被测对象实例信息可以作为资源访问,则应存在。 |
响应示例¶
{
"id": "bb474274-c5eb-442b-e2a2-0c1c02437bac",
"objectType": "Vnf",
"objectInstanceId": "4fcf78d6-52d9-4b6a-b3a6-49b2bef65843",
"criteria": {
"performanceMetric": "VCpuUsageMeanVnf.4fcf78d6-52d9-4b6a-b3a6-49b2bef65843",
"thresholdType": "SIMPLE",
"simpleThresholdDetails": {
"thresholdValue": 55,
"hysteresis": 30
}
},
"callbackUri": "https://:9990/notification/callbackuri/4fcf78d6-52d9-4b6a-b3a6-49b2bef65843",
"_link": {
"self": "http://127.0.0.1:9890/vnfpm/v2/thresholds/bb474274-c5eb-442b-e2a2-0c1c02437bac",
"object": "http://127.0.0.1:9890/vnflcm/v2/vnf_instances/4fcf78d6-52d9-4b6a-b3a6-49b2bef65843"
}
}
GET 方法允许用户根据请求中的查询参数过滤 PM 阈值。
它支持 ETSI NFV SOL013 v3.4.1 中定义的基于属性的过滤和属性选择器。基于属性的过滤的详细信息在 SOL013 v3.4.1 第 5.2 条中描述。属性选择器的详细信息在 SOL013 v3.4.1 第 5.3 条中描述。
属性选择器允许 API 消费者选择希望包含在响应中的属性。
响应代码¶
成功¶
代码 |
原因 |
|---|---|
200 - 正常 |
请求成功。 |
错误¶
代码 |
原因 |
|---|---|
400 - 请求错误 |
请求中的某些内容无效。 |
401 - 未授权 |
用户必须在发出请求之前进行身份验证。 |
406 - 不可接受 |
不可接受,请求的资源只能生成根据请求中发送的“Accept”标头不可接受的内容。 |
响应参数¶
名称 |
入参 |
类型 |
描述 |
|---|---|---|---|
id |
body |
字符串 |
此 PM 阈值的标识符。 |
objectType |
body |
字符串 |
被测对象的类型。 |
objectInstanceId |
body |
字符串 |
报告性能指标的被测对象实例的标识符。 |
subObjectInstanceIds (可选) |
body |
数组 |
对于结构化的被测对象,被测对象实例的标识符。 |
criteria |
body |
对象 |
性能信息收集的标准。 |
performanceMetric |
body |
字符串 |
这定义了与阈值关联的性能指标类型。 |
thresholdType |
body |
字符串 |
阈值类型。此属性确定数据结构中存在哪些其他属性。“SIMPLE:单值静态阈值”是被允许的。 |
simpleThresholdDetails (可选) |
body |
对象 |
简单阈值的详细信息。如果 thresholdType=”SIMPLE”,则应存在。 |
thresholdValue |
body |
数字 |
阈值。应表示为浮点数。 |
hysteresis |
body |
数字 |
阈值的滞后。应表示为非负浮点数。 |
callbackUri |
body |
字符串 |
发送通知的端点的 URI。 |
_links |
body |
数组 |
此资源的链接。 |
self |
body |
对象 |
此资源的 URI。 |
object (可选) |
body |
对象 |
链接到表示收集性能信息的被测对象实例的资源。如果被测对象实例信息可以作为资源访问,则应存在。 |
响应示例¶
[
{
"id": "bb474274-c5eb-442b-e2a2-0c1c02437bac",
"objectType": "Vnf",
"objectInstanceId": "4fcf78d6-52d9-4b6a-b3a6-49b2bef65843",
"criteria": {
"performanceMetric": "VCpuUsageMeanVnf.4fcf78d6-52d9-4b6a-b3a6-49b2bef65843",
"thresholdType": "SIMPLE",
"simpleThresholdDetails": {
"thresholdValue": 55,
"hysteresis": 30
}
},
"callbackUri": "https://:9990/notification/callbackuri/4fcf78d6-52d9-4b6a-b3a6-49b2bef65843",
"_link": {
"self": "http://127.0.0.1:9890/vnfpm/v2/thresholds/bb474274-c5eb-442b-e2a2-0c1c02437bac",
"object": "http://127.0.0.1:9890/vnflcm/v2/vnf_instances/4fcf78d6-52d9-4b6a-b3a6-49b2bef65843"
}
}
]
GET 方法获取单个 PM 阈值。
如果 API 消费者打算读取特定 PM 阈值的信息,它会将 GET 请求发送到“单个 PM 阈值”资源,并通过资源 URI 中的适当 PM 阈值标识符进行寻址。VNFM 会向 API 消费者返回“200 OK”响应,并在有效负载主体中包含一个类型为“PmThreshold”的数据结构。如果失败,将在响应中提供适当的错误信息。
响应代码¶
成功¶
代码 |
原因 |
|---|---|
200 - 正常 |
请求成功。 |
错误¶
代码 |
原因 |
|---|---|
400 - 请求错误 |
请求中的某些内容无效。 |
401 - 未授权 |
用户必须在发出请求之前进行身份验证。 |
404 - Not Found |
找不到请求的资源。 |
请求参数¶
名称 |
入参 |
类型 |
描述 |
|---|---|---|---|
thresholdId |
路径 |
字符串 |
此 PM 阈值的标识符。 |
响应参数¶
名称 |
入参 |
类型 |
描述 |
|---|---|---|---|
id |
body |
字符串 |
此 PM 阈值的标识符。 |
objectType |
body |
字符串 |
被测对象的类型。 |
objectInstanceId |
body |
字符串 |
报告性能指标的被测对象实例的标识符。 |
subObjectInstanceIds (可选) |
body |
数组 |
对于结构化的被测对象,被测对象实例的标识符。 |
criteria |
body |
对象 |
性能信息收集的标准。 |
performanceMetric |
body |
字符串 |
这定义了与阈值关联的性能指标类型。 |
thresholdType |
body |
字符串 |
阈值类型。此属性确定数据结构中存在哪些其他属性。“SIMPLE:单值静态阈值”是被允许的。 |
simpleThresholdDetails (可选) |
body |
对象 |
简单阈值的详细信息。如果 thresholdType=”SIMPLE”,则应存在。 |
thresholdValue |
body |
数字 |
阈值。应表示为浮点数。 |
hysteresis |
body |
数字 |
阈值的滞后。应表示为非负浮点数。 |
callbackUri |
body |
字符串 |
发送通知的端点的 URI。 |
_links |
body |
数组 |
此资源的链接。 |
self |
body |
对象 |
此资源的 URI。 |
object (可选) |
body |
对象 |
链接到表示收集性能信息的被测对象实例的资源。如果被测对象实例信息可以作为资源访问,则应存在。 |
响应示例¶
{
"id": "bb474274-c5eb-442b-e2a2-0c1c02437bac",
"objectType": "Vnf",
"objectInstanceId": "4fcf78d6-52d9-4b6a-b3a6-49b2bef65843",
"criteria": {
"performanceMetric": "VCpuUsageMeanVnf.4fcf78d6-52d9-4b6a-b3a6-49b2bef65843",
"thresholdType": "SIMPLE",
"simpleThresholdDetails": {
"thresholdValue": 55,
"hysteresis": 30
}
},
"callbackUri": "https://:9990/notification/callbackuri/4fcf78d6-52d9-4b6a-b3a6-49b2bef65843",
"_link": {
"self": "http://127.0.0.1:9890/vnfpm/v2/thresholds/bb474274-c5eb-442b-e2a2-0c1c02437bac",
"object": "http://127.0.0.1:9890/vnflcm/v2/vnf_instances/4fcf78d6-52d9-4b6a-b3a6-49b2bef65843"
}
}
PATCH 方法修改 PM 阈值。
如果 API 消费者打算更新 PM 阈值中的回调 URI,它会将 PATCH 请求发送到“单个 PM 阈值”资源,并在有效负载主体中包含一个类型为“ThresholdModifications”的数据结构。VNFM 会向 API 消费者返回“200 OK”响应,并在有效负载主体中包含一个类型为“ThresholdModifications”的数据结构,以指示执行的修改。但是,身份验证参数不得出现在响应主体中。
响应代码¶
成功¶
代码 |
原因 |
|---|---|
200 - 正常 |
请求成功。 |
错误¶
代码 |
原因 |
|---|---|
400 - 请求错误 |
请求中的某些内容无效。 |
401 - 未授权 |
用户必须在发出请求之前进行身份验证。 |
422 - 无法处理的实体 |
有效负载体的 content type 受支持,并且请求的有效负载体包含语法上正确的数据(例如,格式良好的 JSON),但无法处理该数据(例如,因为它无法通过模式验证)。 |
请求参数¶
名称 |
入参 |
类型 |
描述 |
|---|---|---|---|
thresholdId |
路径 |
字符串 |
此 PM 阈值的标识符。 |
callbackUri (可选) |
body |
字符串 |
发送通知的端点的 URI。请求体中至少应存在“callbackUri”和“authentication”属性中的一个。 |
authentication (可选) |
body |
对象 |
用于配置在使用授权时发送通知的身份验证参数。请求体中至少应存在“callbackUri”和“authentication”属性中的一个。 |
authType |
body |
数组 |
定义 API 消费者在接收通知时愿意接受的身份验证/授权类型。允许的值 BASIC:在每个 HTTP 请求中,使用客户端凭据进行 HTTP Basic 身份验证。 OAUTH2_CLIENT_CREDENTIALS:在向通知端点发送的每个 HTTP 请求中,使用使用客户端凭据授权类型在向令牌端点使用客户端标识符和客户端密码进行身份验证后获得的 OAuth 2.0 令牌。 OAUTH2_CLIENT_CERT:在向通知端点发送的每个 HTTP 请求中,使用使用客户端凭据授权类型在向令牌端点使用客户端标识符和 X.509 证书进行相互身份验证后获得的 OAuth 2.0 令牌。 TLS_CERT 不受支持。 |
paramsBasic (可选) |
body |
对象 |
使用 BASIC 进行身份验证/授权的参数。如果 authType 为“BASIC”且包含的信息未通过其他方式配置,则应存在。否则,应不存在。 |
userName (可选) |
body |
字符串 |
用于 HTTP Basic 身份验证的用户名。如果未通过其他方式配置,则应存在。 |
密码 (可选) |
body |
字符串 |
用于 HTTP Basic 身份验证的密码。如果未通过其他方式配置,则应存在。 |
paramsOauth2ClientCredentials (可选) |
body |
对象 |
使用 OAUTH2_CLIENT_CREDENTIALS 进行身份验证/授权的参数。如果 authType 为“OAUTH2_CLIENT_CREDENTIALS”且包含的信息未通过其他方式配置,则应存在。否则,应不存在。 |
clientId (可选) |
body |
字符串 |
OAuth 2.0 客户端凭据授权类型访问令牌请求中使用的客户端标识符。如果未通过其他方式配置,则应存在。 |
clientPassword (可选) |
body |
字符串 |
OAuth 2.0 客户端凭据授权类型访问令牌请求中使用的客户端密码。如果未通过其他方式配置,则应存在。 |
tokenEndpoint (可选) |
body |
字符串 |
可以获取访问令牌的令牌端点。如果未通过其他方式配置,则应存在。 |
paramsOauth2ClientCert (可选) |
body |
对象 |
用于使用 OAUTH2_CLIENT_CERT 进行身份验证/授权的参数。如果 authType 为“OAUTH2_CLIENT_CERT”且包含的信息未通过其他方式配置,则应存在。否则,应不存在。 |
clientId |
body |
字符串 |
OAuth 2.0 客户端凭据授权类型访问令牌请求中使用的客户端标识符。如果未通过其他方式配置,则应存在。 |
certificateRef |
body |
对象 |
客户端证书的指纹。哈希函数应使用 SHA256 或更高版本。如果未通过其他方式配置,则应存在。 |
type |
body |
字符串 |
指纹类型。允许的值 x5t#S256:根据 IETF RFC 7515 第 4.1.8 节定义的 X.509 证书的 SHA-256 拇指码。 |
value |
body |
字符串 |
根据类型定义的指纹值。如果未通过其他方式配置,则应存在。 |
tokenEndpoint |
body |
字符串 |
可以获取访问令牌的令牌端点。如果未通过其他方式配置,则应存在。 |
请求示例¶
{
"callbackUri": "https://:9990/notification/callback/callbackUri"
}
响应参数¶
名称 |
入参 |
类型 |
描述 |
|---|---|---|---|
callbackUri (可选) |
body |
字符串 |
发送通知的端点的 URI。 |
响应示例¶
{
"callbackUri": "https://:9990/notification/callback/callbackUri"
}
DELETE 方法删除 PM 阈值。
如果 API 消费者打算删除 PM 阈值,它会将 DELETE 请求发送到“单个 PM 阈值”资源,并通过资源 URI 中的适当 PM 阈值标识符进行寻址。VNFM 会向 API 消费者返回一个带有“204 No Content”响应代码和空有效负载主体的响应。
响应代码¶
成功¶
代码 |
原因 |
|---|---|
204 - No Content |
服务器已通过删除资源来满足请求。 |
错误¶
代码 |
原因 |
|---|---|
400 - 请求错误 |
请求中的某些内容无效。 |
401 - 未授权 |
用户必须在发出请求之前进行身份验证。 |
404 - Not Found |
找不到请求的资源。 |
请求参数¶
名称 |
入参 |
类型 |
描述 |
|---|---|---|---|
thresholdId |
路径 |
字符串 |
此 PM 阈值的标识符。 |
虚拟化网络功能性能管理通知接口¶
此接口是关于 VNF 性能管理的通知。
此接口是在配置为 callbackUri 的端点上,当创建性能管理作业或性能管理阈值时,当发生指示阈值交叉或 PM 作业的性能信息可用性的事件时发送的通知。该接口的详细信息在 SOL002 v3.3.1 第 6 条中描述。
POST 方法将来自 Tacker 到 API 消费者的阈值交叉通知传递。
当配置为由 VNF 性能管理阈值进行监控的 VNF 跨越性能阈值时,Tacker 会将此通知发送到“创建 PM 阈值 (v2)”API 中 callbackUri 配置的端点。
响应代码¶
Tacker 期望从 API 消费者的端点收到“204 No Content”响应。如果返回任何其他响应代码,将被视为错误。
成功¶
代码 |
原因 |
|---|---|
204 - No Content |
通知已成功传递。 |
请求参数¶
名称 |
入参 |
类型 |
描述 |
|---|---|---|---|
id |
body |
字符串 |
此通知的标识符。 |
notificationType |
body |
字符串 |
不同通知类型的鉴别器。对于此通知类型,设置为“ThresholdCrossedNotification”。 |
timeStamp |
body |
字符串 |
生成通知的日期和时间。 |
thresholdId |
body |
字符串 |
已跨越阈值的阈值标识符。 |
crossingDirection |
body |
字符串 |
指示阈值是向上还是向下跨越的指示。 |
objectType |
body |
字符串 |
被测对象的类型。 |
objectInstanceId |
body |
字符串 |
被测对象实例的标识符。 |
subObjectInstanceId (可选) |
body |
字符串 |
测量对象子对象的标识符,该子对象适用于测量。 |
performanceMetric |
body |
字符串 |
与阈值关联的性能指标。 |
performanceValue |
body |
字符串 |
导致阈值跨越的指标值。 |
context (可选) |
body |
字符串 |
与测量值相关的测量上下文信息。 |
_links |
body |
对象 |
与此通知相关的资源链接。 |
objectInstance (可选) |
body |
对象 |
指向表示应用通知更改的被测对象实例的资源的链接。如果被测对象实例信息可以作为资源访问,则应存在。 |
threshold |
body |
对象 |
指向表示已跨越阈值的资源的链接。 |
请求示例¶
{
"id": "0aa6500e-cdee-41f7-aadd-af80f7622ebc",
"notificationType": "ThresholdCrossedNotification",
"timeStamp": "2023-12-06T09:08:06Z",
"thresholdId": "135db472-4f7b-4d55-abaf-27a3ab4d7ba1",
"crossingDirection": "DOWN",
"objectType": "Vnf",
"objectInstanceId": "c21fd71b-2866-45f6-89d0-70c458a5c32e",
"performanceMetric": "VCpuUsageMeanVnf.c21fd71b-2866-45f6-89d0-70c458a5c32e",
"performanceValue": "0.0004428400000000465",
"_links": {
"objectInstance": {
"href": "http://127.0.0.1:9890/vnflcm/v2/vnf_instances/c21fd71b-2866-45f6-89d0-70c458a5c32e"
},
"threshold": {
"href": "http://127.0.0.1:9890/vnfpm/v2/thresholds/135db472-4f7b-4d55-abaf-27a3ab4d7ba1"
}
}
}
GET 方法测试通知端点。
当使用“创建 PM 任务 (v2)”API 创建 PM 任务,或使用“创建 PM 阈值 (v2)”API 创建 PM 阈值时,Tacker 会将此通知发送到配置了 callbackUri 的端点以确认通信。
响应代码¶
Tacker 期望从 API 消费者的端点收到“204 No Content”响应。如果返回任何其他响应代码,将被视为错误。
成功¶
代码 |
原因 |
|---|---|
204 - No Content |
通知已成功传递。 |