@byteplus/pulumi-bytepluscc 0.0.23 → 0.0.25
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/alb/acl.d.ts +20 -20
- package/alb/acl.js +1 -1
- package/alb/getAcl.d.ts +11 -11
- package/alb/getListener.d.ts +20 -20
- package/alb/getServerGroup.d.ts +9 -9
- package/alb/listener.d.ts +52 -52
- package/alb/listener.js +1 -1
- package/alb/serverGroup.d.ts +24 -24
- package/alb/serverGroup.js +1 -1
- package/cen/getInterRegionBandwidth.d.ts +72 -0
- package/cen/getInterRegionBandwidth.js +28 -0
- package/cen/getInterRegionBandwidth.js.map +1 -0
- package/cen/getInterRegionBandwidths.d.ts +22 -0
- package/cen/getInterRegionBandwidths.js +24 -0
- package/cen/getInterRegionBandwidths.js.map +1 -0
- package/cen/getRouteEntries.d.ts +22 -0
- package/cen/getRouteEntries.js +24 -0
- package/cen/getRouteEntries.js.map +1 -0
- package/cen/getRouteEntry.d.ts +72 -0
- package/cen/getRouteEntry.js +28 -0
- package/cen/getRouteEntry.js.map +1 -0
- package/cen/getServiceRouteEntries.d.ts +22 -0
- package/cen/getServiceRouteEntries.js +24 -0
- package/cen/getServiceRouteEntries.js.map +1 -0
- package/cen/getServiceRouteEntry.d.ts +73 -0
- package/cen/getServiceRouteEntry.js +28 -0
- package/cen/getServiceRouteEntry.js.map +1 -0
- package/cen/index.d.ts +27 -0
- package/cen/index.js +34 -1
- package/cen/index.js.map +1 -1
- package/cen/interRegionBandwidth.d.ts +152 -0
- package/cen/interRegionBandwidth.js +101 -0
- package/cen/interRegionBandwidth.js.map +1 -0
- package/cen/routeEntry.d.ts +152 -0
- package/cen/routeEntry.js +104 -0
- package/cen/routeEntry.js.map +1 -0
- package/cen/serviceRouteEntry.d.ts +138 -0
- package/cen/serviceRouteEntry.js +83 -0
- package/cen/serviceRouteEntry.js.map +1 -0
- package/clb/getListener.d.ts +4 -0
- package/clb/getListener.js.map +1 -1
- package/clb/listener.d.ts +3 -0
- package/clb/listener.js +2 -0
- package/clb/listener.js.map +1 -1
- package/cr/endpointAclPolicy.d.ts +107 -0
- package/cr/endpointAclPolicy.js +84 -0
- package/cr/endpointAclPolicy.js.map +1 -0
- package/cr/getEndpointAclPolicies.d.ts +22 -0
- package/cr/getEndpointAclPolicies.js +24 -0
- package/cr/getEndpointAclPolicies.js.map +1 -0
- package/cr/getEndpointAclPolicy.d.ts +52 -0
- package/cr/getEndpointAclPolicy.js +28 -0
- package/cr/getEndpointAclPolicy.js.map +1 -0
- package/cr/getRegistry.d.ts +14 -10
- package/cr/getRegistry.js.map +1 -1
- package/cr/index.d.ts +9 -0
- package/cr/index.js +12 -1
- package/cr/index.js.map +1 -1
- package/cr/registry.d.ts +40 -25
- package/cr/registry.js +6 -1
- package/cr/registry.js.map +1 -1
- package/iam/accesskey.d.ts +23 -27
- package/iam/accesskey.js +2 -2
- package/iam/accesskey.js.map +1 -1
- package/iam/getAccesskey.d.ts +10 -10
- package/mongodb/getSslState.d.ts +56 -0
- package/mongodb/getSslState.js +28 -0
- package/mongodb/getSslState.js.map +1 -0
- package/mongodb/getSslStates.d.ts +22 -0
- package/mongodb/getSslStates.js +24 -0
- package/mongodb/getSslStates.js.map +1 -0
- package/mongodb/index.d.ts +9 -0
- package/mongodb/index.js +12 -1
- package/mongodb/index.js.map +1 -1
- package/mongodb/sslState.d.ts +105 -0
- package/mongodb/sslState.js +81 -0
- package/mongodb/sslState.js.map +1 -0
- package/organization/getServiceControlPolicies.d.ts +22 -0
- package/organization/getServiceControlPolicies.js +24 -0
- package/organization/getServiceControlPolicies.js.map +1 -0
- package/organization/getServiceControlPolicy.d.ts +69 -0
- package/organization/getServiceControlPolicy.js +28 -0
- package/organization/getServiceControlPolicy.js.map +1 -0
- package/organization/index.d.ts +9 -0
- package/organization/index.js +12 -1
- package/organization/index.js.map +1 -1
- package/organization/serviceControlPolicy.d.ts +118 -0
- package/organization/serviceControlPolicy.js +78 -0
- package/organization/serviceControlPolicy.js.map +1 -0
- package/package.json +1 -1
- package/privatelink/endpointService.d.ts +15 -3
- package/privatelink/endpointService.js +2 -0
- package/privatelink/endpointService.js.map +1 -1
- package/privatelink/getEndpointService.d.ts +5 -1
- package/privatelink/getEndpointService.js.map +1 -1
- package/privatelink/getVpcEndpointConnection.d.ts +89 -0
- package/privatelink/getVpcEndpointConnection.js +28 -0
- package/privatelink/getVpcEndpointConnection.js.map +1 -0
- package/privatelink/getVpcEndpointConnections.d.ts +22 -0
- package/privatelink/getVpcEndpointConnections.js +24 -0
- package/privatelink/getVpcEndpointConnections.js.map +1 -0
- package/privatelink/index.d.ts +9 -0
- package/privatelink/index.js +12 -1
- package/privatelink/index.js.map +1 -1
- package/privatelink/vpcEndpointConnection.d.ts +156 -0
- package/privatelink/vpcEndpointConnection.js +88 -0
- package/privatelink/vpcEndpointConnection.js.map +1 -0
- package/rabbitmq/allowList.d.ts +151 -0
- package/rabbitmq/allowList.js +100 -0
- package/rabbitmq/allowList.js.map +1 -0
- package/rabbitmq/getAllowList.d.ts +73 -0
- package/rabbitmq/getAllowList.js +28 -0
- package/rabbitmq/getAllowList.js.map +1 -0
- package/rabbitmq/getAllowLists.d.ts +22 -0
- package/rabbitmq/getAllowLists.js +24 -0
- package/rabbitmq/getAllowLists.js.map +1 -0
- package/rabbitmq/index.d.ts +9 -0
- package/rabbitmq/index.js +12 -1
- package/rabbitmq/index.js.map +1 -1
- package/redis/allowList.d.ts +148 -0
- package/redis/allowList.js +78 -0
- package/redis/allowList.js.map +1 -0
- package/redis/getAllowList.d.ts +81 -0
- package/redis/getAllowList.js +28 -0
- package/redis/getAllowList.js.map +1 -0
- package/redis/getAllowLists.d.ts +22 -0
- package/redis/getAllowLists.js +24 -0
- package/redis/getAllowLists.js.map +1 -0
- package/redis/index.d.ts +9 -0
- package/redis/index.js +12 -1
- package/redis/index.js.map +1 -1
- package/storageebs/getSnapshotGroup.d.ts +81 -0
- package/storageebs/getSnapshotGroup.js +28 -0
- package/storageebs/getSnapshotGroup.js.map +1 -0
- package/storageebs/getSnapshotGroups.d.ts +22 -0
- package/storageebs/getSnapshotGroups.js +24 -0
- package/storageebs/getSnapshotGroups.js.map +1 -0
- package/storageebs/index.d.ts +9 -0
- package/storageebs/index.js +12 -1
- package/storageebs/index.js.map +1 -1
- package/storageebs/snapshotGroup.d.ts +168 -0
- package/storageebs/snapshotGroup.js +105 -0
- package/storageebs/snapshotGroup.js.map +1 -0
- package/tls/alarmNotifyGroup.d.ts +113 -0
- package/tls/alarmNotifyGroup.js +75 -0
- package/tls/alarmNotifyGroup.js.map +1 -0
- package/tls/getAlarmNotifyGroup.d.ts +69 -0
- package/tls/getAlarmNotifyGroup.js +28 -0
- package/tls/getAlarmNotifyGroup.js.map +1 -0
- package/tls/getAlarmNotifyGroups.d.ts +22 -0
- package/tls/getAlarmNotifyGroups.js +24 -0
- package/tls/getAlarmNotifyGroups.js.map +1 -0
- package/tls/getRule.d.ts +109 -0
- package/tls/getRule.js +28 -0
- package/tls/getRule.js.map +1 -0
- package/tls/getRules.d.ts +22 -0
- package/tls/getRules.js +24 -0
- package/tls/getRules.js.map +1 -0
- package/tls/getShipper.d.ts +101 -0
- package/tls/getShipper.js +28 -0
- package/tls/getShipper.js.map +1 -0
- package/tls/getShippers.d.ts +22 -0
- package/tls/getShippers.js +24 -0
- package/tls/getShippers.js.map +1 -0
- package/tls/index.d.ts +27 -0
- package/tls/index.js +34 -1
- package/tls/index.js.map +1 -1
- package/tls/rule.d.ts +221 -0
- package/tls/rule.js +98 -0
- package/tls/rule.js.map +1 -0
- package/tls/shipper.d.ts +211 -0
- package/tls/shipper.js +97 -0
- package/tls/shipper.js.map +1 -0
- package/transitrouter/getPeerAttachment.d.ts +109 -0
- package/transitrouter/getPeerAttachment.js +28 -0
- package/transitrouter/getPeerAttachment.js.map +1 -0
- package/transitrouter/getPeerAttachments.d.ts +22 -0
- package/transitrouter/getPeerAttachments.js +24 -0
- package/transitrouter/getPeerAttachments.js.map +1 -0
- package/transitrouter/index.d.ts +9 -0
- package/transitrouter/index.js +12 -1
- package/transitrouter/index.js.map +1 -1
- package/transitrouter/peerAttachment.d.ts +235 -0
- package/transitrouter/peerAttachment.js +122 -0
- package/transitrouter/peerAttachment.js.map +1 -0
- package/types/input.d.ts +954 -62
- package/types/output.d.ts +2390 -452
- package/vefaas/getRelease.d.ts +120 -0
- package/vefaas/getRelease.js +28 -0
- package/vefaas/getRelease.js.map +1 -0
- package/vefaas/getReleases.d.ts +22 -0
- package/vefaas/getReleases.js +24 -0
- package/vefaas/getReleases.js.map +1 -0
- package/vefaas/index.d.ts +9 -0
- package/vefaas/index.js +12 -1
- package/vefaas/index.js.map +1 -1
- package/vefaas/release.d.ts +253 -0
- package/vefaas/release.js +120 -0
- package/vefaas/release.js.map +1 -0
- package/vepfs/getMountService.d.ts +93 -0
- package/vepfs/getMountService.js +28 -0
- package/vepfs/getMountService.js.map +1 -0
- package/vepfs/getMountServices.d.ts +22 -0
- package/vepfs/getMountServices.js +24 -0
- package/vepfs/getMountServices.js.map +1 -0
- package/vepfs/index.d.ts +9 -0
- package/vepfs/index.js +12 -1
- package/vepfs/index.js.map +1 -1
- package/vepfs/mountService.d.ts +172 -0
- package/vepfs/mountService.js +99 -0
- package/vepfs/mountService.js.map +1 -0
- package/vke/getKubeconfig.d.ts +72 -0
- package/vke/getKubeconfig.js +28 -0
- package/vke/getKubeconfig.js.map +1 -0
- package/vke/getKubeconfigs.d.ts +22 -0
- package/vke/getKubeconfigs.js +24 -0
- package/vke/getKubeconfigs.js.map +1 -0
- package/vke/index.d.ts +9 -0
- package/vke/index.js +12 -1
- package/vke/index.js.map +1 -1
- package/vke/kubeconfig.d.ts +142 -0
- package/vke/kubeconfig.js +93 -0
- package/vke/kubeconfig.js.map +1 -0
- package/vpn/getSslVpnClientCert.d.ts +93 -0
- package/vpn/getSslVpnClientCert.js +28 -0
- package/vpn/getSslVpnClientCert.js.map +1 -0
- package/vpn/getSslVpnClientCerts.d.ts +22 -0
- package/vpn/getSslVpnClientCerts.js +24 -0
- package/vpn/getSslVpnClientCerts.js.map +1 -0
- package/vpn/index.d.ts +9 -0
- package/vpn/index.js +12 -1
- package/vpn/index.js.map +1 -1
- package/vpn/sslVpnClientCert.d.ts +183 -0
- package/vpn/sslVpnClientCert.js +104 -0
- package/vpn/sslVpnClientCert.js.map +1 -0
package/types/output.d.ts
CHANGED
|
@@ -2,27 +2,27 @@ import * as outputs from "../types/output";
|
|
|
2
2
|
export declare namespace alb {
|
|
3
3
|
interface AclAclEntry {
|
|
4
4
|
/**
|
|
5
|
-
* Description of the IP entry. Cannot start with http:// or https://. Must start with a letter or Chinese character. Can include numbers, English commas (,), periods (.), underscores (_), spaces
|
|
5
|
+
* Description of the IP entry. Cannot start with http:// or https://. Must start with a letter or Chinese character. Can include numbers, English commas (,), periods (.), underscores (_), spaces, equals signs (=), hyphens (-), Chinese commas (,), and Chinese periods (。). Length must be between 1 and 255 characters. If not specified, defaults to an empty string.
|
|
6
6
|
*/
|
|
7
7
|
description: string;
|
|
8
8
|
/**
|
|
9
|
-
* IP entry address range
|
|
9
|
+
* IP entry address range. Only CIDR addresses are supported.
|
|
10
10
|
*/
|
|
11
11
|
entry: string;
|
|
12
12
|
}
|
|
13
13
|
interface AclListener {
|
|
14
14
|
/**
|
|
15
|
-
*
|
|
15
|
+
* Listener control mode for this access control policy group. white: allowlist mode; black: denylist mode
|
|
16
16
|
*/
|
|
17
17
|
aclType: string;
|
|
18
18
|
}
|
|
19
19
|
interface AclTag {
|
|
20
20
|
/**
|
|
21
|
-
*
|
|
21
|
+
* Tag key for user tags. Length must be between 1 and 128 characters. Case sensitive. Cannot start with any combination of volc: or sys: in any case. Cannot start or end with a space. Can include characters from any language, numbers, spaces, underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), minus signs (-), and @. Tag keys for the same resource must be unique.
|
|
22
22
|
*/
|
|
23
23
|
key: string;
|
|
24
24
|
/**
|
|
25
|
-
* User tag value. Length
|
|
25
|
+
* User tag value. Length must be between 0 and 256 characters. Case sensitive. Cannot start or end with a space. Supports characters from all languages, numbers, spaces (), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @.
|
|
26
26
|
*/
|
|
27
27
|
value: string;
|
|
28
28
|
}
|
|
@@ -66,17 +66,17 @@ export declare namespace alb {
|
|
|
66
66
|
}
|
|
67
67
|
interface GetAclAclEntry {
|
|
68
68
|
/**
|
|
69
|
-
* Description of the IP entry. Cannot start with http:// or https://. Must start with a letter or Chinese character. Can include numbers, English commas (,), periods (.), underscores (_), spaces
|
|
69
|
+
* Description of the IP entry. Cannot start with http:// or https://. Must start with a letter or Chinese character. Can include numbers, English commas (,), periods (.), underscores (_), spaces, equals signs (=), hyphens (-), Chinese commas (,), and Chinese periods (。). Length must be between 1 and 255 characters. If not specified, defaults to an empty string.
|
|
70
70
|
*/
|
|
71
71
|
description: string;
|
|
72
72
|
/**
|
|
73
|
-
* IP entry address range
|
|
73
|
+
* IP entry address range. Only CIDR addresses are supported.
|
|
74
74
|
*/
|
|
75
75
|
entry: string;
|
|
76
76
|
}
|
|
77
77
|
interface GetAclListener {
|
|
78
78
|
/**
|
|
79
|
-
*
|
|
79
|
+
* Listener control mode for this access control policy group. white: allowlist mode; black: denylist mode
|
|
80
80
|
*/
|
|
81
81
|
aclType: string;
|
|
82
82
|
/**
|
|
@@ -98,11 +98,11 @@ export declare namespace alb {
|
|
|
98
98
|
}
|
|
99
99
|
interface GetAclTag {
|
|
100
100
|
/**
|
|
101
|
-
*
|
|
101
|
+
* Tag key for user tags. Length must be between 1 and 128 characters. Case sensitive. Cannot start with any combination of volc: or sys: in any case. Cannot start or end with a space. Can include characters from any language, numbers, spaces, underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), minus signs (-), and @. Tag keys for the same resource must be unique.
|
|
102
102
|
*/
|
|
103
103
|
key: string;
|
|
104
104
|
/**
|
|
105
|
-
* User tag value. Length
|
|
105
|
+
* User tag value. Length must be between 0 and 256 characters. Case sensitive. Cannot start or end with a space. Supports characters from all languages, numbers, spaces (), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @.
|
|
106
106
|
*/
|
|
107
107
|
value: string;
|
|
108
108
|
}
|
|
@@ -156,7 +156,7 @@ export declare namespace alb {
|
|
|
156
156
|
}
|
|
157
157
|
interface GetListenerDomainExtension {
|
|
158
158
|
/**
|
|
159
|
-
* Server certificate ID used by the domain. Effective when the certificate source is cert_center.
|
|
159
|
+
* Server certificate ID used by the domain name. Effective when the certificate source is cert_center.
|
|
160
160
|
*/
|
|
161
161
|
certCenterCertificateId: string;
|
|
162
162
|
/**
|
|
@@ -164,19 +164,19 @@ export declare namespace alb {
|
|
|
164
164
|
*/
|
|
165
165
|
certificateId: string;
|
|
166
166
|
/**
|
|
167
|
-
* Source of the server certificate used by the domain. Values: alb: certificate uploaded via ALB. cert_center: SSL certificate purchased or uploaded
|
|
167
|
+
* Source of the server certificate used by the domain. Values: alb: certificate uploaded via ALB. cert_center: SSL certificate purchased or uploaded via Volcano Engine Certificate Center.
|
|
168
168
|
*/
|
|
169
169
|
certificateSource: string;
|
|
170
170
|
/**
|
|
171
|
-
* Domain name. Usually cannot be empty. If the instance supports automatic selection of
|
|
171
|
+
* Domain name. Usually cannot be empty. If the instance supports automatic selection of extension certificates (SniAutoMatch is on), Domain must be set to an empty string. Must contain at least one '.' and cannot start or end with '.'. Only lowercase letters, digits, '.', '-', and '*' are allowed. Length limit: 1–128 characters. Wildcard domain: use '*' to replace one or more characters. '*' must be at the beginning or end of the domain name. '*' cannot appear twice in the same domain name. No characters other than '.' can appear before or after '*'. Exact domain: an exact domain name that complies with domain name specifications. Domain names under the same HTTPS listener cannot be duplicated. Domain name matching is case-insensitive.
|
|
172
172
|
*/
|
|
173
173
|
domain: string;
|
|
174
174
|
/**
|
|
175
|
-
*
|
|
175
|
+
* Extension domain name ID.
|
|
176
176
|
*/
|
|
177
177
|
domainExtensionId: string;
|
|
178
178
|
/**
|
|
179
|
-
* Listener ID
|
|
179
|
+
* Listener ID associated with the extended domain name.
|
|
180
180
|
*/
|
|
181
181
|
listenerId: string;
|
|
182
182
|
/**
|
|
@@ -184,7 +184,7 @@ export declare namespace alb {
|
|
|
184
184
|
*/
|
|
185
185
|
pcaLeafCertificateId: string;
|
|
186
186
|
/**
|
|
187
|
-
* If the instance supports automatic selection of
|
|
187
|
+
* If the instance supports automatic selection of extension certificates, that is, when SniAutoMatch is set to on, Domain is an empty string. San refers to the certificate's extension domain names, separated by commas.
|
|
188
188
|
*/
|
|
189
189
|
san: string;
|
|
190
190
|
}
|
|
@@ -200,11 +200,11 @@ export declare namespace alb {
|
|
|
200
200
|
}
|
|
201
201
|
interface GetListenerTag {
|
|
202
202
|
/**
|
|
203
|
-
*
|
|
203
|
+
* User tag key. Rules: Length must be between 1 and 128 characters. Case sensitive. Cannot start with any case combination of volc:. Cannot start or end with a space. Allowed characters include all languages, numbers, spaces, parentheses (), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), minus signs (-), and @. Tag keys for the same resource cannot be duplicated.
|
|
204
204
|
*/
|
|
205
205
|
key: string;
|
|
206
206
|
/**
|
|
207
|
-
*
|
|
207
|
+
* User tag value. Rules: Length must be between 0 and 256 characters. Case sensitive. Cannot start or end with a space. Allowed characters include all languages, numbers, spaces, parentheses (), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), minus signs (-), and @.
|
|
208
208
|
*/
|
|
209
209
|
value: string;
|
|
210
210
|
}
|
|
@@ -602,31 +602,31 @@ export declare namespace alb {
|
|
|
602
602
|
}
|
|
603
603
|
interface GetServerGroupHealthCheck {
|
|
604
604
|
/**
|
|
605
|
-
*
|
|
605
|
+
* The domain name for health checks must be configured as the actual address used by the backend server to provide external services. This parameter is only effective when HealthCheck.Protocol is set to HTTP. The domain name must contain at least one '.', and cannot start or end with a '.'. Each level of the domain name can include letters, numbers, '-', and '.' characters, but '-' cannot appear at the beginning or end of any level. Length must be between 1 and 128 characters. If this parameter is not provided or no value is specified, it defaults to empty, meaning the load balancer uses the private IP address of each backend server for health checks.
|
|
606
606
|
*/
|
|
607
607
|
domain: string;
|
|
608
608
|
/**
|
|
609
|
-
* Whether the listener
|
|
609
|
+
* Whether the listener has enabled health check. Values: on: enabled (default), off: disabled.
|
|
610
610
|
*/
|
|
611
611
|
enabled: string;
|
|
612
612
|
/**
|
|
613
|
-
* Health check threshold. Indicates
|
|
613
|
+
* Health check threshold. Indicates that a backend server is considered healthy if it passes the specified number of consecutive health checks. Unit: checks. Range: 2–10. Default: 3.
|
|
614
614
|
*/
|
|
615
615
|
healthyThreshold: number;
|
|
616
616
|
/**
|
|
617
|
-
* HTTP status codes
|
|
617
|
+
* HTTP status codes indicating a successful health check. Use commas to separate multiple codes. This parameter is only available when HealthCheck.Protocol is set to HTTP. Valid values: http*2xx (default), http*3xx (default), http*4xx, http*5xx.
|
|
618
618
|
*/
|
|
619
619
|
httpCode: string;
|
|
620
620
|
/**
|
|
621
|
-
*
|
|
621
|
+
* HTTP protocol version for health checks. This parameter is only available when HealthCheck.Protocol is set to HTTP. Values: HTTP1.0 (default when using API), HTTP1.1.
|
|
622
622
|
*/
|
|
623
623
|
httpVersion: string;
|
|
624
624
|
/**
|
|
625
|
-
* After health
|
|
625
|
+
* After enabling health check, the interval for performing health checks. Unit: seconds. Range: 1–300s. Default: 2.
|
|
626
626
|
*/
|
|
627
627
|
interval: number;
|
|
628
628
|
/**
|
|
629
|
-
*
|
|
629
|
+
* After enabling health check, the health check method. This parameter is effective only when HealthCheck.Protocol is set to HTTP. Values: GET: server must support the GET method. HEAD (default): server returns only HEAD header information, which can reduce backend performance consumption, but the server must support the HEAD method.
|
|
630
630
|
*/
|
|
631
631
|
method: string;
|
|
632
632
|
/**
|
|
@@ -638,15 +638,15 @@ export declare namespace alb {
|
|
|
638
638
|
*/
|
|
639
639
|
protocol: string;
|
|
640
640
|
/**
|
|
641
|
-
* Health check response timeout. If the backend server does not respond correctly within the specified time,
|
|
641
|
+
* Health check response timeout. If the backend server does not respond correctly within the specified time, it is considered a health check failure. Unit: seconds; range: 1~60; default: 2.
|
|
642
642
|
*/
|
|
643
643
|
timeout: number;
|
|
644
644
|
/**
|
|
645
|
-
* Unhealthy threshold for health checks.
|
|
645
|
+
* Unhealthy threshold for health checks. If a backend server fails the specified number of consecutive health checks, it will be considered unhealthy. Unit: times. Value range: 2–10. Default: 3.
|
|
646
646
|
*/
|
|
647
647
|
unhealthyThreshold: number;
|
|
648
648
|
/**
|
|
649
|
-
* Health check path
|
|
649
|
+
* Health check path, which must be configured as the actual path provided by the backend server. This parameter is effective only when HealthCheck.Protocol is set to HTTP. Must start with '/'. Only letters, numbers, '-', '_', '/', '.', '%', '?', '#', '&', '=' are allowed. Length must be between 1 and 128 characters. If this parameter is not specified or no value is provided, the default is '/'.
|
|
650
650
|
*/
|
|
651
651
|
uri: string;
|
|
652
652
|
}
|
|
@@ -662,7 +662,7 @@ export declare namespace alb {
|
|
|
662
662
|
*/
|
|
663
663
|
description: string;
|
|
664
664
|
/**
|
|
665
|
-
* ID of the cloud server instance or network interface
|
|
665
|
+
* ID of the cloud server instance or network interface.
|
|
666
666
|
*/
|
|
667
667
|
instanceId: string;
|
|
668
668
|
/**
|
|
@@ -674,7 +674,7 @@ export declare namespace alb {
|
|
|
674
674
|
*/
|
|
675
675
|
port: number;
|
|
676
676
|
/**
|
|
677
|
-
* Enable remote IP feature. This field is valid
|
|
677
|
+
* Enable remote IP feature. This field is valid when the backend server instance type is IP address, that is, when Type is set to ip. Values: on: enabled. off (default): disabled.
|
|
678
678
|
*/
|
|
679
679
|
remoteEnabled: string;
|
|
680
680
|
/**
|
|
@@ -682,21 +682,21 @@ export declare namespace alb {
|
|
|
682
682
|
*/
|
|
683
683
|
serverId: string;
|
|
684
684
|
/**
|
|
685
|
-
* Backend server instance type.
|
|
685
|
+
* Backend server instance type. ECS: cloud server instance; ENI: secondary network interface; IP: IP address (only valid for IP-type server groups).
|
|
686
686
|
*/
|
|
687
687
|
type: string;
|
|
688
688
|
/**
|
|
689
|
-
*
|
|
689
|
+
* Backend server weight.
|
|
690
690
|
*/
|
|
691
691
|
weight: number;
|
|
692
692
|
}
|
|
693
693
|
interface GetServerGroupStickySessionConfig {
|
|
694
694
|
/**
|
|
695
|
-
*
|
|
695
|
+
* Session persistence cookie name configured for the service. Only valid when session persistence is enabled and cookie rewrite is selected. Rules: Cookie name length must be 1–200 characters. The name can only contain ASCII letters and numbers, cannot include commas (,), semicolons (;), or spaces, and cannot start with a dollar sign ($). When stickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is server, this parameter is required. When StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert, this parameter is invalid.
|
|
696
696
|
*/
|
|
697
697
|
cookie: string;
|
|
698
698
|
/**
|
|
699
|
-
* Session persistence cookie timeout. Only
|
|
699
|
+
* Session persistence cookie timeout. Only effective when session persistence is enabled and cookie insertion is selected. Unit: seconds. Rules: timeout range: 1~86400; default: 1000. This parameter is required when StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert. This parameter is invalid when StickySessionConfig.StickySessionEnabled is on and StickySessionType is server.
|
|
700
700
|
*/
|
|
701
701
|
cookieTimeout: number;
|
|
702
702
|
/**
|
|
@@ -704,17 +704,17 @@ export declare namespace alb {
|
|
|
704
704
|
*/
|
|
705
705
|
stickySessionEnabled: string;
|
|
706
706
|
/**
|
|
707
|
-
* Cookie handling method.
|
|
707
|
+
* Cookie handling method. When StickySessionConfig.StickySessionEnabled is set to on, this field is required. Values: insert: Insert a Cookie. ALB records the backend server to which the client's first request is forwarded. ALB inserts a Cookie in the response, and subsequent client requests carrying this Cookie are forwarded to the previously recorded backend server. server: Rewrite the Cookie. When session persistence with Cookie rewriting is enabled, after the client's first request is forwarded to the backend server, if ALB finds your custom Cookie in the response, it rewrites the original Cookie. Subsequent client requests carrying the rewritten Cookie are forwarded to the previously recorded backend server.
|
|
708
708
|
*/
|
|
709
709
|
stickySessionType: string;
|
|
710
710
|
}
|
|
711
711
|
interface GetServerGroupTag {
|
|
712
712
|
/**
|
|
713
|
-
* Tag key.
|
|
713
|
+
* Tag key. Duplicate tag keys are not allowed for the same resource.
|
|
714
714
|
*/
|
|
715
715
|
key: string;
|
|
716
716
|
/**
|
|
717
|
-
* Tag value
|
|
717
|
+
* Tag value.
|
|
718
718
|
*/
|
|
719
719
|
value: string;
|
|
720
720
|
}
|
|
@@ -730,7 +730,7 @@ export declare namespace alb {
|
|
|
730
730
|
}
|
|
731
731
|
interface ListenerDomainExtension {
|
|
732
732
|
/**
|
|
733
|
-
* Server certificate ID used by the domain. Effective when the certificate source is cert_center.
|
|
733
|
+
* Server certificate ID used by the domain name. Effective when the certificate source is cert_center.
|
|
734
734
|
*/
|
|
735
735
|
certCenterCertificateId: string;
|
|
736
736
|
/**
|
|
@@ -738,11 +738,11 @@ export declare namespace alb {
|
|
|
738
738
|
*/
|
|
739
739
|
certificateId: string;
|
|
740
740
|
/**
|
|
741
|
-
* Source of the server certificate used by the domain. Values: alb: certificate uploaded via ALB. cert_center: SSL certificate purchased or uploaded
|
|
741
|
+
* Source of the server certificate used by the domain. Values: alb: certificate uploaded via ALB. cert_center: SSL certificate purchased or uploaded via Volcano Engine Certificate Center.
|
|
742
742
|
*/
|
|
743
743
|
certificateSource: string;
|
|
744
744
|
/**
|
|
745
|
-
* Domain name. Usually cannot be empty. If the instance supports automatic selection of
|
|
745
|
+
* Domain name. Usually cannot be empty. If the instance supports automatic selection of extension certificates (SniAutoMatch is on), Domain must be set to an empty string. Must contain at least one '.' and cannot start or end with '.'. Only lowercase letters, digits, '.', '-', and '*' are allowed. Length limit: 1–128 characters. Wildcard domain: use '*' to replace one or more characters. '*' must be at the beginning or end of the domain name. '*' cannot appear twice in the same domain name. No characters other than '.' can appear before or after '*'. Exact domain: an exact domain name that complies with domain name specifications. Domain names under the same HTTPS listener cannot be duplicated. Domain name matching is case-insensitive.
|
|
746
746
|
*/
|
|
747
747
|
domain: string;
|
|
748
748
|
/**
|
|
@@ -750,7 +750,7 @@ export declare namespace alb {
|
|
|
750
750
|
*/
|
|
751
751
|
pcaLeafCertificateId: string;
|
|
752
752
|
/**
|
|
753
|
-
* If the instance supports automatic selection of
|
|
753
|
+
* If the instance supports automatic selection of extension certificates, that is, when SniAutoMatch is set to on, Domain is an empty string. San refers to the certificate's extension domain names, separated by commas.
|
|
754
754
|
*/
|
|
755
755
|
san: string;
|
|
756
756
|
}
|
|
@@ -766,11 +766,11 @@ export declare namespace alb {
|
|
|
766
766
|
}
|
|
767
767
|
interface ListenerTag {
|
|
768
768
|
/**
|
|
769
|
-
*
|
|
769
|
+
* User tag key. Rules: Length must be between 1 and 128 characters. Case sensitive. Cannot start with any case combination of volc:. Cannot start or end with a space. Allowed characters include all languages, numbers, spaces, parentheses (), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), minus signs (-), and @. Tag keys for the same resource cannot be duplicated.
|
|
770
770
|
*/
|
|
771
771
|
key: string;
|
|
772
772
|
/**
|
|
773
|
-
*
|
|
773
|
+
* User tag value. Rules: Length must be between 0 and 256 characters. Case sensitive. Cannot start or end with a space. Allowed characters include all languages, numbers, spaces, parentheses (), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), minus signs (-), and @.
|
|
774
774
|
*/
|
|
775
775
|
value: string;
|
|
776
776
|
}
|
|
@@ -1067,31 +1067,31 @@ export declare namespace alb {
|
|
|
1067
1067
|
}
|
|
1068
1068
|
interface ServerGroupHealthCheck {
|
|
1069
1069
|
/**
|
|
1070
|
-
*
|
|
1070
|
+
* The domain name for health checks must be configured as the actual address used by the backend server to provide external services. This parameter is only effective when HealthCheck.Protocol is set to HTTP. The domain name must contain at least one '.', and cannot start or end with a '.'. Each level of the domain name can include letters, numbers, '-', and '.' characters, but '-' cannot appear at the beginning or end of any level. Length must be between 1 and 128 characters. If this parameter is not provided or no value is specified, it defaults to empty, meaning the load balancer uses the private IP address of each backend server for health checks.
|
|
1071
1071
|
*/
|
|
1072
1072
|
domain: string;
|
|
1073
1073
|
/**
|
|
1074
|
-
* Whether the listener
|
|
1074
|
+
* Whether the listener has enabled health check. Values: on: enabled (default), off: disabled.
|
|
1075
1075
|
*/
|
|
1076
1076
|
enabled: string;
|
|
1077
1077
|
/**
|
|
1078
|
-
* Health check threshold. Indicates
|
|
1078
|
+
* Health check threshold. Indicates that a backend server is considered healthy if it passes the specified number of consecutive health checks. Unit: checks. Range: 2–10. Default: 3.
|
|
1079
1079
|
*/
|
|
1080
1080
|
healthyThreshold: number;
|
|
1081
1081
|
/**
|
|
1082
|
-
* HTTP status codes
|
|
1082
|
+
* HTTP status codes indicating a successful health check. Use commas to separate multiple codes. This parameter is only available when HealthCheck.Protocol is set to HTTP. Valid values: http*2xx (default), http*3xx (default), http*4xx, http*5xx.
|
|
1083
1083
|
*/
|
|
1084
1084
|
httpCode: string;
|
|
1085
1085
|
/**
|
|
1086
|
-
*
|
|
1086
|
+
* HTTP protocol version for health checks. This parameter is only available when HealthCheck.Protocol is set to HTTP. Values: HTTP1.0 (default when using API), HTTP1.1.
|
|
1087
1087
|
*/
|
|
1088
1088
|
httpVersion: string;
|
|
1089
1089
|
/**
|
|
1090
|
-
* After health
|
|
1090
|
+
* After enabling health check, the interval for performing health checks. Unit: seconds. Range: 1–300s. Default: 2.
|
|
1091
1091
|
*/
|
|
1092
1092
|
interval: number;
|
|
1093
1093
|
/**
|
|
1094
|
-
*
|
|
1094
|
+
* After enabling health check, the health check method. This parameter is effective only when HealthCheck.Protocol is set to HTTP. Values: GET: server must support the GET method. HEAD (default): server returns only HEAD header information, which can reduce backend performance consumption, but the server must support the HEAD method.
|
|
1095
1095
|
*/
|
|
1096
1096
|
method: string;
|
|
1097
1097
|
/**
|
|
@@ -1103,15 +1103,15 @@ export declare namespace alb {
|
|
|
1103
1103
|
*/
|
|
1104
1104
|
protocol: string;
|
|
1105
1105
|
/**
|
|
1106
|
-
* Health check response timeout. If the backend server does not respond correctly within the specified time,
|
|
1106
|
+
* Health check response timeout. If the backend server does not respond correctly within the specified time, it is considered a health check failure. Unit: seconds; range: 1~60; default: 2.
|
|
1107
1107
|
*/
|
|
1108
1108
|
timeout: number;
|
|
1109
1109
|
/**
|
|
1110
|
-
* Unhealthy threshold for health checks.
|
|
1110
|
+
* Unhealthy threshold for health checks. If a backend server fails the specified number of consecutive health checks, it will be considered unhealthy. Unit: times. Value range: 2–10. Default: 3.
|
|
1111
1111
|
*/
|
|
1112
1112
|
unhealthyThreshold: number;
|
|
1113
1113
|
/**
|
|
1114
|
-
* Health check path
|
|
1114
|
+
* Health check path, which must be configured as the actual path provided by the backend server. This parameter is effective only when HealthCheck.Protocol is set to HTTP. Must start with '/'. Only letters, numbers, '-', '_', '/', '.', '%', '?', '#', '&', '=' are allowed. Length must be between 1 and 128 characters. If this parameter is not specified or no value is provided, the default is '/'.
|
|
1115
1115
|
*/
|
|
1116
1116
|
uri: string;
|
|
1117
1117
|
}
|
|
@@ -1127,7 +1127,7 @@ export declare namespace alb {
|
|
|
1127
1127
|
*/
|
|
1128
1128
|
description: string;
|
|
1129
1129
|
/**
|
|
1130
|
-
* ID of the cloud server instance or network interface
|
|
1130
|
+
* ID of the cloud server instance or network interface.
|
|
1131
1131
|
*/
|
|
1132
1132
|
instanceId: string;
|
|
1133
1133
|
/**
|
|
@@ -1139,7 +1139,7 @@ export declare namespace alb {
|
|
|
1139
1139
|
*/
|
|
1140
1140
|
port: number;
|
|
1141
1141
|
/**
|
|
1142
|
-
* Enable remote IP feature. This field is valid
|
|
1142
|
+
* Enable remote IP feature. This field is valid when the backend server instance type is IP address, that is, when Type is set to ip. Values: on: enabled. off (default): disabled.
|
|
1143
1143
|
*/
|
|
1144
1144
|
remoteEnabled: string;
|
|
1145
1145
|
/**
|
|
@@ -1147,21 +1147,21 @@ export declare namespace alb {
|
|
|
1147
1147
|
*/
|
|
1148
1148
|
serverId: string;
|
|
1149
1149
|
/**
|
|
1150
|
-
* Backend server instance type.
|
|
1150
|
+
* Backend server instance type. ECS: cloud server instance; ENI: secondary network interface; IP: IP address (only valid for IP-type server groups).
|
|
1151
1151
|
*/
|
|
1152
1152
|
type: string;
|
|
1153
1153
|
/**
|
|
1154
|
-
*
|
|
1154
|
+
* Backend server weight.
|
|
1155
1155
|
*/
|
|
1156
1156
|
weight: number;
|
|
1157
1157
|
}
|
|
1158
1158
|
interface ServerGroupStickySessionConfig {
|
|
1159
1159
|
/**
|
|
1160
|
-
*
|
|
1160
|
+
* Session persistence cookie name configured for the service. Only valid when session persistence is enabled and cookie rewrite is selected. Rules: Cookie name length must be 1–200 characters. The name can only contain ASCII letters and numbers, cannot include commas (,), semicolons (;), or spaces, and cannot start with a dollar sign ($). When stickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is server, this parameter is required. When StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert, this parameter is invalid.
|
|
1161
1161
|
*/
|
|
1162
1162
|
cookie: string;
|
|
1163
1163
|
/**
|
|
1164
|
-
* Session persistence cookie timeout. Only
|
|
1164
|
+
* Session persistence cookie timeout. Only effective when session persistence is enabled and cookie insertion is selected. Unit: seconds. Rules: timeout range: 1~86400; default: 1000. This parameter is required when StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert. This parameter is invalid when StickySessionConfig.StickySessionEnabled is on and StickySessionType is server.
|
|
1165
1165
|
*/
|
|
1166
1166
|
cookieTimeout: number;
|
|
1167
1167
|
/**
|
|
@@ -1169,17 +1169,17 @@ export declare namespace alb {
|
|
|
1169
1169
|
*/
|
|
1170
1170
|
stickySessionEnabled: string;
|
|
1171
1171
|
/**
|
|
1172
|
-
* Cookie handling method.
|
|
1172
|
+
* Cookie handling method. When StickySessionConfig.StickySessionEnabled is set to on, this field is required. Values: insert: Insert a Cookie. ALB records the backend server to which the client's first request is forwarded. ALB inserts a Cookie in the response, and subsequent client requests carrying this Cookie are forwarded to the previously recorded backend server. server: Rewrite the Cookie. When session persistence with Cookie rewriting is enabled, after the client's first request is forwarded to the backend server, if ALB finds your custom Cookie in the response, it rewrites the original Cookie. Subsequent client requests carrying the rewritten Cookie are forwarded to the previously recorded backend server.
|
|
1173
1173
|
*/
|
|
1174
1174
|
stickySessionType: string;
|
|
1175
1175
|
}
|
|
1176
1176
|
interface ServerGroupTag {
|
|
1177
1177
|
/**
|
|
1178
|
-
* Tag key.
|
|
1178
|
+
* Tag key. Duplicate tag keys are not allowed for the same resource.
|
|
1179
1179
|
*/
|
|
1180
1180
|
key: string;
|
|
1181
1181
|
/**
|
|
1182
|
-
* Tag value
|
|
1182
|
+
* Tag value.
|
|
1183
1183
|
*/
|
|
1184
1184
|
value: string;
|
|
1185
1185
|
}
|
|
@@ -7849,6 +7849,34 @@ export declare namespace cen {
|
|
|
7849
7849
|
*/
|
|
7850
7850
|
value: string;
|
|
7851
7851
|
}
|
|
7852
|
+
interface GetServiceRouteEntryPublishToInstance {
|
|
7853
|
+
/**
|
|
7854
|
+
* Network instance ID for published cloud service access route.
|
|
7855
|
+
*/
|
|
7856
|
+
instanceId: string;
|
|
7857
|
+
/**
|
|
7858
|
+
* Region for published cloud service access route.
|
|
7859
|
+
*/
|
|
7860
|
+
instanceRegionId: string;
|
|
7861
|
+
/**
|
|
7862
|
+
* Network instance type for published cloud service access route.
|
|
7863
|
+
*/
|
|
7864
|
+
instanceType: string;
|
|
7865
|
+
}
|
|
7866
|
+
interface ServiceRouteEntryPublishToInstance {
|
|
7867
|
+
/**
|
|
7868
|
+
* Network instance ID for published cloud service access route.
|
|
7869
|
+
*/
|
|
7870
|
+
instanceId: string;
|
|
7871
|
+
/**
|
|
7872
|
+
* Region for published cloud service access route.
|
|
7873
|
+
*/
|
|
7874
|
+
instanceRegionId: string;
|
|
7875
|
+
/**
|
|
7876
|
+
* Network instance type for published cloud service access route.
|
|
7877
|
+
*/
|
|
7878
|
+
instanceType: string;
|
|
7879
|
+
}
|
|
7852
7880
|
}
|
|
7853
7881
|
export declare namespace clb {
|
|
7854
7882
|
interface AclAclEntry {
|
|
@@ -8195,6 +8223,24 @@ export declare namespace clb {
|
|
|
8195
8223
|
*/
|
|
8196
8224
|
value: string;
|
|
8197
8225
|
}
|
|
8226
|
+
interface GetListenerDomainExtension {
|
|
8227
|
+
/**
|
|
8228
|
+
* Certificate ID of the extended domain name.
|
|
8229
|
+
*/
|
|
8230
|
+
certCenterCertificateId: string;
|
|
8231
|
+
/**
|
|
8232
|
+
* Certificate source for the extended domain name to be added. Value: cert_center: SSL certificate from Volcano Engine Certificate Center. This parameter is required when adding an extended domain name.
|
|
8233
|
+
*/
|
|
8234
|
+
certificateSource: string;
|
|
8235
|
+
/**
|
|
8236
|
+
* Domain name. Supports both wildcard and exact domain names. Specifications: 1. Must contain at least one '.', and cannot start or end with '.'. 2. Only letters, numbers, '.', '-', and '*' are allowed. 3. Length must be between 1 and 128 characters. 4. Wildcard domain: Use '*' to replace one or more characters. 5. Exact domain: A domain name that strictly follows domain name specifications.
|
|
8237
|
+
*/
|
|
8238
|
+
domain: string;
|
|
8239
|
+
/**
|
|
8240
|
+
* Extended domain name ID.
|
|
8241
|
+
*/
|
|
8242
|
+
domainExtensionId: string;
|
|
8243
|
+
}
|
|
8198
8244
|
interface GetListenerHealthCheck {
|
|
8199
8245
|
/**
|
|
8200
8246
|
* Domain name for health check. Must be set to the actual address provided by the backend server. This parameter takes effect when Protocol is set to HTTP or HTTPS and HealthCheck.Enabled is on. Must contain at least one period (.), and cannot start or end with a period (.). Each string can include letters, numbers, hyphens (-), and periods (.), with hyphens (-) not allowed at the beginning or end of the string. Length limit: 1 to 128 characters. If this parameter is not provided or no value is specified, the default is empty, meaning CLB uses the private IP address of each backend server for health checks.
|
|
@@ -8563,6 +8609,20 @@ export declare namespace clb {
|
|
|
8563
8609
|
*/
|
|
8564
8610
|
value: string;
|
|
8565
8611
|
}
|
|
8612
|
+
interface ListenerDomainExtension {
|
|
8613
|
+
/**
|
|
8614
|
+
* Certificate ID of the extended domain name.
|
|
8615
|
+
*/
|
|
8616
|
+
certCenterCertificateId: string;
|
|
8617
|
+
/**
|
|
8618
|
+
* Certificate source for the extended domain name to be added. Value: cert_center: SSL certificate from Volcano Engine Certificate Center. This parameter is required when adding an extended domain name.
|
|
8619
|
+
*/
|
|
8620
|
+
certificateSource: string;
|
|
8621
|
+
/**
|
|
8622
|
+
* Domain name. Supports both wildcard and exact domain names. Specifications: 1. Must contain at least one '.', and cannot start or end with '.'. 2. Only letters, numbers, '.', '-', and '*' are allowed. 3. Length must be between 1 and 128 characters. 4. Wildcard domain: Use '*' to replace one or more characters. 5. Exact domain: A domain name that strictly follows domain name specifications.
|
|
8623
|
+
*/
|
|
8624
|
+
domain: string;
|
|
8625
|
+
}
|
|
8566
8626
|
interface ListenerHealthCheck {
|
|
8567
8627
|
/**
|
|
8568
8628
|
* Domain name for health check. Must be set to the actual address provided by the backend server. This parameter takes effect when Protocol is set to HTTP or HTTPS and HealthCheck.Enabled is on. Must contain at least one period (.), and cannot start or end with a period (.). Each string can include letters, numbers, hyphens (-), and periods (.), with hyphens (-) not allowed at the beginning or end of the string. Length limit: 1 to 128 characters. If this parameter is not provided or no value is specified, the default is empty, meaning CLB uses the private IP address of each backend server for health checks.
|
|
@@ -9402,41 +9462,49 @@ export declare namespace config {
|
|
|
9402
9462
|
}
|
|
9403
9463
|
}
|
|
9404
9464
|
export declare namespace cr {
|
|
9465
|
+
interface GetRegistryEndpoint {
|
|
9466
|
+
/**
|
|
9467
|
+
* Public IP allowlist
|
|
9468
|
+
*/
|
|
9469
|
+
aclPolicies: outputs.cr.GetRegistryEndpointAclPolicy[];
|
|
9470
|
+
/**
|
|
9471
|
+
* Whether to enable the public endpoint. Options: false: not enabled; true: enabled. Default is false
|
|
9472
|
+
*/
|
|
9473
|
+
enabled: boolean;
|
|
9474
|
+
/**
|
|
9475
|
+
* Current status of the public endpoint. Parameter values: Enabling: enabling; Enabled: enabled; Disabling: disabling; Updating: updating; Failed: failed; Disabled: disabled
|
|
9476
|
+
*/
|
|
9477
|
+
status: string;
|
|
9478
|
+
}
|
|
9479
|
+
interface GetRegistryEndpointAclPolicy {
|
|
9480
|
+
/**
|
|
9481
|
+
* IP entry address
|
|
9482
|
+
*/
|
|
9483
|
+
description: string;
|
|
9484
|
+
/**
|
|
9485
|
+
* IP entry description
|
|
9486
|
+
*/
|
|
9487
|
+
entry: string;
|
|
9488
|
+
}
|
|
9405
9489
|
interface GetRegistryProxyCache {
|
|
9406
9490
|
/**
|
|
9407
|
-
* Instance types supported by ProxyCache
|
|
9491
|
+
* Instance types supported by ProxyCache. Parameter value description: DockerHub: DockerHub image repository.
|
|
9408
9492
|
*/
|
|
9409
9493
|
type: string;
|
|
9410
9494
|
}
|
|
9411
9495
|
interface GetRegistryStatus {
|
|
9412
9496
|
/**
|
|
9413
|
-
* Creating, [ Progressing ]: Creating
|
|
9414
|
-
* Running, [ Ok ]: Running
|
|
9415
|
-
* Running, [ Degraded ]: Running
|
|
9416
|
-
* Stopped, [ Balance ]: Suspended due to insufficient balance
|
|
9417
|
-
* Stopped, [ Released ]: Pending reclamation
|
|
9418
|
-
* Stopped, [ Released, Balance ]: Suspended due to insufficient balance
|
|
9419
|
-
* Starting, [ Progressing ]: Starting
|
|
9420
|
-
* Deleting, [ Progressing ]: Deleting
|
|
9421
|
-
* Failed, [ Unknown ]: Abnormal
|
|
9497
|
+
* Creating, [ Progressing ]: Creating. Running, [ Ok ]: Running. Running, [ Degraded ]: Running. Stopped, [ Balance ]: Suspended due to overdue payment. Stopped, [ Released ]: Pending recycle. Stopped, [ Released, Balance ]: Suspended due to overdue payment. Starting, [ Progressing ]: Starting. Deleting, [ Progressing ]: Deleting. Failed, [ Unknown ]: Error.
|
|
9422
9498
|
*/
|
|
9423
9499
|
conditions: string[];
|
|
9424
9500
|
/**
|
|
9425
|
-
* Creating, [ Progressing ]: Creating
|
|
9426
|
-
* Running, [ Ok ]: Running
|
|
9427
|
-
* Running, [ Degraded ]: Running
|
|
9428
|
-
* Stopped, [ Balance ]: Suspended due to insufficient balance
|
|
9429
|
-
* Stopped, [ Released ]: Pending reclamation
|
|
9430
|
-
* Stopped, [ Released, Balance ]: Suspended due to insufficient balance
|
|
9431
|
-
* Starting, [ Progressing ]: Starting
|
|
9432
|
-
* Deleting, [ Progressing ]: Deleting
|
|
9433
|
-
* Failed, [ Unknown ]: Abnormal
|
|
9501
|
+
* Creating, [ Progressing ]: Creating. Running, [ Ok ]: Running. Running, [ Degraded ]: Running. Stopped, [ Balance ]: Suspended due to overdue payment. Stopped, [ Released ]: Pending recycle. Stopped, [ Released, Balance ]: Suspended due to overdue payment. Starting, [ Progressing ]: Starting. Deleting, [ Progressing ]: Deleting. Failed, [ Unknown ]: Error.
|
|
9434
9502
|
*/
|
|
9435
9503
|
phase: string;
|
|
9436
9504
|
}
|
|
9437
9505
|
interface GetRegistryTag {
|
|
9438
9506
|
/**
|
|
9439
|
-
* Tag key
|
|
9507
|
+
* Tag key
|
|
9440
9508
|
*/
|
|
9441
9509
|
key: string;
|
|
9442
9510
|
/**
|
|
@@ -9444,41 +9512,46 @@ export declare namespace cr {
|
|
|
9444
9512
|
*/
|
|
9445
9513
|
value: string;
|
|
9446
9514
|
}
|
|
9515
|
+
interface RegistryEndpoint {
|
|
9516
|
+
aclPolicies: outputs.cr.RegistryEndpointAclPolicy[];
|
|
9517
|
+
/**
|
|
9518
|
+
* Whether to enable the public endpoint. Options: false: not enabled; true: enabled. Default is false
|
|
9519
|
+
*/
|
|
9520
|
+
enabled: boolean;
|
|
9521
|
+
/**
|
|
9522
|
+
* Current status of the public endpoint. Parameter values: Enabling: enabling; Enabled: enabled; Disabling: disabling; Updating: updating; Failed: failed; Disabled: disabled
|
|
9523
|
+
*/
|
|
9524
|
+
status: string;
|
|
9525
|
+
}
|
|
9526
|
+
interface RegistryEndpointAclPolicy {
|
|
9527
|
+
/**
|
|
9528
|
+
* IP entry address
|
|
9529
|
+
*/
|
|
9530
|
+
description: string;
|
|
9531
|
+
/**
|
|
9532
|
+
* IP entry description
|
|
9533
|
+
*/
|
|
9534
|
+
entry: string;
|
|
9535
|
+
}
|
|
9447
9536
|
interface RegistryProxyCache {
|
|
9448
9537
|
/**
|
|
9449
|
-
* Instance types supported by ProxyCache
|
|
9538
|
+
* Instance types supported by ProxyCache. Parameter value description: DockerHub: DockerHub image repository.
|
|
9450
9539
|
*/
|
|
9451
9540
|
type: string;
|
|
9452
9541
|
}
|
|
9453
9542
|
interface RegistryStatus {
|
|
9454
9543
|
/**
|
|
9455
|
-
* Creating, [ Progressing ]: Creating
|
|
9456
|
-
* Running, [ Ok ]: Running
|
|
9457
|
-
* Running, [ Degraded ]: Running
|
|
9458
|
-
* Stopped, [ Balance ]: Suspended due to insufficient balance
|
|
9459
|
-
* Stopped, [ Released ]: Pending reclamation
|
|
9460
|
-
* Stopped, [ Released, Balance ]: Suspended due to insufficient balance
|
|
9461
|
-
* Starting, [ Progressing ]: Starting
|
|
9462
|
-
* Deleting, [ Progressing ]: Deleting
|
|
9463
|
-
* Failed, [ Unknown ]: Abnormal
|
|
9544
|
+
* Creating, [ Progressing ]: Creating. Running, [ Ok ]: Running. Running, [ Degraded ]: Running. Stopped, [ Balance ]: Suspended due to overdue payment. Stopped, [ Released ]: Pending recycle. Stopped, [ Released, Balance ]: Suspended due to overdue payment. Starting, [ Progressing ]: Starting. Deleting, [ Progressing ]: Deleting. Failed, [ Unknown ]: Error.
|
|
9464
9545
|
*/
|
|
9465
9546
|
conditions: string[];
|
|
9466
9547
|
/**
|
|
9467
|
-
* Creating, [ Progressing ]: Creating
|
|
9468
|
-
* Running, [ Ok ]: Running
|
|
9469
|
-
* Running, [ Degraded ]: Running
|
|
9470
|
-
* Stopped, [ Balance ]: Suspended due to insufficient balance
|
|
9471
|
-
* Stopped, [ Released ]: Pending reclamation
|
|
9472
|
-
* Stopped, [ Released, Balance ]: Suspended due to insufficient balance
|
|
9473
|
-
* Starting, [ Progressing ]: Starting
|
|
9474
|
-
* Deleting, [ Progressing ]: Deleting
|
|
9475
|
-
* Failed, [ Unknown ]: Abnormal
|
|
9548
|
+
* Creating, [ Progressing ]: Creating. Running, [ Ok ]: Running. Running, [ Degraded ]: Running. Stopped, [ Balance ]: Suspended due to overdue payment. Stopped, [ Released ]: Pending recycle. Stopped, [ Released, Balance ]: Suspended due to overdue payment. Starting, [ Progressing ]: Starting. Deleting, [ Progressing ]: Deleting. Failed, [ Unknown ]: Error.
|
|
9476
9549
|
*/
|
|
9477
9550
|
phase: string;
|
|
9478
9551
|
}
|
|
9479
9552
|
interface RegistryTag {
|
|
9480
9553
|
/**
|
|
9481
|
-
* Tag key
|
|
9554
|
+
* Tag key
|
|
9482
9555
|
*/
|
|
9483
9556
|
key: string;
|
|
9484
9557
|
/**
|
|
@@ -15167,6 +15240,24 @@ export declare namespace organization {
|
|
|
15167
15240
|
*/
|
|
15168
15241
|
mainName: string;
|
|
15169
15242
|
}
|
|
15243
|
+
interface GetServiceControlPolicyTarget {
|
|
15244
|
+
/**
|
|
15245
|
+
* Binding time.
|
|
15246
|
+
*/
|
|
15247
|
+
attachedTime: string;
|
|
15248
|
+
/**
|
|
15249
|
+
* Target ID.
|
|
15250
|
+
*/
|
|
15251
|
+
targetId: string;
|
|
15252
|
+
/**
|
|
15253
|
+
* Target name.
|
|
15254
|
+
*/
|
|
15255
|
+
targetName: string;
|
|
15256
|
+
/**
|
|
15257
|
+
* Target type: 1. OU 2. Account.
|
|
15258
|
+
*/
|
|
15259
|
+
targetType: string;
|
|
15260
|
+
}
|
|
15170
15261
|
interface OrganizationOrganization {
|
|
15171
15262
|
/**
|
|
15172
15263
|
* Creation Time
|
|
@@ -15211,6 +15302,16 @@ export declare namespace organization {
|
|
|
15211
15302
|
*/
|
|
15212
15303
|
mainName: string;
|
|
15213
15304
|
}
|
|
15305
|
+
interface ServiceControlPolicyTarget {
|
|
15306
|
+
/**
|
|
15307
|
+
* Target ID.
|
|
15308
|
+
*/
|
|
15309
|
+
targetId: string;
|
|
15310
|
+
/**
|
|
15311
|
+
* Target type: 1. OU 2. Account.
|
|
15312
|
+
*/
|
|
15313
|
+
targetType: string;
|
|
15314
|
+
}
|
|
15214
15315
|
}
|
|
15215
15316
|
export declare namespace privatelink {
|
|
15216
15317
|
interface EndpointServicePrivateDnsNameConfiguration {
|
|
@@ -15232,10 +15333,6 @@ export declare namespace privatelink {
|
|
|
15232
15333
|
value: string;
|
|
15233
15334
|
}
|
|
15234
15335
|
interface EndpointServiceResource {
|
|
15235
|
-
/**
|
|
15236
|
-
* Endpoint service ID.
|
|
15237
|
-
*/
|
|
15238
|
-
instanceId: string;
|
|
15239
15336
|
/**
|
|
15240
15337
|
* Service resource ID to be added to the endpoint service.
|
|
15241
15338
|
*/
|
|
@@ -15274,14 +15371,14 @@ export declare namespace privatelink {
|
|
|
15274
15371
|
value: string;
|
|
15275
15372
|
}
|
|
15276
15373
|
interface GetEndpointServiceResource {
|
|
15277
|
-
/**
|
|
15278
|
-
* Endpoint service ID.
|
|
15279
|
-
*/
|
|
15280
|
-
instanceId: string;
|
|
15281
15374
|
/**
|
|
15282
15375
|
* Service resource ID to be added to the endpoint service.
|
|
15283
15376
|
*/
|
|
15284
15377
|
resourceId: string;
|
|
15378
|
+
/**
|
|
15379
|
+
* Type of service resource.
|
|
15380
|
+
*/
|
|
15381
|
+
resourceType: string;
|
|
15285
15382
|
/**
|
|
15286
15383
|
* Availability zone where the load balancer provides service.
|
|
15287
15384
|
*/
|
|
@@ -15297,6 +15394,54 @@ export declare namespace privatelink {
|
|
|
15297
15394
|
*/
|
|
15298
15395
|
value: string;
|
|
15299
15396
|
}
|
|
15397
|
+
interface GetVpcEndpointConnectionResourcesAllocate {
|
|
15398
|
+
/**
|
|
15399
|
+
* Specify the service resource for the endpoint connection
|
|
15400
|
+
*/
|
|
15401
|
+
resourceId: string;
|
|
15402
|
+
/**
|
|
15403
|
+
* Availability zone ID of the service resource to be specified
|
|
15404
|
+
*/
|
|
15405
|
+
zoneId: string;
|
|
15406
|
+
}
|
|
15407
|
+
interface GetVpcEndpointConnectionZone {
|
|
15408
|
+
/**
|
|
15409
|
+
* Endpoint network interface ID. If a seamless service resource replacement is in progress, this indicates the endpoint network interface ID connected to the replaced service resource
|
|
15410
|
+
*/
|
|
15411
|
+
networkInterfaceId: string;
|
|
15412
|
+
/**
|
|
15413
|
+
* The private IPv4 address of the terminal node NIC. If a smooth service resource replacement is in progress, this refers to the IPv4 address of the terminal node NIC connected to the service resource being replaced.
|
|
15414
|
+
*/
|
|
15415
|
+
networkInterfaceIp: string;
|
|
15416
|
+
/**
|
|
15417
|
+
* Private IPv6 address of the endpoint network interface. If a seamless service resource replacement is in progress, this indicates the IPv6 address of the endpoint network interface connected to the replaced service resource. If the endpoint only supports IPv4, this parameter is not returned
|
|
15418
|
+
*/
|
|
15419
|
+
networkInterfaceIpv6: string;
|
|
15420
|
+
/**
|
|
15421
|
+
* Service resource ID
|
|
15422
|
+
*/
|
|
15423
|
+
resourceId: string;
|
|
15424
|
+
/**
|
|
15425
|
+
* Status of the service resource
|
|
15426
|
+
*/
|
|
15427
|
+
serviceStatus: string;
|
|
15428
|
+
/**
|
|
15429
|
+
* ID of the subnet to which the endpoint network interface belongs
|
|
15430
|
+
*/
|
|
15431
|
+
subnetId: string;
|
|
15432
|
+
/**
|
|
15433
|
+
* The domain name of the terminal node availability zone.
|
|
15434
|
+
*/
|
|
15435
|
+
zoneDomain: string;
|
|
15436
|
+
/**
|
|
15437
|
+
* Endpoint zone ID
|
|
15438
|
+
*/
|
|
15439
|
+
zoneId: string;
|
|
15440
|
+
/**
|
|
15441
|
+
* Status of the endpoint zone. PendingAcceptance: waiting for connection. Connecting: connecting. Connected: connected. Disconnecting: disconnecting. Rejected: connection rejected. Failed: connection failed
|
|
15442
|
+
*/
|
|
15443
|
+
zoneStatus: string;
|
|
15444
|
+
}
|
|
15300
15445
|
interface GetVpcEndpointTag {
|
|
15301
15446
|
/**
|
|
15302
15447
|
* Tag key of the endpoint user tag. Length limit: 1–128 characters. Case sensitive. Cannot start with 'or' or 'sys:' in any case combination. Cannot start or end with a space. Allowed characters: letters, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equal signs (=), plus signs (+), hyphens (-), and @.
|
|
@@ -15345,6 +15490,54 @@ export declare namespace privatelink {
|
|
|
15345
15490
|
*/
|
|
15346
15491
|
zoneStatus: string;
|
|
15347
15492
|
}
|
|
15493
|
+
interface VpcEndpointConnectionResourcesAllocate {
|
|
15494
|
+
/**
|
|
15495
|
+
* Specify the service resource for the endpoint connection
|
|
15496
|
+
*/
|
|
15497
|
+
resourceId: string;
|
|
15498
|
+
/**
|
|
15499
|
+
* Availability zone ID of the service resource to be specified
|
|
15500
|
+
*/
|
|
15501
|
+
zoneId: string;
|
|
15502
|
+
}
|
|
15503
|
+
interface VpcEndpointConnectionZone {
|
|
15504
|
+
/**
|
|
15505
|
+
* Endpoint network interface ID. If a seamless service resource replacement is in progress, this indicates the endpoint network interface ID connected to the replaced service resource
|
|
15506
|
+
*/
|
|
15507
|
+
networkInterfaceId: string;
|
|
15508
|
+
/**
|
|
15509
|
+
* The private IPv4 address of the terminal node NIC. If a smooth service resource replacement is in progress, this refers to the IPv4 address of the terminal node NIC connected to the service resource being replaced.
|
|
15510
|
+
*/
|
|
15511
|
+
networkInterfaceIp: string;
|
|
15512
|
+
/**
|
|
15513
|
+
* Private IPv6 address of the endpoint network interface. If a seamless service resource replacement is in progress, this indicates the IPv6 address of the endpoint network interface connected to the replaced service resource. If the endpoint only supports IPv4, this parameter is not returned
|
|
15514
|
+
*/
|
|
15515
|
+
networkInterfaceIpv6: string;
|
|
15516
|
+
/**
|
|
15517
|
+
* Service resource ID
|
|
15518
|
+
*/
|
|
15519
|
+
resourceId: string;
|
|
15520
|
+
/**
|
|
15521
|
+
* Status of the service resource
|
|
15522
|
+
*/
|
|
15523
|
+
serviceStatus: string;
|
|
15524
|
+
/**
|
|
15525
|
+
* ID of the subnet to which the endpoint network interface belongs
|
|
15526
|
+
*/
|
|
15527
|
+
subnetId: string;
|
|
15528
|
+
/**
|
|
15529
|
+
* The domain name of the terminal node availability zone.
|
|
15530
|
+
*/
|
|
15531
|
+
zoneDomain: string;
|
|
15532
|
+
/**
|
|
15533
|
+
* Endpoint zone ID
|
|
15534
|
+
*/
|
|
15535
|
+
zoneId: string;
|
|
15536
|
+
/**
|
|
15537
|
+
* Status of the endpoint zone. PendingAcceptance: waiting for connection. Connecting: connecting. Connected: connected. Disconnecting: disconnecting. Rejected: connection rejected. Failed: connection failed
|
|
15538
|
+
*/
|
|
15539
|
+
zoneStatus: string;
|
|
15540
|
+
}
|
|
15348
15541
|
interface VpcEndpointTag {
|
|
15349
15542
|
/**
|
|
15350
15543
|
* Tag key of the endpoint user tag. Length limit: 1–128 characters. Case sensitive. Cannot start with 'or' or 'sys:' in any case combination. Cannot start or end with a space. Allowed characters: letters, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equal signs (=), plus signs (+), hyphens (-), and @.
|
|
@@ -15501,6 +15694,26 @@ export declare namespace privatezone {
|
|
|
15501
15694
|
}
|
|
15502
15695
|
}
|
|
15503
15696
|
export declare namespace rabbitmq {
|
|
15697
|
+
interface AllowListAssociatedInstance {
|
|
15698
|
+
/**
|
|
15699
|
+
* Instance ID
|
|
15700
|
+
*/
|
|
15701
|
+
instanceId: string;
|
|
15702
|
+
}
|
|
15703
|
+
interface GetAllowListAssociatedInstance {
|
|
15704
|
+
/**
|
|
15705
|
+
* Instance ID
|
|
15706
|
+
*/
|
|
15707
|
+
instanceId: string;
|
|
15708
|
+
/**
|
|
15709
|
+
* Instance Name
|
|
15710
|
+
*/
|
|
15711
|
+
instanceName: string;
|
|
15712
|
+
/**
|
|
15713
|
+
* VPC ID of the instance
|
|
15714
|
+
*/
|
|
15715
|
+
vpc: string;
|
|
15716
|
+
}
|
|
15504
15717
|
interface GetInstanceChargeDetail {
|
|
15505
15718
|
/**
|
|
15506
15719
|
* Whether to automatically renew the subscription instance after expiration.
|
|
@@ -17723,6 +17936,70 @@ export declare namespace rdspostgresql {
|
|
|
17723
17936
|
}
|
|
17724
17937
|
}
|
|
17725
17938
|
export declare namespace redis {
|
|
17939
|
+
interface AllowListAssociatedInstance {
|
|
17940
|
+
/**
|
|
17941
|
+
* Instance ID bound to the current allowlist
|
|
17942
|
+
*/
|
|
17943
|
+
instanceId: string;
|
|
17944
|
+
/**
|
|
17945
|
+
* Instance names bound to the current allowlist
|
|
17946
|
+
*/
|
|
17947
|
+
instanceName: string;
|
|
17948
|
+
/**
|
|
17949
|
+
* Project name associated with the instance
|
|
17950
|
+
*/
|
|
17951
|
+
projectName: string;
|
|
17952
|
+
/**
|
|
17953
|
+
* Private network ID associated with the instance
|
|
17954
|
+
*/
|
|
17955
|
+
vpc: string;
|
|
17956
|
+
}
|
|
17957
|
+
interface AllowListSecurityGroupBindInfo {
|
|
17958
|
+
/**
|
|
17959
|
+
* Security group association mode. The value range is as follows: IngressDirectionIp: ingress IP, which allows IPs involved in TCP and ALL protocols in the source address of the security group ingress direction to access the database. If the source address is configured as a security group, it will be ignored. AssociateEcsIp: associate ECS IP, which allows cloud servers within the security group to access the database. Currently, only importing IP information of the primary network interface is supported
|
|
17960
|
+
*/
|
|
17961
|
+
bindMode: string;
|
|
17962
|
+
/**
|
|
17963
|
+
* Associated security group ID
|
|
17964
|
+
*/
|
|
17965
|
+
securityGroupId: string;
|
|
17966
|
+
}
|
|
17967
|
+
interface GetAllowListAssociatedInstance {
|
|
17968
|
+
/**
|
|
17969
|
+
* Instance ID bound to the current allowlist
|
|
17970
|
+
*/
|
|
17971
|
+
instanceId: string;
|
|
17972
|
+
/**
|
|
17973
|
+
* Instance names bound to the current allowlist
|
|
17974
|
+
*/
|
|
17975
|
+
instanceName: string;
|
|
17976
|
+
/**
|
|
17977
|
+
* Project name associated with the instance
|
|
17978
|
+
*/
|
|
17979
|
+
projectName: string;
|
|
17980
|
+
/**
|
|
17981
|
+
* Private network ID associated with the instance
|
|
17982
|
+
*/
|
|
17983
|
+
vpc: string;
|
|
17984
|
+
}
|
|
17985
|
+
interface GetAllowListSecurityGroupBindInfo {
|
|
17986
|
+
/**
|
|
17987
|
+
* Security group association mode. The value range is as follows: IngressDirectionIp: ingress IP, which allows IPs involved in TCP and ALL protocols in the source address of the security group ingress direction to access the database. If the source address is configured as a security group, it will be ignored. AssociateEcsIp: associate ECS IP, which allows cloud servers within the security group to access the database. Currently, only importing IP information of the primary network interface is supported
|
|
17988
|
+
*/
|
|
17989
|
+
bindMode: string;
|
|
17990
|
+
/**
|
|
17991
|
+
* IP list of security groups associated with the allowlist
|
|
17992
|
+
*/
|
|
17993
|
+
ipLists: string[];
|
|
17994
|
+
/**
|
|
17995
|
+
* Associated security group ID
|
|
17996
|
+
*/
|
|
17997
|
+
securityGroupId: string;
|
|
17998
|
+
/**
|
|
17999
|
+
* Name of the associated security group
|
|
18000
|
+
*/
|
|
18001
|
+
securityGroupName: string;
|
|
18002
|
+
}
|
|
17726
18003
|
interface GetInstanceCapacity {
|
|
17727
18004
|
/**
|
|
17728
18005
|
* Total memory capacity of the current instance. Unit: MiB.
|
|
@@ -17890,127 +18167,1679 @@ export declare namespace redis {
|
|
|
17890
18167
|
}
|
|
17891
18168
|
}
|
|
17892
18169
|
export declare namespace storageebs {
|
|
17893
|
-
interface
|
|
18170
|
+
interface GetSnapshotGroupSnapshot {
|
|
17894
18171
|
/**
|
|
17895
|
-
*
|
|
18172
|
+
* Snapshot creation time
|
|
17896
18173
|
*/
|
|
17897
|
-
|
|
18174
|
+
creationTime: string;
|
|
17898
18175
|
/**
|
|
17899
|
-
*
|
|
18176
|
+
* Snapshot description
|
|
17900
18177
|
*/
|
|
17901
|
-
|
|
17902
|
-
}
|
|
17903
|
-
interface GetVolumeBaselinePerformance {
|
|
18178
|
+
description: string;
|
|
17904
18179
|
/**
|
|
17905
|
-
*
|
|
18180
|
+
* Image ID
|
|
17906
18181
|
*/
|
|
17907
|
-
|
|
18182
|
+
imageId: string;
|
|
17908
18183
|
/**
|
|
17909
|
-
*
|
|
18184
|
+
* Whether the snapshot has enabled ultra-fast availability. Values are as follows: - true: Ultra-fast availability enabled - false: Ultra-fast availability not enabled
|
|
17910
18185
|
*/
|
|
17911
|
-
|
|
17912
|
-
}
|
|
17913
|
-
interface GetVolumeExtraPerformance {
|
|
18186
|
+
instantAccess: boolean;
|
|
17914
18187
|
/**
|
|
17915
|
-
*
|
|
18188
|
+
* Dump progress
|
|
18189
|
+
*/
|
|
18190
|
+
progress: number;
|
|
18191
|
+
/**
|
|
18192
|
+
* Project of the snapshot
|
|
18193
|
+
*/
|
|
18194
|
+
projectName: string;
|
|
18195
|
+
/**
|
|
18196
|
+
* Retention days for automatic snapshots
|
|
18197
|
+
*/
|
|
18198
|
+
retentionDays: number;
|
|
18199
|
+
/**
|
|
18200
|
+
* Whether the snapshot is shared with others. Values are as follows: - true: Snapshot is shared with others - false: Snapshot is not shared with others
|
|
18201
|
+
*/
|
|
18202
|
+
shared: boolean;
|
|
18203
|
+
/**
|
|
18204
|
+
* Snapshot consistency group ID
|
|
18205
|
+
*/
|
|
18206
|
+
snapshotGroupId: string;
|
|
18207
|
+
/**
|
|
18208
|
+
* Snapshot ID
|
|
18209
|
+
*/
|
|
18210
|
+
snapshotId: string;
|
|
18211
|
+
/**
|
|
18212
|
+
* Snapshot name
|
|
18213
|
+
*/
|
|
18214
|
+
snapshotName: string;
|
|
18215
|
+
/**
|
|
18216
|
+
* Snapshot type. Values are as follows: - user: Manual snapshot - auto: Automatic snapshot
|
|
18217
|
+
*/
|
|
18218
|
+
snapshotType: string;
|
|
18219
|
+
/**
|
|
18220
|
+
* Snapshot status. Values are as follows: - available: Available - creating: Creating - rollbacking: Rolling back - deleted: Deleted - failed: Error
|
|
18221
|
+
*/
|
|
18222
|
+
status: string;
|
|
18223
|
+
/**
|
|
18224
|
+
* Tag information
|
|
18225
|
+
*/
|
|
18226
|
+
tags: outputs.storageebs.GetSnapshotGroupSnapshotTag[];
|
|
18227
|
+
/**
|
|
18228
|
+
* Cloud disk ID
|
|
18229
|
+
*/
|
|
18230
|
+
volumeId: string;
|
|
18231
|
+
/**
|
|
18232
|
+
* Cloud disk category. Values are as follows: - system: System disk - data: Data disk
|
|
18233
|
+
*/
|
|
18234
|
+
volumeKind: string;
|
|
18235
|
+
/**
|
|
18236
|
+
* Cloud disk name
|
|
18237
|
+
*/
|
|
18238
|
+
volumeName: string;
|
|
18239
|
+
/**
|
|
18240
|
+
* Cloud disk size (GiB)
|
|
18241
|
+
*/
|
|
18242
|
+
volumeSize: number;
|
|
18243
|
+
/**
|
|
18244
|
+
* Cloud disk status. Values are as follows: - available: Available - attaching: Attaching - attached: Attached - detaching: Detaching - creating: Creating - deleting: Deleting - error: Error - extending: Expanding
|
|
18245
|
+
*/
|
|
18246
|
+
volumeStatus: string;
|
|
18247
|
+
/**
|
|
18248
|
+
* Cloud disk type. Values are as follows: - ESSD*PL0: Ultra-fast SSD cloud disk, PL0 specification - ESSD*FlexPL: Ultra-fast SSD cloud disk, FlexPL specification - TSSD_TL0: Throughput SSD cloud disk
|
|
18249
|
+
*/
|
|
18250
|
+
volumeType: string;
|
|
18251
|
+
/**
|
|
18252
|
+
* Zone ID. If ultra-fast availability is enabled for the snapshot, you can create a cloud disk in this zone using the ultra-fast available snapshot
|
|
18253
|
+
*/
|
|
18254
|
+
zoneId: string;
|
|
18255
|
+
}
|
|
18256
|
+
interface GetSnapshotGroupSnapshotTag {
|
|
18257
|
+
/**
|
|
18258
|
+
* Tag key
|
|
18259
|
+
*/
|
|
18260
|
+
key: string;
|
|
18261
|
+
/**
|
|
18262
|
+
* Tag value
|
|
18263
|
+
*/
|
|
18264
|
+
value: string;
|
|
18265
|
+
}
|
|
18266
|
+
interface GetSnapshotGroupTag {
|
|
18267
|
+
/**
|
|
18268
|
+
* Tag key
|
|
18269
|
+
*/
|
|
18270
|
+
key: string;
|
|
18271
|
+
/**
|
|
18272
|
+
* Tag value
|
|
18273
|
+
*/
|
|
18274
|
+
value: string;
|
|
18275
|
+
}
|
|
18276
|
+
interface GetSnapshotTag {
|
|
18277
|
+
/**
|
|
18278
|
+
* User tag key added to the resource. Naming rules: Cannot start with volc: or sys: in any case. Keys starting with volc: or sys: are reserved system tag keys and cannot be created. Only language characters, numbers, spaces, and the following English symbols are allowed: '_', '.', ':', '/', '=', '+', '-', '@'. Length must be between 1 and 128 characters.
|
|
18279
|
+
*/
|
|
18280
|
+
key: string;
|
|
18281
|
+
/**
|
|
18282
|
+
* User tag value added to the resource. Naming rules: Only language characters, numbers, spaces, and the following English symbols are allowed: '_', '.', ':', '/', '=', '+', '-', '@'. Can be empty. Length must be between 0 and 256 characters.
|
|
18283
|
+
*/
|
|
18284
|
+
value: string;
|
|
18285
|
+
}
|
|
18286
|
+
interface GetVolumeBaselinePerformance {
|
|
18287
|
+
/**
|
|
18288
|
+
* Total IOPS of the disk, which is the sum of the baseline IOPS and extra IOPS.
|
|
18289
|
+
*/
|
|
18290
|
+
iops: number;
|
|
18291
|
+
/**
|
|
18292
|
+
* The total throughput of the cloud disk is the sum of its baseline throughput and additional throughput.
|
|
18293
|
+
*/
|
|
18294
|
+
throughput: number;
|
|
18295
|
+
}
|
|
18296
|
+
interface GetVolumeExtraPerformance {
|
|
18297
|
+
/**
|
|
18298
|
+
* Type of extra performance. Value description: Balance: Balanced extra performance; IOPS: IOPS extra performance; Throughput: Throughput extra performance.
|
|
18299
|
+
*/
|
|
18300
|
+
extraPerformanceTypeId: string;
|
|
18301
|
+
/**
|
|
18302
|
+
* Extra IOPS of the disk.
|
|
18303
|
+
*/
|
|
18304
|
+
iops: number;
|
|
18305
|
+
/**
|
|
18306
|
+
* Extra throughput of the disk.
|
|
18307
|
+
*/
|
|
18308
|
+
throughput: number;
|
|
18309
|
+
}
|
|
18310
|
+
interface GetVolumeTag {
|
|
18311
|
+
/**
|
|
18312
|
+
* Tag key.
|
|
18313
|
+
*/
|
|
18314
|
+
key: string;
|
|
18315
|
+
/**
|
|
18316
|
+
* Tag value.
|
|
18317
|
+
*/
|
|
18318
|
+
value: string;
|
|
18319
|
+
}
|
|
18320
|
+
interface GetVolumeTotalPerformance {
|
|
18321
|
+
/**
|
|
18322
|
+
* Total IOPS of the disk, which is the sum of the baseline IOPS and extra IOPS.
|
|
18323
|
+
*/
|
|
18324
|
+
iops: number;
|
|
18325
|
+
/**
|
|
18326
|
+
* The total throughput of the cloud disk is the sum of its baseline throughput and additional throughput.
|
|
18327
|
+
*/
|
|
18328
|
+
throughput: number;
|
|
18329
|
+
}
|
|
18330
|
+
interface SnapshotGroupSnapshot {
|
|
18331
|
+
/**
|
|
18332
|
+
* Snapshot creation time
|
|
18333
|
+
*/
|
|
18334
|
+
creationTime: string;
|
|
18335
|
+
/**
|
|
18336
|
+
* Snapshot description
|
|
18337
|
+
*/
|
|
18338
|
+
description: string;
|
|
18339
|
+
/**
|
|
18340
|
+
* Image ID
|
|
18341
|
+
*/
|
|
18342
|
+
imageId: string;
|
|
18343
|
+
/**
|
|
18344
|
+
* Whether the snapshot has enabled ultra-fast availability. Values are as follows: - true: Ultra-fast availability enabled - false: Ultra-fast availability not enabled
|
|
18345
|
+
*/
|
|
18346
|
+
instantAccess: boolean;
|
|
18347
|
+
/**
|
|
18348
|
+
* Dump progress
|
|
18349
|
+
*/
|
|
18350
|
+
progress: number;
|
|
18351
|
+
/**
|
|
18352
|
+
* Project of the snapshot
|
|
18353
|
+
*/
|
|
18354
|
+
projectName: string;
|
|
18355
|
+
/**
|
|
18356
|
+
* Retention days for automatic snapshots
|
|
18357
|
+
*/
|
|
18358
|
+
retentionDays: number;
|
|
18359
|
+
/**
|
|
18360
|
+
* Whether the snapshot is shared with others. Values are as follows: - true: Snapshot is shared with others - false: Snapshot is not shared with others
|
|
18361
|
+
*/
|
|
18362
|
+
shared: boolean;
|
|
18363
|
+
/**
|
|
18364
|
+
* Snapshot consistency group ID
|
|
18365
|
+
*/
|
|
18366
|
+
snapshotGroupId: string;
|
|
18367
|
+
/**
|
|
18368
|
+
* Snapshot ID
|
|
18369
|
+
*/
|
|
18370
|
+
snapshotId: string;
|
|
18371
|
+
/**
|
|
18372
|
+
* Snapshot name
|
|
18373
|
+
*/
|
|
18374
|
+
snapshotName: string;
|
|
18375
|
+
/**
|
|
18376
|
+
* Snapshot type. Values are as follows: - user: Manual snapshot - auto: Automatic snapshot
|
|
18377
|
+
*/
|
|
18378
|
+
snapshotType: string;
|
|
18379
|
+
/**
|
|
18380
|
+
* Snapshot status. Values are as follows: - available: Available - creating: Creating - rollbacking: Rolling back - deleted: Deleted - failed: Error
|
|
18381
|
+
*/
|
|
18382
|
+
status: string;
|
|
18383
|
+
tags: outputs.storageebs.SnapshotGroupSnapshotTag[];
|
|
18384
|
+
/**
|
|
18385
|
+
* Cloud disk ID
|
|
18386
|
+
*/
|
|
18387
|
+
volumeId: string;
|
|
18388
|
+
/**
|
|
18389
|
+
* Cloud disk category. Values are as follows: - system: System disk - data: Data disk
|
|
18390
|
+
*/
|
|
18391
|
+
volumeKind: string;
|
|
18392
|
+
/**
|
|
18393
|
+
* Cloud disk name
|
|
18394
|
+
*/
|
|
18395
|
+
volumeName: string;
|
|
18396
|
+
/**
|
|
18397
|
+
* Cloud disk size (GiB)
|
|
18398
|
+
*/
|
|
18399
|
+
volumeSize: number;
|
|
18400
|
+
/**
|
|
18401
|
+
* Cloud disk status. Values are as follows: - available: Available - attaching: Attaching - attached: Attached - detaching: Detaching - creating: Creating - deleting: Deleting - error: Error - extending: Expanding
|
|
18402
|
+
*/
|
|
18403
|
+
volumeStatus: string;
|
|
18404
|
+
/**
|
|
18405
|
+
* Cloud disk type. Values are as follows: - ESSD*PL0: Ultra-fast SSD cloud disk, PL0 specification - ESSD*FlexPL: Ultra-fast SSD cloud disk, FlexPL specification - TSSD_TL0: Throughput SSD cloud disk
|
|
18406
|
+
*/
|
|
18407
|
+
volumeType: string;
|
|
18408
|
+
/**
|
|
18409
|
+
* Zone ID. If ultra-fast availability is enabled for the snapshot, you can create a cloud disk in this zone using the ultra-fast available snapshot
|
|
18410
|
+
*/
|
|
18411
|
+
zoneId: string;
|
|
18412
|
+
}
|
|
18413
|
+
interface SnapshotGroupSnapshotTag {
|
|
18414
|
+
/**
|
|
18415
|
+
* Tag key
|
|
18416
|
+
*/
|
|
18417
|
+
key: string;
|
|
18418
|
+
/**
|
|
18419
|
+
* Tag value
|
|
18420
|
+
*/
|
|
18421
|
+
value: string;
|
|
18422
|
+
}
|
|
18423
|
+
interface SnapshotGroupTag {
|
|
18424
|
+
/**
|
|
18425
|
+
* Tag key
|
|
18426
|
+
*/
|
|
18427
|
+
key: string;
|
|
18428
|
+
/**
|
|
18429
|
+
* Tag value
|
|
18430
|
+
*/
|
|
18431
|
+
value: string;
|
|
18432
|
+
}
|
|
18433
|
+
interface SnapshotTag {
|
|
18434
|
+
/**
|
|
18435
|
+
* User tag key added to the resource. Naming rules: Cannot start with volc: or sys: in any case. Keys starting with volc: or sys: are reserved system tag keys and cannot be created. Only language characters, numbers, spaces, and the following English symbols are allowed: '_', '.', ':', '/', '=', '+', '-', '@'. Length must be between 1 and 128 characters.
|
|
18436
|
+
*/
|
|
18437
|
+
key: string;
|
|
18438
|
+
/**
|
|
18439
|
+
* User tag value added to the resource. Naming rules: Only language characters, numbers, spaces, and the following English symbols are allowed: '_', '.', ':', '/', '=', '+', '-', '@'. Can be empty. Length must be between 0 and 256 characters.
|
|
18440
|
+
*/
|
|
18441
|
+
value: string;
|
|
18442
|
+
}
|
|
18443
|
+
interface VolumeBaselinePerformance {
|
|
18444
|
+
/**
|
|
18445
|
+
* Total IOPS of the disk, which is the sum of the baseline IOPS and extra IOPS.
|
|
18446
|
+
*/
|
|
18447
|
+
iops: number;
|
|
18448
|
+
/**
|
|
18449
|
+
* The total throughput of the cloud disk is the sum of its baseline throughput and additional throughput.
|
|
18450
|
+
*/
|
|
18451
|
+
throughput: number;
|
|
18452
|
+
}
|
|
18453
|
+
interface VolumeExtraPerformance {
|
|
18454
|
+
/**
|
|
18455
|
+
* Type of extra performance. Value description: Balance: Balanced extra performance; IOPS: IOPS extra performance; Throughput: Throughput extra performance.
|
|
17916
18456
|
*/
|
|
17917
18457
|
extraPerformanceTypeId: string;
|
|
17918
18458
|
/**
|
|
17919
|
-
* Extra IOPS of the disk.
|
|
18459
|
+
* Extra IOPS of the disk.
|
|
18460
|
+
*/
|
|
18461
|
+
iops: number;
|
|
18462
|
+
/**
|
|
18463
|
+
* Extra throughput of the disk.
|
|
18464
|
+
*/
|
|
18465
|
+
throughput: number;
|
|
18466
|
+
}
|
|
18467
|
+
interface VolumeTag {
|
|
18468
|
+
/**
|
|
18469
|
+
* Tag key.
|
|
18470
|
+
*/
|
|
18471
|
+
key: string;
|
|
18472
|
+
/**
|
|
18473
|
+
* Tag value.
|
|
18474
|
+
*/
|
|
18475
|
+
value: string;
|
|
18476
|
+
}
|
|
18477
|
+
interface VolumeTotalPerformance {
|
|
18478
|
+
/**
|
|
18479
|
+
* Total IOPS of the disk, which is the sum of the baseline IOPS and extra IOPS.
|
|
18480
|
+
*/
|
|
18481
|
+
iops: number;
|
|
18482
|
+
/**
|
|
18483
|
+
* The total throughput of the cloud disk is the sum of its baseline throughput and additional throughput.
|
|
18484
|
+
*/
|
|
18485
|
+
throughput: number;
|
|
18486
|
+
}
|
|
18487
|
+
}
|
|
18488
|
+
export declare namespace tls {
|
|
18489
|
+
interface AlarmNotifyGroupNoticeRule {
|
|
18490
|
+
/**
|
|
18491
|
+
* Whether there is an end node afterwards.
|
|
18492
|
+
*/
|
|
18493
|
+
hasEndNode: boolean;
|
|
18494
|
+
/**
|
|
18495
|
+
* Condition for whether to proceed to the next level.
|
|
18496
|
+
*/
|
|
18497
|
+
hasNext: boolean;
|
|
18498
|
+
receiverInfos: outputs.tls.AlarmNotifyGroupNoticeRuleReceiverInfo[];
|
|
18499
|
+
/**
|
|
18500
|
+
* Rule node. JSON format.
|
|
18501
|
+
*/
|
|
18502
|
+
ruleNode: string;
|
|
18503
|
+
}
|
|
18504
|
+
interface AlarmNotifyGroupNoticeRuleReceiverInfo {
|
|
18505
|
+
/**
|
|
18506
|
+
* Alarm content template ID.
|
|
18507
|
+
*/
|
|
18508
|
+
alarmContentTemplateId: string;
|
|
18509
|
+
/**
|
|
18510
|
+
* User group name to notify when sending notifications to Feishu, DingTalk, or WeCom via Webhook integration.
|
|
18511
|
+
*/
|
|
18512
|
+
alarmWebhookAtGroups: string[];
|
|
18513
|
+
/**
|
|
18514
|
+
* Username to notify when sending notifications to Feishu, DingTalk, or WeCom via Webhook integration.
|
|
18515
|
+
*/
|
|
18516
|
+
alarmWebhookAtUsers: string[];
|
|
18517
|
+
/**
|
|
18518
|
+
* Alarm webhook integration configuration ID.
|
|
18519
|
+
*/
|
|
18520
|
+
alarmWebhookIntegrationId: string;
|
|
18521
|
+
/**
|
|
18522
|
+
* Name of the alarm Webhook integration configuration.
|
|
18523
|
+
*/
|
|
18524
|
+
alarmWebhookIntegrationName: string;
|
|
18525
|
+
/**
|
|
18526
|
+
* Whether to notify everyone when sending notifications to Feishu, DingTalk, or WeCom via Webhook integration.
|
|
18527
|
+
*/
|
|
18528
|
+
alarmWebhookIsAtAll: boolean;
|
|
18529
|
+
/**
|
|
18530
|
+
* End time for receiving alarm notifications. Uses 24-hour format: HH:mm:ss, with a valid range of 00:00:00–23:59:59. StartTime cannot be greater than EndTime.
|
|
18531
|
+
*/
|
|
18532
|
+
endTime: string;
|
|
18533
|
+
/**
|
|
18534
|
+
* Custom WebHook request body. It is recommended to set the request body according to the callback interface requirements of the corresponding service.
|
|
18535
|
+
*/
|
|
18536
|
+
generalWebhookBody: string;
|
|
18537
|
+
generalWebhookHeaders: outputs.tls.AlarmNotifyGroupNoticeRuleReceiverInfoGeneralWebhookHeader[];
|
|
18538
|
+
/**
|
|
18539
|
+
* Custom callback method for the interface. Only POST or PUT is supported.
|
|
18540
|
+
*/
|
|
18541
|
+
generalWebhookMethod: string;
|
|
18542
|
+
/**
|
|
18543
|
+
* Custom callback URL for the interface.
|
|
18544
|
+
*/
|
|
18545
|
+
generalWebhookUrl: string;
|
|
18546
|
+
/**
|
|
18547
|
+
* Notification channels. Supports one or more channels. Options: Email, Sms, Phone, GeneralWebhook, Lark, DingTalk, WeChat.
|
|
18548
|
+
*/
|
|
18549
|
+
receiverChannels: string[];
|
|
18550
|
+
/**
|
|
18551
|
+
* IAM user or user group name.
|
|
18552
|
+
*/
|
|
18553
|
+
receiverNames: string[];
|
|
18554
|
+
/**
|
|
18555
|
+
* Recipient type. Options: User: IAM user; UserGroup: IAM user group.
|
|
18556
|
+
*/
|
|
18557
|
+
receiverType: string;
|
|
18558
|
+
/**
|
|
18559
|
+
* Alarm notification start time. Uses 24-hour format (HH:mm:ss), valid range is 00:00:00–23:59:59. StartTime cannot be later than EndTime.
|
|
18560
|
+
*/
|
|
18561
|
+
startTime: string;
|
|
18562
|
+
}
|
|
18563
|
+
interface AlarmNotifyGroupNoticeRuleReceiverInfoGeneralWebhookHeader {
|
|
18564
|
+
/**
|
|
18565
|
+
* Custom request header key.
|
|
18566
|
+
*/
|
|
18567
|
+
key: string;
|
|
18568
|
+
/**
|
|
18569
|
+
* Custom request header value.
|
|
18570
|
+
*/
|
|
18571
|
+
value: string;
|
|
18572
|
+
}
|
|
18573
|
+
interface AlarmNotifyGroupReceiver {
|
|
18574
|
+
/**
|
|
18575
|
+
* Alarm content template ID.
|
|
18576
|
+
*/
|
|
18577
|
+
alarmContentTemplateId: string;
|
|
18578
|
+
/**
|
|
18579
|
+
* User group name to notify when sending notifications to Feishu, DingTalk, or WeCom via Webhook integration.
|
|
18580
|
+
*/
|
|
18581
|
+
alarmWebhookAtGroups: string[];
|
|
18582
|
+
/**
|
|
18583
|
+
* Username to notify when sending notifications to Feishu, DingTalk, or WeCom via Webhook integration.
|
|
18584
|
+
*/
|
|
18585
|
+
alarmWebhookAtUsers: string[];
|
|
18586
|
+
/**
|
|
18587
|
+
* Alarm webhook integration configuration ID.
|
|
18588
|
+
*/
|
|
18589
|
+
alarmWebhookIntegrationId: string;
|
|
18590
|
+
/**
|
|
18591
|
+
* Name of the alarm Webhook integration configuration.
|
|
18592
|
+
*/
|
|
18593
|
+
alarmWebhookIntegrationName: string;
|
|
18594
|
+
/**
|
|
18595
|
+
* Whether to notify everyone when sending notifications to Feishu, DingTalk, or WeCom via Webhook integration.
|
|
18596
|
+
*/
|
|
18597
|
+
alarmWebhookIsAtAll: boolean;
|
|
18598
|
+
/**
|
|
18599
|
+
* End time for receiving alarm notifications. Uses 24-hour format: HH:mm:ss, with a valid range of 00:00:00–23:59:59. StartTime cannot be greater than EndTime.
|
|
18600
|
+
*/
|
|
18601
|
+
endTime: string;
|
|
18602
|
+
/**
|
|
18603
|
+
* Custom WebHook request body. It is recommended to set the request body according to the callback interface requirements of the corresponding service.
|
|
18604
|
+
*/
|
|
18605
|
+
generalWebhookBody: string;
|
|
18606
|
+
generalWebhookHeaders: outputs.tls.AlarmNotifyGroupReceiverGeneralWebhookHeader[];
|
|
18607
|
+
/**
|
|
18608
|
+
* Custom callback method for the interface. Only POST or PUT is supported.
|
|
18609
|
+
*/
|
|
18610
|
+
generalWebhookMethod: string;
|
|
18611
|
+
/**
|
|
18612
|
+
* Custom callback URL for the interface.
|
|
18613
|
+
*/
|
|
18614
|
+
generalWebhookUrl: string;
|
|
18615
|
+
/**
|
|
18616
|
+
* Notification channels. Supports one or more channels. Options: Email, Sms, Phone, GeneralWebhook, Lark, DingTalk, WeChat.
|
|
18617
|
+
*/
|
|
18618
|
+
receiverChannels: string[];
|
|
18619
|
+
/**
|
|
18620
|
+
* IAM user or user group name.
|
|
18621
|
+
*/
|
|
18622
|
+
receiverNames: string[];
|
|
18623
|
+
/**
|
|
18624
|
+
* Recipient type. Options: User: IAM user; UserGroup: IAM user group.
|
|
18625
|
+
*/
|
|
18626
|
+
receiverType: string;
|
|
18627
|
+
/**
|
|
18628
|
+
* Alarm notification start time. Uses 24-hour format (HH:mm:ss), valid range is 00:00:00–23:59:59. StartTime cannot be later than EndTime.
|
|
18629
|
+
*/
|
|
18630
|
+
startTime: string;
|
|
18631
|
+
}
|
|
18632
|
+
interface AlarmNotifyGroupReceiverGeneralWebhookHeader {
|
|
18633
|
+
/**
|
|
18634
|
+
* Custom request header key.
|
|
18635
|
+
*/
|
|
18636
|
+
key: string;
|
|
18637
|
+
/**
|
|
18638
|
+
* Custom request header value.
|
|
18639
|
+
*/
|
|
18640
|
+
value: string;
|
|
18641
|
+
}
|
|
18642
|
+
interface GetAlarmNotifyGroupNoticeRule {
|
|
18643
|
+
/**
|
|
18644
|
+
* Whether there is an end node afterwards.
|
|
18645
|
+
*/
|
|
18646
|
+
hasEndNode: boolean;
|
|
18647
|
+
/**
|
|
18648
|
+
* Condition for whether to proceed to the next level.
|
|
18649
|
+
*/
|
|
18650
|
+
hasNext: boolean;
|
|
18651
|
+
/**
|
|
18652
|
+
* Notification channel information.
|
|
18653
|
+
*/
|
|
18654
|
+
receiverInfos: outputs.tls.GetAlarmNotifyGroupNoticeRuleReceiverInfo[];
|
|
18655
|
+
/**
|
|
18656
|
+
* Rule node. JSON format.
|
|
18657
|
+
*/
|
|
18658
|
+
ruleNode: string;
|
|
18659
|
+
}
|
|
18660
|
+
interface GetAlarmNotifyGroupNoticeRuleReceiverInfo {
|
|
18661
|
+
/**
|
|
18662
|
+
* Alarm content template ID.
|
|
18663
|
+
*/
|
|
18664
|
+
alarmContentTemplateId: string;
|
|
18665
|
+
/**
|
|
18666
|
+
* User group name to notify when sending notifications to Feishu, DingTalk, or WeCom via Webhook integration.
|
|
18667
|
+
*/
|
|
18668
|
+
alarmWebhookAtGroups: string[];
|
|
18669
|
+
/**
|
|
18670
|
+
* Username to notify when sending notifications to Feishu, DingTalk, or WeCom via Webhook integration.
|
|
18671
|
+
*/
|
|
18672
|
+
alarmWebhookAtUsers: string[];
|
|
18673
|
+
/**
|
|
18674
|
+
* Alarm webhook integration configuration ID.
|
|
18675
|
+
*/
|
|
18676
|
+
alarmWebhookIntegrationId: string;
|
|
18677
|
+
/**
|
|
18678
|
+
* Name of the alarm Webhook integration configuration.
|
|
18679
|
+
*/
|
|
18680
|
+
alarmWebhookIntegrationName: string;
|
|
18681
|
+
/**
|
|
18682
|
+
* Whether to notify everyone when sending notifications to Feishu, DingTalk, or WeCom via Webhook integration.
|
|
18683
|
+
*/
|
|
18684
|
+
alarmWebhookIsAtAll: boolean;
|
|
18685
|
+
/**
|
|
18686
|
+
* End time for receiving alarm notifications. Uses 24-hour format: HH:mm:ss, with a valid range of 00:00:00–23:59:59. StartTime cannot be greater than EndTime.
|
|
18687
|
+
*/
|
|
18688
|
+
endTime: string;
|
|
18689
|
+
/**
|
|
18690
|
+
* Custom WebHook request body. It is recommended to set the request body according to the callback interface requirements of the corresponding service.
|
|
18691
|
+
*/
|
|
18692
|
+
generalWebhookBody: string;
|
|
18693
|
+
/**
|
|
18694
|
+
* Custom callback request headers for the interface.
|
|
18695
|
+
*/
|
|
18696
|
+
generalWebhookHeaders: outputs.tls.GetAlarmNotifyGroupNoticeRuleReceiverInfoGeneralWebhookHeader[];
|
|
18697
|
+
/**
|
|
18698
|
+
* Custom callback method for the interface. Only POST or PUT is supported.
|
|
18699
|
+
*/
|
|
18700
|
+
generalWebhookMethod: string;
|
|
18701
|
+
/**
|
|
18702
|
+
* Custom callback URL for the interface.
|
|
18703
|
+
*/
|
|
18704
|
+
generalWebhookUrl: string;
|
|
18705
|
+
/**
|
|
18706
|
+
* Notification channels. Supports one or more channels. Options: Email, Sms, Phone, GeneralWebhook, Lark, DingTalk, WeChat.
|
|
18707
|
+
*/
|
|
18708
|
+
receiverChannels: string[];
|
|
18709
|
+
/**
|
|
18710
|
+
* IAM user or user group name.
|
|
18711
|
+
*/
|
|
18712
|
+
receiverNames: string[];
|
|
18713
|
+
/**
|
|
18714
|
+
* Recipient type. Options: User: IAM user; UserGroup: IAM user group.
|
|
18715
|
+
*/
|
|
18716
|
+
receiverType: string;
|
|
18717
|
+
/**
|
|
18718
|
+
* Alarm notification start time. Uses 24-hour format (HH:mm:ss), valid range is 00:00:00–23:59:59. StartTime cannot be later than EndTime.
|
|
18719
|
+
*/
|
|
18720
|
+
startTime: string;
|
|
18721
|
+
}
|
|
18722
|
+
interface GetAlarmNotifyGroupNoticeRuleReceiverInfoGeneralWebhookHeader {
|
|
18723
|
+
/**
|
|
18724
|
+
* Custom request header key.
|
|
18725
|
+
*/
|
|
18726
|
+
key: string;
|
|
18727
|
+
/**
|
|
18728
|
+
* Custom request header value.
|
|
18729
|
+
*/
|
|
18730
|
+
value: string;
|
|
18731
|
+
}
|
|
18732
|
+
interface GetAlarmNotifyGroupReceiver {
|
|
18733
|
+
/**
|
|
18734
|
+
* Alarm content template ID.
|
|
18735
|
+
*/
|
|
18736
|
+
alarmContentTemplateId: string;
|
|
18737
|
+
/**
|
|
18738
|
+
* User group name to notify when sending notifications to Feishu, DingTalk, or WeCom via Webhook integration.
|
|
18739
|
+
*/
|
|
18740
|
+
alarmWebhookAtGroups: string[];
|
|
18741
|
+
/**
|
|
18742
|
+
* Username to notify when sending notifications to Feishu, DingTalk, or WeCom via Webhook integration.
|
|
18743
|
+
*/
|
|
18744
|
+
alarmWebhookAtUsers: string[];
|
|
18745
|
+
/**
|
|
18746
|
+
* Alarm webhook integration configuration ID.
|
|
18747
|
+
*/
|
|
18748
|
+
alarmWebhookIntegrationId: string;
|
|
18749
|
+
/**
|
|
18750
|
+
* Name of the alarm Webhook integration configuration.
|
|
18751
|
+
*/
|
|
18752
|
+
alarmWebhookIntegrationName: string;
|
|
18753
|
+
/**
|
|
18754
|
+
* Whether to notify everyone when sending notifications to Feishu, DingTalk, or WeCom via Webhook integration.
|
|
18755
|
+
*/
|
|
18756
|
+
alarmWebhookIsAtAll: boolean;
|
|
18757
|
+
/**
|
|
18758
|
+
* End time for receiving alarm notifications. Uses 24-hour format: HH:mm:ss, with a valid range of 00:00:00–23:59:59. StartTime cannot be greater than EndTime.
|
|
18759
|
+
*/
|
|
18760
|
+
endTime: string;
|
|
18761
|
+
/**
|
|
18762
|
+
* Custom WebHook request body. It is recommended to set the request body according to the callback interface requirements of the corresponding service.
|
|
18763
|
+
*/
|
|
18764
|
+
generalWebhookBody: string;
|
|
18765
|
+
/**
|
|
18766
|
+
* Custom callback request headers for the interface.
|
|
18767
|
+
*/
|
|
18768
|
+
generalWebhookHeaders: outputs.tls.GetAlarmNotifyGroupReceiverGeneralWebhookHeader[];
|
|
18769
|
+
/**
|
|
18770
|
+
* Custom callback method for the interface. Only POST or PUT is supported.
|
|
18771
|
+
*/
|
|
18772
|
+
generalWebhookMethod: string;
|
|
18773
|
+
/**
|
|
18774
|
+
* Custom callback URL for the interface.
|
|
18775
|
+
*/
|
|
18776
|
+
generalWebhookUrl: string;
|
|
18777
|
+
/**
|
|
18778
|
+
* Notification channels. Supports one or more channels. Options: Email, Sms, Phone, GeneralWebhook, Lark, DingTalk, WeChat.
|
|
18779
|
+
*/
|
|
18780
|
+
receiverChannels: string[];
|
|
18781
|
+
/**
|
|
18782
|
+
* IAM user or user group name.
|
|
18783
|
+
*/
|
|
18784
|
+
receiverNames: string[];
|
|
18785
|
+
/**
|
|
18786
|
+
* Recipient type. Options: User: IAM user; UserGroup: IAM user group.
|
|
18787
|
+
*/
|
|
18788
|
+
receiverType: string;
|
|
18789
|
+
/**
|
|
18790
|
+
* Alarm notification start time. Uses 24-hour format (HH:mm:ss), valid range is 00:00:00–23:59:59. StartTime cannot be later than EndTime.
|
|
18791
|
+
*/
|
|
18792
|
+
startTime: string;
|
|
18793
|
+
}
|
|
18794
|
+
interface GetAlarmNotifyGroupReceiverGeneralWebhookHeader {
|
|
18795
|
+
/**
|
|
18796
|
+
* Custom request header key.
|
|
18797
|
+
*/
|
|
18798
|
+
key: string;
|
|
18799
|
+
/**
|
|
18800
|
+
* Custom request header value.
|
|
18801
|
+
*/
|
|
18802
|
+
value: string;
|
|
18803
|
+
}
|
|
18804
|
+
interface GetImportTaskImportSourceInfo {
|
|
18805
|
+
/**
|
|
18806
|
+
* Kafka data source information. When sourceType is kafka, the KafkaSourceInfo field is required
|
|
18807
|
+
*/
|
|
18808
|
+
kafkaSourceInfo: outputs.tls.GetImportTaskImportSourceInfoKafkaSourceInfo;
|
|
18809
|
+
/**
|
|
18810
|
+
* TOS data source information. When sourceType is tos, the TosSourceInfo field is required.
|
|
18811
|
+
*/
|
|
18812
|
+
tosSourceInfo: outputs.tls.GetImportTaskImportSourceInfoTosSourceInfo;
|
|
18813
|
+
}
|
|
18814
|
+
interface GetImportTaskImportSourceInfoKafkaSourceInfo {
|
|
18815
|
+
/**
|
|
18816
|
+
* Data encoding format. Available options: UTF-8, GBK.
|
|
18817
|
+
*/
|
|
18818
|
+
encode: string;
|
|
18819
|
+
/**
|
|
18820
|
+
* Kafka consumer group. If not specified, the system will automatically create a Kafka consumer group.
|
|
18821
|
+
*/
|
|
18822
|
+
group: string;
|
|
18823
|
+
/**
|
|
18824
|
+
* The service addresses for different types of Kafka clusters vary. Details are as follows: Message Queue Kafka Edition: Use the access point of the Kafka instance. For more information, see Access Point. If the Kafka instance and the Log Service Project are in the same region, you can use private network access; otherwise, use public network access. Self-hosted Kafka clusters: Use the IP address and port number or the domain name and port number of the Kafka Broker. Only public network access is supported. Separate multiple service addresses with a comma (,).
|
|
18825
|
+
*/
|
|
18826
|
+
host: string;
|
|
18827
|
+
/**
|
|
18828
|
+
* Starting position for data import. Options: 0: Earliest time, start importing from the first record in the specified Kafka Topic. 1: Latest time, start importing from the most recently generated record in the specified Kafka Topic.
|
|
18829
|
+
*/
|
|
18830
|
+
initialOffset: number;
|
|
18831
|
+
/**
|
|
18832
|
+
* If you are using Message Queue Kafka Edition, set this to the Kafka instance ID.
|
|
18833
|
+
*/
|
|
18834
|
+
instanceId: string;
|
|
18835
|
+
/**
|
|
18836
|
+
* Whether to enable authentication. If you use a public service address, it is recommended to enable authentication.
|
|
18837
|
+
*/
|
|
18838
|
+
isNeedAuth: boolean;
|
|
18839
|
+
/**
|
|
18840
|
+
* Password authentication mechanism. Available options: PLAIN, SCRAM-SHA-256, and SCRAM-SHA-512.
|
|
18841
|
+
*/
|
|
18842
|
+
mechanism: string;
|
|
18843
|
+
/**
|
|
18844
|
+
* Kafka SASL user password for authentication.
|
|
18845
|
+
*/
|
|
18846
|
+
password: string;
|
|
18847
|
+
/**
|
|
18848
|
+
* Secure transmission protocol. Options include plaintext, sasl*ssl, ssl, and sasl*plaintext
|
|
18849
|
+
*/
|
|
18850
|
+
protocol: string;
|
|
18851
|
+
/**
|
|
18852
|
+
* Specify log time. Options: 0: Use Kafka message timestamp. 1: Use current system time.
|
|
18853
|
+
*/
|
|
18854
|
+
timeSourceDefault: number;
|
|
18855
|
+
/**
|
|
18856
|
+
* Kafka Topic name. Separate multiple Kafka Topics with commas (,).
|
|
18857
|
+
*/
|
|
18858
|
+
topic: string;
|
|
18859
|
+
/**
|
|
18860
|
+
* Kafka SASL username for authentication.
|
|
18861
|
+
*/
|
|
18862
|
+
username: string;
|
|
18863
|
+
}
|
|
18864
|
+
interface GetImportTaskImportSourceInfoTosSourceInfo {
|
|
18865
|
+
/**
|
|
18866
|
+
* TOS bucket name
|
|
18867
|
+
*/
|
|
18868
|
+
bucket: string;
|
|
18869
|
+
/**
|
|
18870
|
+
* Compression mode for data in the TOS bucket. none: No compression. snappy: Compress using snappy. gzip: Compress using gzip. lz4: Compress using lz4.
|
|
18871
|
+
*/
|
|
18872
|
+
compressType: string;
|
|
18873
|
+
/**
|
|
18874
|
+
* Path of the file to be imported in the TOS bucket.
|
|
18875
|
+
*/
|
|
18876
|
+
prefix: string;
|
|
18877
|
+
/**
|
|
18878
|
+
* Region where the TOS bucket is located. Cross-region data import is supported
|
|
18879
|
+
*/
|
|
18880
|
+
region: string;
|
|
18881
|
+
}
|
|
18882
|
+
interface GetImportTaskTargetInfo {
|
|
18883
|
+
/**
|
|
18884
|
+
* Log extraction rule.
|
|
18885
|
+
*/
|
|
18886
|
+
extractRule: outputs.tls.GetImportTaskTargetInfoExtractRule;
|
|
18887
|
+
/**
|
|
18888
|
+
* Log sample. When LogType is set to multiline_log, you must configure log samples. It is recommended to provide more than two log entries as examples to ensure the regular expression matches the first line of each log. Use real samples from the production environment.
|
|
18889
|
+
*/
|
|
18890
|
+
logSample: string;
|
|
18891
|
+
/**
|
|
18892
|
+
* Specify log parsing type during import. delimiter*log: CSV type. multiline*log: multiline full text type. minimalist*log: single line full text type. json*log: JSON type.
|
|
18893
|
+
*/
|
|
18894
|
+
logType: string;
|
|
18895
|
+
/**
|
|
18896
|
+
* Region.
|
|
18897
|
+
*/
|
|
18898
|
+
region: string;
|
|
18899
|
+
}
|
|
18900
|
+
interface GetImportTaskTargetInfoExtractRule {
|
|
18901
|
+
/**
|
|
18902
|
+
* Basic content of log extraction rules.
|
|
18903
|
+
*/
|
|
18904
|
+
extractRule: outputs.tls.GetImportTaskTargetInfoExtractRuleExtractRule;
|
|
18905
|
+
/**
|
|
18906
|
+
* Number of skipped rows. Only valid when the log type is delimiterLog and the import type is tos.
|
|
18907
|
+
*/
|
|
18908
|
+
skipLineCount: number;
|
|
18909
|
+
/**
|
|
18910
|
+
* Time extraction regular expression, used to extract the time value from the TimeKey field and parse it as the collection time
|
|
18911
|
+
*/
|
|
18912
|
+
timeExtractRegex: string;
|
|
18913
|
+
/**
|
|
18914
|
+
* Time zone. Supports machine time zone (default) and custom time zone. Custom time zone supports GMT and UTC. GMT format: GMT+08:00. UTC format: Asia/Shanghai.
|
|
18915
|
+
*/
|
|
18916
|
+
timeZone: string;
|
|
18917
|
+
}
|
|
18918
|
+
interface GetImportTaskTargetInfoExtractRuleExtractRule {
|
|
18919
|
+
/**
|
|
18920
|
+
* Regular expression for identifying the first line of each log. The matched part is treated as the start of the log. When LogType is set to multiline_log, you must configure a log sample
|
|
18921
|
+
*/
|
|
18922
|
+
beginRegex: string;
|
|
18923
|
+
/**
|
|
18924
|
+
* Delimiter. Only valid when LogType is delimiter_log.
|
|
18925
|
+
*/
|
|
18926
|
+
delimiter: string;
|
|
18927
|
+
/**
|
|
18928
|
+
* Enable nanoseconds.
|
|
18929
|
+
*/
|
|
18930
|
+
enableNanosecond: boolean;
|
|
18931
|
+
/**
|
|
18932
|
+
* Filter key regular expression.
|
|
18933
|
+
*/
|
|
18934
|
+
filterKeyRegexes: outputs.tls.GetImportTaskTargetInfoExtractRuleExtractRuleFilterKeyRegex[];
|
|
18935
|
+
/**
|
|
18936
|
+
* List of log field names (Key). Valid only when LogType is delimiter_log. Supports up to 100 field names. Duplicate field names are not allowed, and all field names cannot be left blank
|
|
18937
|
+
*/
|
|
18938
|
+
keys: string[];
|
|
18939
|
+
/**
|
|
18940
|
+
* Log regular expression
|
|
18941
|
+
*/
|
|
18942
|
+
logRegex: string;
|
|
18943
|
+
/**
|
|
18944
|
+
* Log template.
|
|
18945
|
+
*/
|
|
18946
|
+
logTemplate: outputs.tls.GetImportTaskTargetInfoExtractRuleExtractRuleLogTemplate;
|
|
18947
|
+
/**
|
|
18948
|
+
* Quotation mark. Content enclosed by the quotation mark will not be separated and will be parsed as a complete field. Only valid when LogType is delimiter_log.
|
|
18949
|
+
*/
|
|
18950
|
+
quote: string;
|
|
18951
|
+
/**
|
|
18952
|
+
* Parsing format for the time field. If you use a specified time field in the log as the log timestamp, you must fill in TimeKey and TimeFormat. TimeKey and TimeFormat must be paired. For configuration details, see time format.
|
|
18953
|
+
*/
|
|
18954
|
+
timeFormat: string;
|
|
18955
|
+
/**
|
|
18956
|
+
* Name of the log time field. If you use a specific time field in the log as the log timestamp, you must provide both TimeKey and TimeFormat. TimeKey and TimeFormat must appear in pairs
|
|
18957
|
+
*/
|
|
18958
|
+
timeKey: string;
|
|
18959
|
+
/**
|
|
18960
|
+
* Time sample. Used to verify whether the entered time parsing format is correct
|
|
18961
|
+
*/
|
|
18962
|
+
timeSample: string;
|
|
18963
|
+
/**
|
|
18964
|
+
* When uploading logs that failed to parse, specify the key name for the failed logs. UnMatchUpLoadSwitch=true and UnMatchLogKey must be used together.
|
|
18965
|
+
*/
|
|
18966
|
+
unMatchLogKey: string;
|
|
18967
|
+
/**
|
|
18968
|
+
* Whether to upload logs that failed to parse. UnMatchUpLoadSwitch=true and UnMatchLogKey must be paired. true: Upload logs that failed to parse. false: Do not upload logs that failed to parse.
|
|
18969
|
+
*/
|
|
18970
|
+
unMatchUpLoadSwitch: boolean;
|
|
18971
|
+
}
|
|
18972
|
+
interface GetImportTaskTargetInfoExtractRuleExtractRuleFilterKeyRegex {
|
|
18973
|
+
/**
|
|
18974
|
+
* Key.
|
|
18975
|
+
*/
|
|
18976
|
+
key: string;
|
|
18977
|
+
/**
|
|
18978
|
+
* Regular expression.
|
|
18979
|
+
*/
|
|
18980
|
+
regex: string;
|
|
18981
|
+
}
|
|
18982
|
+
interface GetImportTaskTargetInfoExtractRuleExtractRuleLogTemplate {
|
|
18983
|
+
/**
|
|
18984
|
+
* Format.
|
|
18985
|
+
*/
|
|
18986
|
+
format: string;
|
|
18987
|
+
/**
|
|
18988
|
+
* Type
|
|
18989
|
+
*/
|
|
18990
|
+
type: string;
|
|
18991
|
+
}
|
|
18992
|
+
interface GetImportTaskTaskStatistics {
|
|
18993
|
+
/**
|
|
18994
|
+
* Total resource bytes enumerated
|
|
18995
|
+
*/
|
|
18996
|
+
bytesTotal: number;
|
|
18997
|
+
/**
|
|
18998
|
+
* Bytes transferred.
|
|
18999
|
+
*/
|
|
19000
|
+
bytesTransferred: number;
|
|
19001
|
+
/**
|
|
19002
|
+
* Number of resources failed to import.
|
|
19003
|
+
*/
|
|
19004
|
+
failed: number;
|
|
19005
|
+
/**
|
|
19006
|
+
* Number of resources not found.
|
|
19007
|
+
*/
|
|
19008
|
+
notExist: number;
|
|
19009
|
+
/**
|
|
19010
|
+
* Number of resources skipped during import
|
|
19011
|
+
*/
|
|
19012
|
+
skipped: number;
|
|
19013
|
+
/**
|
|
19014
|
+
* Task status. Status of the import task. Preparing: Preparing for import. Importing: Importing data. Success: Import completed successfully. Failed: Import failed. Stopped: Import paused.
|
|
19015
|
+
*/
|
|
19016
|
+
taskStatus: string;
|
|
19017
|
+
/**
|
|
19018
|
+
* Total number of resources enumerated.
|
|
19019
|
+
*/
|
|
19020
|
+
total: number;
|
|
19021
|
+
/**
|
|
19022
|
+
* Number of records transferred.
|
|
19023
|
+
*/
|
|
19024
|
+
transferred: number;
|
|
19025
|
+
}
|
|
19026
|
+
interface GetIndexFullText {
|
|
19027
|
+
/**
|
|
19028
|
+
* Case sensitivity. true: Case sensitive. false: Not case sensitive.
|
|
19029
|
+
*/
|
|
19030
|
+
caseSensitive: boolean;
|
|
19031
|
+
/**
|
|
19032
|
+
* Token separators for the full-text index. Each character in the string represents a token separator. Length: 1–256 bytes. Only one or more of the following characters are supported: letters, numbers, and !@#%^&*()-_=\\"', <>/?|;:\ \r[]{}. . Supports configuring both Chinese characters and token separators simultaneously.
|
|
19033
|
+
*/
|
|
19034
|
+
delimiter: string;
|
|
19035
|
+
/**
|
|
19036
|
+
* When searching, specify whether to segment Chinese content in logs according to Chinese grammar. The default is false. true: For Chinese characters in logs, segment the log according to common Chinese grammar rules. Custom segmentation symbols for Chinese content are not supported. For non-Chinese characters in logs, segment the log using the segmentation symbols specified in the parameter. false: Segment the log using the segmentation symbols specified in the parameter.
|
|
19037
|
+
*/
|
|
19038
|
+
includeChinese: boolean;
|
|
19039
|
+
}
|
|
19040
|
+
interface GetIndexKeyValue {
|
|
19041
|
+
/**
|
|
19042
|
+
* Specify the field names for key-value indexing. Up to 100 fields can be added. Only letters, numbers, spaces, underscores (_), hyphens (-), and slashes (/) are supported, and field names cannot start or end with a space. Each key name must be unique within the same index. Length: 1–128 characters. For subfields in JSON-type key-value indexes, use a dot (.) to indicate the hierarchy between JSON fields. For example, if the JSON field 'namelist' contains a text-type subfield 'totalcount' and a JSON-type subfield 'info', and 'info' contains the field 'name', the field names should be configured as 'totalcount' and 'info.name' respectively.
|
|
19043
|
+
*/
|
|
19044
|
+
key: string;
|
|
19045
|
+
/**
|
|
19046
|
+
* Field description information required for configuring key-value indexes.
|
|
19047
|
+
*/
|
|
19048
|
+
value: outputs.tls.GetIndexKeyValueValue;
|
|
19049
|
+
}
|
|
19050
|
+
interface GetIndexKeyValueValue {
|
|
19051
|
+
/**
|
|
19052
|
+
* Indicates whether the index was added automatically. true: The index was added automatically. false: The index was not added automatically.
|
|
19053
|
+
*/
|
|
19054
|
+
autoIndexFlag: boolean;
|
|
19055
|
+
/**
|
|
19056
|
+
* Whether to distinguish case. Default is false.
|
|
19057
|
+
*/
|
|
19058
|
+
caseSensitive: boolean;
|
|
19059
|
+
/**
|
|
19060
|
+
* Token separators for the field. Default is empty (""). Each character in the string represents a token separator. Length: 0–256 bytes. If the length is 0, segmentation is disabled. Only one or more of the following characters are supported: letters, numbers, and !@#%^&*()-_=\\"', <>/?|;:\ \r[]{}. . Supports configuring both Chinese characters and token separators simultaneously.
|
|
19061
|
+
*/
|
|
19062
|
+
delimiter: string;
|
|
19063
|
+
/**
|
|
19064
|
+
* When searching, determines whether to segment Chinese log content according to Chinese syntax. Enabled: Chinese characters in logs are segmented based on common Chinese syntax; custom segmentation for Chinese content is not supported. Non-Chinese characters in logs are segmented using the token separators specified in the parameter. Disabled: Logs are segmented using the token separators specified in the parameter.
|
|
19065
|
+
*/
|
|
19066
|
+
includeChinese: boolean;
|
|
19067
|
+
/**
|
|
19068
|
+
* Create indexes for all fields with text values in the JSON field.
|
|
19069
|
+
*/
|
|
19070
|
+
indexAll: boolean;
|
|
19071
|
+
/**
|
|
19072
|
+
* Enable automatic indexing and statistics for JSON fields. true: Enable automatic indexing and statistics. false: Disable automatic indexing and statistics.
|
|
19073
|
+
*/
|
|
19074
|
+
indexSqlAll: boolean;
|
|
19075
|
+
/**
|
|
19076
|
+
* When ValueType is json, you can configure key-value indexes for JSON subfields using the JsonKeys field, which is an array of KeyValueInfo. Each element in the JsonKeys list is a KeyValueInfo, and you can further nest text, long, and double type subfields. For subfields in JSON key-value indexes, use . to indicate the hierarchy between JSON fields. For example, the JSON field namelist contains a text-type subfield totalcount and a JSON-type info, which itself contains the field name. Each field name should be configured as totalcount and info.name, respectively. The SqlFlag setting for subfield key-value indexes defined in JsonKeys must match their parent field, meaning they must be enabled or disabled together. The default is disabled. Subfields do not support separate settings for Delimiter, CaseSensitive, or IncludeChinese. For text-type fields, CaseSensitive, Delimiter, and IncludeChinese always inherit the parent field settings. This is only set when ValueType is json.
|
|
19077
|
+
*/
|
|
19078
|
+
jsonKeys: outputs.tls.GetIndexKeyValueValueJsonKey[];
|
|
19079
|
+
/**
|
|
19080
|
+
* Whether analysis is enabled for the field. Default is false. After enabling statistical analysis, you can configure token delimiters and whether to include Chinese content.
|
|
19081
|
+
*/
|
|
19082
|
+
sqlFlag: boolean;
|
|
19083
|
+
/**
|
|
19084
|
+
* Field type. Currently supports long, double, text, and json. The long and double types do not support configuring delimiters, including Chinese, or case sensitivity. Only the json type supports further configuration of JsonKeys subfields.
|
|
19085
|
+
*/
|
|
19086
|
+
valueType: string;
|
|
19087
|
+
}
|
|
19088
|
+
interface GetIndexKeyValueValueJsonKey {
|
|
19089
|
+
/**
|
|
19090
|
+
* Specify the field names for key-value indexing. Up to 100 fields can be added. Only letters, numbers, spaces, underscores (_), hyphens (-), and slashes (/) are supported, and field names cannot start or end with a space. Each key name must be unique within the same index. Length: 1–128 characters. For subfields in JSON-type key-value indexes, use a dot (.) to indicate the hierarchy between JSON fields. For example, if the JSON field 'namelist' contains a text-type subfield 'totalcount' and a JSON-type subfield 'info', and 'info' contains the field 'name', the field names should be configured as 'totalcount' and 'info.name' respectively.
|
|
19091
|
+
*/
|
|
19092
|
+
key: string;
|
|
19093
|
+
/**
|
|
19094
|
+
* Field description information required for configuring key-value indexes.
|
|
19095
|
+
*/
|
|
19096
|
+
value: outputs.tls.GetIndexKeyValueValueJsonKeyValue;
|
|
19097
|
+
}
|
|
19098
|
+
interface GetIndexKeyValueValueJsonKeyValue {
|
|
19099
|
+
/**
|
|
19100
|
+
* Indicates whether the index was added automatically. true: The index was added automatically. false: The index was not added automatically.
|
|
19101
|
+
*/
|
|
19102
|
+
autoIndexFlag: boolean;
|
|
19103
|
+
/**
|
|
19104
|
+
* Whether to distinguish case. Default is false.
|
|
19105
|
+
*/
|
|
19106
|
+
caseSensitive: boolean;
|
|
19107
|
+
/**
|
|
19108
|
+
* Token separators for the field. Default is empty (""). Each character in the string represents a token separator. Length: 0–256 bytes. If the length is 0, segmentation is disabled. Only one or more of the following characters are supported: letters, numbers, and !@#%^&*()-_=\\"', <>/?|;:\ \r[]{}. . Supports configuring both Chinese characters and token separators simultaneously.
|
|
19109
|
+
*/
|
|
19110
|
+
delimiter: string;
|
|
19111
|
+
/**
|
|
19112
|
+
* When searching, determines whether to segment Chinese log content according to Chinese syntax. Enabled: Chinese characters in logs are segmented based on common Chinese syntax; custom segmentation for Chinese content is not supported. Non-Chinese characters in logs are segmented using the token separators specified in the parameter. Disabled: Logs are segmented using the token separators specified in the parameter.
|
|
19113
|
+
*/
|
|
19114
|
+
includeChinese: boolean;
|
|
19115
|
+
/**
|
|
19116
|
+
* Create indexes for all fields with text values in the JSON field.
|
|
19117
|
+
*/
|
|
19118
|
+
indexAll: boolean;
|
|
19119
|
+
/**
|
|
19120
|
+
* Enable automatic indexing and statistics for JSON fields. true: Enable automatic indexing and statistics. false: Disable automatic indexing and statistics.
|
|
19121
|
+
*/
|
|
19122
|
+
indexSqlAll: boolean;
|
|
19123
|
+
/**
|
|
19124
|
+
* Whether analysis is enabled for the field. Default is false. After enabling statistical analysis, you can configure token delimiters and whether to include Chinese content.
|
|
19125
|
+
*/
|
|
19126
|
+
sqlFlag: boolean;
|
|
19127
|
+
/**
|
|
19128
|
+
* Field type. Currently supports long, double, text, and json. The long and double types do not support configuring delimiters, including Chinese, or case sensitivity. Only the json type supports further configuration of JsonKeys subfields.
|
|
19129
|
+
*/
|
|
19130
|
+
valueType: string;
|
|
19131
|
+
}
|
|
19132
|
+
interface GetIndexUserInnerKeyValue {
|
|
19133
|
+
/**
|
|
19134
|
+
* Specify the field names for key-value indexing. Up to 100 fields can be added. Only letters, numbers, spaces, underscores (_), hyphens (-), and slashes (/) are supported, and field names cannot start or end with a space. Each key name must be unique within the same index. Length: 1–128 characters. For subfields in JSON-type key-value indexes, use a dot (.) to indicate the hierarchy between JSON fields. For example, if the JSON field 'namelist' contains a text-type subfield 'totalcount' and a JSON-type subfield 'info', and 'info' contains the field 'name', the field names should be configured as 'totalcount' and 'info.name' respectively.
|
|
19135
|
+
*/
|
|
19136
|
+
key: string;
|
|
19137
|
+
/**
|
|
19138
|
+
* Field description information required for configuring key-value indexes.
|
|
19139
|
+
*/
|
|
19140
|
+
value: outputs.tls.GetIndexUserInnerKeyValueValue;
|
|
19141
|
+
}
|
|
19142
|
+
interface GetIndexUserInnerKeyValueValue {
|
|
19143
|
+
/**
|
|
19144
|
+
* Indicates whether the index was added automatically. true: The index was added automatically. false: The index was not added automatically.
|
|
19145
|
+
*/
|
|
19146
|
+
autoIndexFlag: boolean;
|
|
19147
|
+
/**
|
|
19148
|
+
* Whether to distinguish case. Default is false.
|
|
19149
|
+
*/
|
|
19150
|
+
caseSensitive: boolean;
|
|
19151
|
+
/**
|
|
19152
|
+
* Token separators for the field. Default is empty (""). Each character in the string represents a token separator. Length: 0–256 bytes. If the length is 0, segmentation is disabled. Only one or more of the following characters are supported: letters, numbers, and !@#%^&*()-_=\\"', <>/?|;:\ \r[]{}. . Supports configuring both Chinese characters and token separators simultaneously.
|
|
19153
|
+
*/
|
|
19154
|
+
delimiter: string;
|
|
19155
|
+
/**
|
|
19156
|
+
* When searching, determines whether to segment Chinese log content according to Chinese syntax. Enabled: Chinese characters in logs are segmented based on common Chinese syntax; custom segmentation for Chinese content is not supported. Non-Chinese characters in logs are segmented using the token separators specified in the parameter. Disabled: Logs are segmented using the token separators specified in the parameter.
|
|
19157
|
+
*/
|
|
19158
|
+
includeChinese: boolean;
|
|
19159
|
+
/**
|
|
19160
|
+
* Create indexes for all fields with text values in the JSON field.
|
|
19161
|
+
*/
|
|
19162
|
+
indexAll: boolean;
|
|
19163
|
+
/**
|
|
19164
|
+
* Enable automatic indexing and statistics for JSON fields. true: Enable automatic indexing and statistics. false: Disable automatic indexing and statistics.
|
|
19165
|
+
*/
|
|
19166
|
+
indexSqlAll: boolean;
|
|
19167
|
+
/**
|
|
19168
|
+
* When ValueType is json, you can configure key-value indexes for JSON subfields using the JsonKeys field, which is an array of KeyValueInfo. Each element in the JsonKeys list is a KeyValueInfo, and you can further nest text, long, and double type subfields. For subfields in JSON key-value indexes, use . to indicate the hierarchy between JSON fields. For example, the JSON field namelist contains a text-type subfield totalcount and a JSON-type info, which itself contains the field name. Each field name should be configured as totalcount and info.name, respectively. The SqlFlag setting for subfield key-value indexes defined in JsonKeys must match their parent field, meaning they must be enabled or disabled together. The default is disabled. Subfields do not support separate settings for Delimiter, CaseSensitive, or IncludeChinese. For text-type fields, CaseSensitive, Delimiter, and IncludeChinese always inherit the parent field settings. This is only set when ValueType is json.
|
|
19169
|
+
*/
|
|
19170
|
+
jsonKeys: outputs.tls.GetIndexUserInnerKeyValueValueJsonKey[];
|
|
19171
|
+
/**
|
|
19172
|
+
* Whether analysis is enabled for the field. Default is false. After enabling statistical analysis, you can configure token delimiters and whether to include Chinese content.
|
|
19173
|
+
*/
|
|
19174
|
+
sqlFlag: boolean;
|
|
19175
|
+
/**
|
|
19176
|
+
* Field type. Currently supports long, double, text, and json. The long and double types do not support configuring delimiters, including Chinese, or case sensitivity. Only the json type supports further configuration of JsonKeys subfields.
|
|
19177
|
+
*/
|
|
19178
|
+
valueType: string;
|
|
19179
|
+
}
|
|
19180
|
+
interface GetIndexUserInnerKeyValueValueJsonKey {
|
|
19181
|
+
/**
|
|
19182
|
+
* Specify the field names for key-value indexing. Up to 100 fields can be added. Only letters, numbers, spaces, underscores (_), hyphens (-), and slashes (/) are supported, and field names cannot start or end with a space. Each key name must be unique within the same index. Length: 1–128 characters. For subfields in JSON-type key-value indexes, use a dot (.) to indicate the hierarchy between JSON fields. For example, if the JSON field 'namelist' contains a text-type subfield 'totalcount' and a JSON-type subfield 'info', and 'info' contains the field 'name', the field names should be configured as 'totalcount' and 'info.name' respectively.
|
|
19183
|
+
*/
|
|
19184
|
+
key: string;
|
|
19185
|
+
/**
|
|
19186
|
+
* Field description information required for configuring key-value indexes.
|
|
19187
|
+
*/
|
|
19188
|
+
value: outputs.tls.GetIndexUserInnerKeyValueValueJsonKeyValue;
|
|
19189
|
+
}
|
|
19190
|
+
interface GetIndexUserInnerKeyValueValueJsonKeyValue {
|
|
19191
|
+
/**
|
|
19192
|
+
* Indicates whether the index was added automatically. true: The index was added automatically. false: The index was not added automatically.
|
|
19193
|
+
*/
|
|
19194
|
+
autoIndexFlag: boolean;
|
|
19195
|
+
/**
|
|
19196
|
+
* Whether to distinguish case. Default is false.
|
|
19197
|
+
*/
|
|
19198
|
+
caseSensitive: boolean;
|
|
19199
|
+
/**
|
|
19200
|
+
* Token separators for the field. Default is empty (""). Each character in the string represents a token separator. Length: 0–256 bytes. If the length is 0, segmentation is disabled. Only one or more of the following characters are supported: letters, numbers, and !@#%^&*()-_=\\"', <>/?|;:\ \r[]{}. . Supports configuring both Chinese characters and token separators simultaneously.
|
|
19201
|
+
*/
|
|
19202
|
+
delimiter: string;
|
|
19203
|
+
/**
|
|
19204
|
+
* When searching, determines whether to segment Chinese log content according to Chinese syntax. Enabled: Chinese characters in logs are segmented based on common Chinese syntax; custom segmentation for Chinese content is not supported. Non-Chinese characters in logs are segmented using the token separators specified in the parameter. Disabled: Logs are segmented using the token separators specified in the parameter.
|
|
19205
|
+
*/
|
|
19206
|
+
includeChinese: boolean;
|
|
19207
|
+
/**
|
|
19208
|
+
* Create indexes for all fields with text values in the JSON field.
|
|
19209
|
+
*/
|
|
19210
|
+
indexAll: boolean;
|
|
19211
|
+
/**
|
|
19212
|
+
* Enable automatic indexing and statistics for JSON fields. true: Enable automatic indexing and statistics. false: Disable automatic indexing and statistics.
|
|
19213
|
+
*/
|
|
19214
|
+
indexSqlAll: boolean;
|
|
19215
|
+
/**
|
|
19216
|
+
* Whether analysis is enabled for the field. Default is false. After enabling statistical analysis, you can configure token delimiters and whether to include Chinese content.
|
|
19217
|
+
*/
|
|
19218
|
+
sqlFlag: boolean;
|
|
19219
|
+
/**
|
|
19220
|
+
* Field type. Currently supports long, double, text, and json. The long and double types do not support configuring delimiters, including Chinese, or case sensitivity. Only the json type supports further configuration of JsonKeys subfields.
|
|
19221
|
+
*/
|
|
19222
|
+
valueType: string;
|
|
19223
|
+
}
|
|
19224
|
+
interface GetProjectTag {
|
|
19225
|
+
/**
|
|
19226
|
+
* Tag key
|
|
19227
|
+
*/
|
|
19228
|
+
key: string;
|
|
19229
|
+
/**
|
|
19230
|
+
* Tag value
|
|
19231
|
+
*/
|
|
19232
|
+
value: string;
|
|
19233
|
+
}
|
|
19234
|
+
interface GetRuleContainerRule {
|
|
19235
|
+
/**
|
|
19236
|
+
* Container name to collect. If no container name is specified, all containers in the machine group will be collected. Supports regex matching; for example, setting the container name to ^(container-test)$ will collect all containers named container-test.
|
|
19237
|
+
*/
|
|
19238
|
+
containerNameRegex: string;
|
|
19239
|
+
/**
|
|
19240
|
+
* Whether to add environment variables as log tags to the raw log data. When enabled, the log service adds container environment variable fields to the logs. Setting multiple key-value pairs adds multiple fields. For example, set Key to source and Value to data_source. If the container has the environment variable source=DC, the log will include the field **tag**data_source_*: DC
|
|
19241
|
+
*/
|
|
19242
|
+
envTags: outputs.tls.GetRuleContainerRuleEnvTag[];
|
|
19243
|
+
/**
|
|
19244
|
+
* The container environment variable denylist specifies which containers are excluded from collection. If the denylist is not enabled, all containers are collected. When the container environment variable denylist is enabled, Key is required and Value is optional. If Value is empty, all containers whose environment variables contain the Key are excluded from collection. If Value is not empty, only containers with a matching key-value pair are excluded, meaning only containers whose environment variables contain the Key and whose value matches the Value are excluded. Value supports regular expressions. For example, if Key is set to module and Value is set to ^(tcp|udp)$, containers with environment variables module:tcp or module:udp are excluded from collection. Multiple key-value pairs are evaluated with a logical OR, so any container environment variable matching any key-value pair will be excluded from collection. When the container environment variable denylist is enabled, Keys must be unique.
|
|
19245
|
+
*/
|
|
19246
|
+
excludeContainerEnvRegexes: outputs.tls.GetRuleContainerRuleExcludeContainerEnvRegex[];
|
|
19247
|
+
/**
|
|
19248
|
+
* Container label denylist specifies containers to exclude from collection. If the denylist is not enabled, all containers will be collected. If the container label denylist is enabled, Key is required and Value is optional. If Value is empty, all containers with the Key in their label will be excluded. If Value is not empty, only containers matching the key-value pair will be excluded—that is, containers with the Key in their label and a Value matching the specified pattern. Value supports regex matching; for example, set Key to app and Value to ^(test1|test2)$ to exclude containers with labels app:test1 and app:test2. Multiple key-value pairs use logical OR; any container label matching any pair will be excluded from collection. When the container label denylist is enabled, Keys must not be duplicated.
|
|
19249
|
+
*/
|
|
19250
|
+
excludeContainerLabelRegexes: outputs.tls.GetRuleContainerRuleExcludeContainerLabelRegex[];
|
|
19251
|
+
/**
|
|
19252
|
+
* The container environment variable allowlist specifies which containers to collect using container environment variables. If the allowlist is not enabled, all containers are collected. When the container environment variable allowlist is enabled, you must enter key-value pairs. Key is required; Value is optional. If Value is empty, all containers containing the Key in their environment variables are collected. If Value is not empty, only containers with the Key in their environment variables and a Value matching the specified value are collected. Value supports regular expression matching. For example, if Key is set to module and Value is set to ^(tcp|udp)$, only containers with module:tcp or module:udp in their environment variables are collected. The logical relationship between multiple key-value pairs is OR, meaning any container environment variable matching any key-value pair will be included in the collection scope. When the container environment variable allowlist is enabled, Keys must not be duplicated.
|
|
19253
|
+
*/
|
|
19254
|
+
includeContainerEnvRegexes: outputs.tls.GetRuleContainerRuleIncludeContainerEnvRegex[];
|
|
19255
|
+
/**
|
|
19256
|
+
* The container label allowlist specifies which containers to collect based on container labels. If the allowlist is not enabled, all containers are collected. When the container label allowlist is enabled, you must specify key-value pairs. Key is required and Value is optional. If Value is empty, all containers whose labels contain the Key are collected. If Value is not empty, only containers whose labels contain the Key and whose value matches the Value are collected. Value supports regular expressions. For example, if Key is set to app and Value is set to ^(test1|test2)$, only containers with labels app:test1 or app:test2 are collected. Multiple key-value pairs are evaluated with a logical OR, so any container label matching any key-value pair will be included in the collection scope. When the container label allowlist is enabled, Keys must be unique.
|
|
19257
|
+
*/
|
|
19258
|
+
includeContainerLabelRegexes: outputs.tls.GetRuleContainerRuleIncludeContainerLabelRegex[];
|
|
19259
|
+
/**
|
|
19260
|
+
* Kubernetes container collection rules.
|
|
19261
|
+
*/
|
|
19262
|
+
kubernetesRule: outputs.tls.GetRuleContainerRuleKubernetesRule;
|
|
19263
|
+
/**
|
|
19264
|
+
* Collection information. stdout: Collects container standard output (stdout). stderr: Collects container standard error (stderr). all: Collects both container standard output (stdout) and standard error (stderr).
|
|
19265
|
+
*/
|
|
19266
|
+
stream: string;
|
|
19267
|
+
}
|
|
19268
|
+
interface GetRuleContainerRuleEnvTag {
|
|
19269
|
+
/**
|
|
19270
|
+
* Key.
|
|
19271
|
+
*/
|
|
19272
|
+
key: string;
|
|
19273
|
+
/**
|
|
19274
|
+
* Value.
|
|
19275
|
+
*/
|
|
19276
|
+
val: string;
|
|
19277
|
+
}
|
|
19278
|
+
interface GetRuleContainerRuleExcludeContainerEnvRegex {
|
|
19279
|
+
/**
|
|
19280
|
+
* Key.
|
|
19281
|
+
*/
|
|
19282
|
+
key: string;
|
|
19283
|
+
/**
|
|
19284
|
+
* Value.
|
|
19285
|
+
*/
|
|
19286
|
+
val: string;
|
|
19287
|
+
}
|
|
19288
|
+
interface GetRuleContainerRuleExcludeContainerLabelRegex {
|
|
19289
|
+
/**
|
|
19290
|
+
* Key.
|
|
19291
|
+
*/
|
|
19292
|
+
key: string;
|
|
19293
|
+
/**
|
|
19294
|
+
* Value.
|
|
19295
|
+
*/
|
|
19296
|
+
val: string;
|
|
19297
|
+
}
|
|
19298
|
+
interface GetRuleContainerRuleIncludeContainerEnvRegex {
|
|
19299
|
+
/**
|
|
19300
|
+
* Key.
|
|
19301
|
+
*/
|
|
19302
|
+
key: string;
|
|
19303
|
+
/**
|
|
19304
|
+
* Value.
|
|
19305
|
+
*/
|
|
19306
|
+
val: string;
|
|
19307
|
+
}
|
|
19308
|
+
interface GetRuleContainerRuleIncludeContainerLabelRegex {
|
|
19309
|
+
/**
|
|
19310
|
+
* Key.
|
|
19311
|
+
*/
|
|
19312
|
+
key: string;
|
|
19313
|
+
/**
|
|
19314
|
+
* Value.
|
|
19315
|
+
*/
|
|
19316
|
+
val: string;
|
|
19317
|
+
}
|
|
19318
|
+
interface GetRuleContainerRuleKubernetesRule {
|
|
19319
|
+
/**
|
|
19320
|
+
* Whether to add Kubernetes Annotations as log tags to the original log data. When enabled, the log service will add fields related to Kubernetes Pod Annotations to the logs. Setting multiple key-value pairs means adding multiple fields. For example, if you set Key to sink and Value to data_sink, and the Pod contains the annotation sink=ck, a new field **tag**data_sink_*: ck will be added to the log.
|
|
19321
|
+
*/
|
|
19322
|
+
annotationTags: outputs.tls.GetRuleContainerRuleKubernetesRuleAnnotationTag[];
|
|
19323
|
+
/**
|
|
19324
|
+
* Whether to add all Kubernetes Labels as log tags to the original log data. When enabled, the log service adds fields for all Labels in the Kubernetes Pod to the logs. For example, if the Pod contains Label source=DC and destination=CS, the logs will include fields **tag**source__: DC and **tag**destination__: CS.
|
|
19325
|
+
*/
|
|
19326
|
+
enableAllLabelTag: boolean;
|
|
19327
|
+
/**
|
|
19328
|
+
* Pod Annotation Denylist is used to specify containers that are not collected. If you need to set a Pod Annotation Denylist, Key is required and Value is optional. If Value is empty, all containers under Pods whose Pod Annotation contains the specified Key are excluded. If Value is not empty, only containers under Pods whose Pod Annotation contains the Key and whose value matches the specified Value are excluded. By default, Value uses string matching, meaning it only matches when Value and the Pod Annotation value are exactly the same. If the value starts with ^ and ends with $, it is treated as a regular expression. For example, if Key is set to app and Value is set to ^(test1|test2)$, it matches containers under Pods with Pod Annotation app:test1 or app:test2. Note: The logical relationship between multiple Key-Value pairs is OR, meaning a Pod Annotation that matches any pair will be excluded from the collection scope. When enabling the Pod Annotation Denylist, Keys must not be duplicated. For regex fuzzy matching, you must add .*. For example, ^(http.*)$ matches strings starting with http
|
|
19329
|
+
*/
|
|
19330
|
+
excludePodAnnotationRegexes: outputs.tls.GetRuleContainerRuleKubernetesRuleExcludePodAnnotationRegex[];
|
|
19331
|
+
/**
|
|
19332
|
+
* Specify containers to exclude from collection using the Pod Label denylist. If not enabled, all containers are collected. To set a Pod Label denylist, Key is required and Value is optional. If Value is empty, all containers with the specified Key in their Pod Label are excluded from collection. If Value is not empty, only containers with the specified Key and a Value matching the Value in their Pod Label are excluded. Value supports regular expressions. For example, set Key to module and Value to ^(tcp|udp)$ to exclude containers with module:tcp or module:udp in their Pod Label. Note: The logical relationship between multiple Key-Value pairs is OR. Any Pod Label matching any Key-Value pair will be excluded from collection. When enabling the Pod Label denylist, Keys must not be duplicated. For fuzzy regular expression matching, you must add .*. For example, ^(http.*)$ matches any string starting with http
|
|
19333
|
+
*/
|
|
19334
|
+
excludePodLabelRegexes: outputs.tls.GetRuleContainerRuleKubernetesRuleExcludePodLabelRegex[];
|
|
19335
|
+
/**
|
|
19336
|
+
* Pod Annotation Allowlist is used to specify containers to be collected. If you need to set a Pod Annotation Allowlist, Key is required and Value is optional. If Value is empty, all containers under Pods that contain the Key in Pod Annotation will match. If Value is not empty, only containers under Pods that contain the Key and whose value matches Value in Pod Annotation will match. Value defaults to string matching, meaning only when Value and the Pod Annotation value are exactly the same will they match. If the value starts with ^ and ends with $, it is a regex match. For example, set Key to app and Value to ^(test1|test2)$ to match containers under Pods with Pod Annotation app:test1 or app:test2. Note: The logical relationship between multiple Key-Value pairs is OR, meaning as long as Pod Annotation matches any pair, it will be included in the collection scope. When enabling Pod Annotation Allowlist, Keys must not be duplicated. For regex fuzzy matching, you must add .*. For example, ^(http.*)$ matches strings starting with http.
|
|
19337
|
+
*/
|
|
19338
|
+
includePodAnnotationRegexes: outputs.tls.GetRuleContainerRuleKubernetesRuleIncludePodAnnotationRegex[];
|
|
19339
|
+
/**
|
|
19340
|
+
* Pod Label Allowlist is used to specify which containers to collect. If Pod Label Allowlist is not enabled, all containers will be collected. If you need to set a Pod Label Allowlist, Key is required: if Value is empty, all containers with the Key in their Pod Label will be collected. If Value is not empty, only containers with the Key in their Pod Label and a Value matching the specified pattern will be collected; regular expression matching is supported. For example, if you set Key to module and Value to ^(tcp|udp)$, only containers with module:tcp or module:udp in their Pod Label will be collected. Note: The logical relationship between multiple key-value pairs is OR, meaning any Pod Label matching any key-value pair will be included in the collection scope. When enabling Pod Label Allowlist, Keys cannot be duplicated. For fuzzy regular expression matching, you must add .*, for example, ^(http.*)$ matches strings starting with http.
|
|
19341
|
+
*/
|
|
19342
|
+
includePodLabelRegexes: outputs.tls.GetRuleContainerRuleKubernetesRuleIncludePodLabelRegex[];
|
|
19343
|
+
/**
|
|
19344
|
+
* Whether to add Kubernetes labels as log tags to the raw log data. When enabled, the log service adds Kubernetes Pod label fields to the logs. Setting multiple key-value pairs adds multiple fields. For example, if you set Key to source and Value to data_source, and the Pod contains the label source=DC, the log will include the field **tag**data_source_*: DC.
|
|
19345
|
+
*/
|
|
19346
|
+
labelTags: outputs.tls.GetRuleContainerRuleKubernetesRuleLabelTag[];
|
|
19347
|
+
/**
|
|
19348
|
+
* Name of the Kubernetes Namespace to collect. If no Namespace name is specified, all containers will be collected. Namespace names support regular expression matching. For example, if you set the Namespace name to ^(tcp|udp)$, it will collect all containers under the tcp and udp namespaces.
|
|
19349
|
+
*/
|
|
19350
|
+
namespaceNameRegex: string;
|
|
19351
|
+
/**
|
|
19352
|
+
* Pod name is used to specify the Pod whose containers will be collected. If no Pod name is specified, all containers will be collected. Pod name supports regular expression matching. For example, setting the Pod name to ^(http.*)$ collects all containers under Pods whose names start with http.
|
|
19353
|
+
*/
|
|
19354
|
+
podNameRegex: string;
|
|
19355
|
+
/**
|
|
19356
|
+
* Specify the container to collect by workload name. If no workload name is specified, all containers are collected. Workload names support regular expressions. For example, setting the workload name to ^(http.*)$ collects all containers under workloads starting with http.
|
|
19357
|
+
*/
|
|
19358
|
+
workloadNameRegex: string;
|
|
19359
|
+
/**
|
|
19360
|
+
* Specify the container to collect by workload type. Only one type can be selected. If no type is specified, containers of all types will be collected. Supported workload types: Deployment: stateless workload StatefulSet: stateful workload DaemonSet: daemon process Job: task CronJob: scheduled task
|
|
19361
|
+
*/
|
|
19362
|
+
workloadType: string;
|
|
19363
|
+
}
|
|
19364
|
+
interface GetRuleContainerRuleKubernetesRuleAnnotationTag {
|
|
19365
|
+
/**
|
|
19366
|
+
* Key.
|
|
19367
|
+
*/
|
|
19368
|
+
key: string;
|
|
19369
|
+
/**
|
|
19370
|
+
* Value.
|
|
19371
|
+
*/
|
|
19372
|
+
val: string;
|
|
19373
|
+
}
|
|
19374
|
+
interface GetRuleContainerRuleKubernetesRuleExcludePodAnnotationRegex {
|
|
19375
|
+
/**
|
|
19376
|
+
* Key.
|
|
19377
|
+
*/
|
|
19378
|
+
key: string;
|
|
19379
|
+
/**
|
|
19380
|
+
* Value.
|
|
19381
|
+
*/
|
|
19382
|
+
val: string;
|
|
19383
|
+
}
|
|
19384
|
+
interface GetRuleContainerRuleKubernetesRuleExcludePodLabelRegex {
|
|
19385
|
+
/**
|
|
19386
|
+
* Key.
|
|
19387
|
+
*/
|
|
19388
|
+
key: string;
|
|
19389
|
+
/**
|
|
19390
|
+
* Value.
|
|
19391
|
+
*/
|
|
19392
|
+
val: string;
|
|
19393
|
+
}
|
|
19394
|
+
interface GetRuleContainerRuleKubernetesRuleIncludePodAnnotationRegex {
|
|
19395
|
+
/**
|
|
19396
|
+
* Key.
|
|
19397
|
+
*/
|
|
19398
|
+
key: string;
|
|
19399
|
+
/**
|
|
19400
|
+
* Value.
|
|
19401
|
+
*/
|
|
19402
|
+
val: string;
|
|
19403
|
+
}
|
|
19404
|
+
interface GetRuleContainerRuleKubernetesRuleIncludePodLabelRegex {
|
|
19405
|
+
/**
|
|
19406
|
+
* Key.
|
|
19407
|
+
*/
|
|
19408
|
+
key: string;
|
|
19409
|
+
/**
|
|
19410
|
+
* Value.
|
|
19411
|
+
*/
|
|
19412
|
+
val: string;
|
|
19413
|
+
}
|
|
19414
|
+
interface GetRuleContainerRuleKubernetesRuleLabelTag {
|
|
19415
|
+
/**
|
|
19416
|
+
* Key.
|
|
19417
|
+
*/
|
|
19418
|
+
key: string;
|
|
19419
|
+
/**
|
|
19420
|
+
* Value.
|
|
19421
|
+
*/
|
|
19422
|
+
val: string;
|
|
19423
|
+
}
|
|
19424
|
+
interface GetRuleExcludePath {
|
|
19425
|
+
/**
|
|
19426
|
+
* Collection path type. File: File name. Path: Directory.
|
|
19427
|
+
*/
|
|
19428
|
+
type: string;
|
|
19429
|
+
/**
|
|
19430
|
+
* Collection path. Must be specified as an absolute path. When Type is Path, Value indicates a directory. When Type is File, Value indicates a file name.
|
|
19431
|
+
*/
|
|
19432
|
+
value: string;
|
|
19433
|
+
}
|
|
19434
|
+
interface GetRuleExtractRule {
|
|
19435
|
+
/**
|
|
19436
|
+
* Regular expression that the first line of the log must match. Valid only when LogType is multiline*log or fullregex*log. Must be a valid regular expression.
|
|
19437
|
+
*/
|
|
19438
|
+
beginRegex: string;
|
|
19439
|
+
/**
|
|
19440
|
+
* Log delimiter. Valid only when LogType is delimiter_log.
|
|
19441
|
+
*/
|
|
19442
|
+
delimiter: string;
|
|
19443
|
+
/**
|
|
19444
|
+
* Enable nanosecond precision time. When enabled, log time parsing will include and report nanosecond precision. true: Enable nanosecond precision time. false: Disable nanosecond precision time.
|
|
19445
|
+
*/
|
|
19446
|
+
enableNanosecond: boolean;
|
|
19447
|
+
/**
|
|
19448
|
+
* Filter rule list. When LogType is minimalist*log or multiline*log, you can configure up to 1 filter rule, and the filter field name key must be content. When LogType is delimiter*log, json*log, or fullregex*log, you can configure up to 5 filter rules, and the filter field name key cannot be duplicated or empty. The regular expression for the filter field's log content must be a valid regular expression and is limited to 256 characters.
|
|
19449
|
+
*/
|
|
19450
|
+
filterKeyRegexes: outputs.tls.GetRuleExtractRuleFilterKeyRegex[];
|
|
19451
|
+
/**
|
|
19452
|
+
* List of log field names (Key). This is only valid when LogType is delimiter*log or fullregex*log. You can configure up to 100 field names. When LogType is delimiter*log, field names must be unique and cannot all be empty. When LogType is fullregex*log, field names must be unique and cannot be empty.
|
|
19453
|
+
*/
|
|
19454
|
+
keys: string[];
|
|
19455
|
+
/**
|
|
19456
|
+
* The entire log must match the specified regular expression. This is only valid when the collected log type is fullregex_log. Must be a valid regular expression.
|
|
19457
|
+
*/
|
|
19458
|
+
logRegex: string;
|
|
19459
|
+
/**
|
|
19460
|
+
* Automatically extract log fields based on the specified log template
|
|
19461
|
+
*/
|
|
19462
|
+
logTemplate: outputs.tls.GetRuleExtractRuleLogTemplate;
|
|
19463
|
+
/**
|
|
19464
|
+
* Quoting character. Content wrapped by a quoting character will not be split but parsed as a complete field. Only valid when LogType is delimiter_log.
|
|
19465
|
+
*/
|
|
19466
|
+
quote: string;
|
|
19467
|
+
/**
|
|
19468
|
+
* Regular expression for extracting time, used to extract the time value from the TimeKey field and parse it as the collection time
|
|
19469
|
+
*/
|
|
19470
|
+
timeExtractRegex: string;
|
|
19471
|
+
/**
|
|
19472
|
+
* Parsing format for the time field. If you use a specific time field in the log as the log timestamp, you must provide both TimeKey and TimeFormat. TimeKey and TimeFormat must be used together.
|
|
19473
|
+
*/
|
|
19474
|
+
timeFormat: string;
|
|
19475
|
+
/**
|
|
19476
|
+
* Name of the log time field. If you want to use a specific time field in the log as the log timestamp, you need to specify both TimeKey and TimeFormat. TimeKey and TimeFormat must be provided together.
|
|
19477
|
+
*/
|
|
19478
|
+
timeKey: string;
|
|
19479
|
+
/**
|
|
19480
|
+
* Time sample. Used to check whether the entered time parsing format is correct.
|
|
19481
|
+
*/
|
|
19482
|
+
timeSample: string;
|
|
19483
|
+
/**
|
|
19484
|
+
* Time zone. Supports machine time zone (default) and custom time zone. Custom time zone supports GMT and UTC. GMT format: GMT+08:00. UTC format: Asia/Shanghai.
|
|
19485
|
+
*/
|
|
19486
|
+
timeZone: string;
|
|
19487
|
+
/**
|
|
19488
|
+
* Key name for unmatched logs.
|
|
19489
|
+
*/
|
|
19490
|
+
unMatchLogKey: string;
|
|
19491
|
+
/**
|
|
19492
|
+
* Switch for uploading unmatched logs.
|
|
19493
|
+
*/
|
|
19494
|
+
unMatchUpLoadSwitch: boolean;
|
|
19495
|
+
}
|
|
19496
|
+
interface GetRuleExtractRuleFilterKeyRegex {
|
|
19497
|
+
/**
|
|
19498
|
+
* Name of the filter field.
|
|
19499
|
+
*/
|
|
19500
|
+
key: string;
|
|
19501
|
+
/**
|
|
19502
|
+
* The log content of the filter field must match the specified regular expression.
|
|
19503
|
+
*/
|
|
19504
|
+
regex: string;
|
|
19505
|
+
}
|
|
19506
|
+
interface GetRuleExtractRuleLogTemplate {
|
|
19507
|
+
/**
|
|
19508
|
+
* Log template format.
|
|
19509
|
+
*/
|
|
19510
|
+
format: string;
|
|
19511
|
+
/**
|
|
19512
|
+
* Log template types. Supported types: Nginx: Nginx log template.
|
|
19513
|
+
*/
|
|
19514
|
+
type: string;
|
|
19515
|
+
}
|
|
19516
|
+
interface GetRuleHostGroupInfo {
|
|
19517
|
+
/**
|
|
19518
|
+
* Number of hosts with heartbeat exceptions.
|
|
19519
|
+
*/
|
|
19520
|
+
abnormalHeartbeatStatusCount: number;
|
|
19521
|
+
/**
|
|
19522
|
+
* Latest agent version.
|
|
19523
|
+
*/
|
|
19524
|
+
agentLatestVersion: string;
|
|
19525
|
+
/**
|
|
19526
|
+
* Whether LogCollector installed on the machine group server has automatic upgrade enabled. true: The log service will check for upgrades during a specified time period each day. If upgrade conditions are met, LogCollector will be upgraded automatically without manual intervention. false (default): LogCollector does not upgrade automatically. To use a newer version of LogCollector, refer to the LogCollector upgrade procedure.
|
|
19527
|
+
*/
|
|
19528
|
+
autoUpdate: boolean;
|
|
19529
|
+
/**
|
|
19530
|
+
* Machine group creation time.
|
|
19531
|
+
*/
|
|
19532
|
+
createTime: string;
|
|
19533
|
+
/**
|
|
19534
|
+
* Number of hosts.
|
|
19535
|
+
*/
|
|
19536
|
+
hostCount: number;
|
|
19537
|
+
/**
|
|
19538
|
+
* Machine group ID
|
|
19539
|
+
*/
|
|
19540
|
+
hostGroupId: string;
|
|
19541
|
+
/**
|
|
19542
|
+
* Name of the machine group.
|
|
19543
|
+
*/
|
|
19544
|
+
hostGroupName: string;
|
|
19545
|
+
/**
|
|
19546
|
+
* Machine group type. IP: Machine IP. Label: Machine label.
|
|
19547
|
+
*/
|
|
19548
|
+
hostGroupType: string;
|
|
19549
|
+
/**
|
|
19550
|
+
* Machine identifier.
|
|
19551
|
+
*/
|
|
19552
|
+
hostIdentifier: string;
|
|
19553
|
+
/**
|
|
19554
|
+
* The IAM project to which the host group belongs.
|
|
19555
|
+
*/
|
|
19556
|
+
iamProjectName: string;
|
|
19557
|
+
/**
|
|
19558
|
+
* Time when the machine group was modified.
|
|
19559
|
+
*/
|
|
19560
|
+
modifyTime: string;
|
|
19561
|
+
/**
|
|
19562
|
+
* Number of hosts with normal heartbeat.
|
|
19563
|
+
*/
|
|
19564
|
+
normalHeartbeatStatusCount: number;
|
|
19565
|
+
/**
|
|
19566
|
+
* The number of bound collection configurations.
|
|
19567
|
+
*/
|
|
19568
|
+
ruleCount: number;
|
|
19569
|
+
/**
|
|
19570
|
+
* Whether to enable the Logcollector service log feature. true: enabled. false (default): disabled.
|
|
19571
|
+
*/
|
|
19572
|
+
serviceLogging: boolean;
|
|
19573
|
+
/**
|
|
19574
|
+
* End time for LogCollector automatic upgrade.
|
|
19575
|
+
*/
|
|
19576
|
+
updateEndTime: string;
|
|
19577
|
+
/**
|
|
19578
|
+
* LogCollector auto-update start time. Note: Only required when AutoUpdate is set to true. It is recommended to schedule auto-updates during off-peak hours. LogCollector may restart during the update process, but logs will not be lost.
|
|
19579
|
+
*/
|
|
19580
|
+
updateStartTime: string;
|
|
19581
|
+
}
|
|
19582
|
+
interface GetRuleUserDefineRule {
|
|
19583
|
+
/**
|
|
19584
|
+
* The Advanced parameter is used for extended configuration. After enabling extended configuration, you can customize advanced behaviors of LogCollector, such as when to release file handles. Note: If multiple release conditions are specified, the handle is released and log file monitoring ends as soon as any condition is met.
|
|
19585
|
+
*/
|
|
19586
|
+
advanced: outputs.tls.GetRuleUserDefineRuleAdvanced;
|
|
19587
|
+
/**
|
|
19588
|
+
* Whether to upload the label information of the host group to the log service. The default is off. true: LogCollector uploads the label information of the host group to the specified field. You can specify the field name in the HostGroupLabelKey parameter. false (default): Host group label information is not uploaded.
|
|
19589
|
+
*/
|
|
19590
|
+
enableHostGroupLabel: boolean;
|
|
19591
|
+
/**
|
|
19592
|
+
* Upload the hostname field. Default is disabled. true: Add a field to the original log to record the source hostname. Specify the hostname field name using HostnameKey. false: (default) Do not add the hostname field.
|
|
19593
|
+
*/
|
|
19594
|
+
enableHostname: boolean;
|
|
19595
|
+
/**
|
|
19596
|
+
* Upload raw logs. true: Upload raw logs. false (default): Do not upload raw logs.
|
|
19597
|
+
*/
|
|
19598
|
+
enableRawLog: boolean;
|
|
19599
|
+
/**
|
|
19600
|
+
* Add constant fields to logs. Constant fields must follow these restrictions: You can upload up to 5 constant fields. Field names (Key) must be unique and not empty. Length limit: 1–128 characters, including letters, numbers, and special characters (-*./), and cannot start with an underscore. Field values (Value) must not be empty, with a maximum length of 512 KiB.
|
|
19601
|
+
*/
|
|
19602
|
+
fields: outputs.tls.GetRuleUserDefineRuleField[];
|
|
19603
|
+
/**
|
|
19604
|
+
* Field name used to store machine group label information
|
|
19605
|
+
*/
|
|
19606
|
+
hostGroupLabelKey: string;
|
|
19607
|
+
/**
|
|
19608
|
+
* Hostname field name. Required only when EnableHostname is true.
|
|
19609
|
+
*/
|
|
19610
|
+
hostnameKey: string;
|
|
19611
|
+
/**
|
|
19612
|
+
* Ignore log files that have not been updated for a specified period (in hours).
|
|
19613
|
+
*/
|
|
19614
|
+
ignoreOlder: number;
|
|
19615
|
+
/**
|
|
19616
|
+
* Allow multiple log file collections. Empty: Use log file ID (including file inode, device, and checksum of the first N bytes) to uniquely identify the log file. RuleID: Use collection rule ID and log file ID to uniquely identify the log file. TopicIDRuleName: Use log topic ID, collection rule name, and log file ID to uniquely identify the log file.
|
|
19617
|
+
*/
|
|
19618
|
+
multiCollectsType: string;
|
|
19619
|
+
/**
|
|
19620
|
+
* Rule for parsing the collection path. After setting the rule, fields in the collection path are extracted using the specified regular expression and added as metadata to the log data. Note: This parameter is not supported when collecting container standard output.
|
|
19621
|
+
*/
|
|
19622
|
+
parsePathRule: outputs.tls.GetRuleUserDefineRuleParsePathRule;
|
|
19623
|
+
/**
|
|
19624
|
+
* LogCollector plugin configuration. After enabling plugin configuration, you can add one or more LogCollector processor plugins to parse logs with complex or variable structures.
|
|
19625
|
+
*/
|
|
19626
|
+
plugin: outputs.tls.GetRuleUserDefineRulePlugin;
|
|
19627
|
+
/**
|
|
19628
|
+
* Name of the raw log field. Only effective when EnableRawLog is set to true. RawLogKey defaults to **raw**, meaning the original log data will be encapsulated in the **raw** field and uploaded to the log service along with the parsed log data.
|
|
19629
|
+
*/
|
|
19630
|
+
rawLogKey: string;
|
|
19631
|
+
/**
|
|
19632
|
+
* Rules for routing log partitions. If this parameter is not set, logs are written using the default load balancing mode, and packets are written to any available Shard. If this parameter is set, logs are collected using the HashKey routing Shard mode, and the log service writes data to the Shard containing the specified Key value
|
|
19633
|
+
*/
|
|
19634
|
+
shardHashKey: outputs.tls.GetRuleUserDefineRuleShardHashKey;
|
|
19635
|
+
/**
|
|
19636
|
+
* LogCollector collection policy, which specifies whether LogCollector collects incremental logs or full logs. Default is false, meaning full log collection. true: incremental collection. LogCollector only collects newly added content in the file. When new logs are written to monitored log files, LogCollector triggers log collection. For first-time collection, LogCollector automatically determines the collection position based on the incremental threshold TailSizeKb you specify. If the new file size does not exceed the incremental threshold, collection starts from the beginning of the file. If the new file size exceeds the incremental threshold, collection starts from the position at the end of the file minus the incremental threshold, collecting only incremental logs. For subsequent collections, LogCollector determines the collection position based on Checkpoint and continues collecting. false: (default) full collection. LogCollector collects logs from the beginning of each file, including historical log data.
|
|
19637
|
+
*/
|
|
19638
|
+
tailFiles: boolean;
|
|
19639
|
+
/**
|
|
19640
|
+
* Backtracking threshold for incremental collection, in KiB. When LogCollector uses incremental collection, for the first collection of a log file: If the new log file size does not exceed the TailSizeKb value, collection starts from the beginning of the file. If the new log file size exceeds the TailSizeKb value, collection starts from the position that is TailSizeKb from the end of the file.
|
|
19641
|
+
*/
|
|
19642
|
+
tailSizeKb: number;
|
|
19643
|
+
}
|
|
19644
|
+
interface GetRuleUserDefineRuleAdvanced {
|
|
19645
|
+
/**
|
|
19646
|
+
* After reading to the end of the log file, choose whether to release the file handle. Default is false.
|
|
19647
|
+
*/
|
|
19648
|
+
closeEof: boolean;
|
|
19649
|
+
/**
|
|
19650
|
+
* Wait time to release log file handle. If no new logs are written to the log file within the specified time, the handle for that log file is released. Unit: seconds. Range: 1–300 seconds. Default: 60 seconds.
|
|
19651
|
+
*/
|
|
19652
|
+
closeInactive: number;
|
|
19653
|
+
/**
|
|
19654
|
+
* Release the file handle after the log file is removed. Default is false.
|
|
19655
|
+
*/
|
|
19656
|
+
closeRemoved: boolean;
|
|
19657
|
+
/**
|
|
19658
|
+
* Release the file handle after the log file is renamed. Default is false.
|
|
19659
|
+
*/
|
|
19660
|
+
closeRenamed: boolean;
|
|
19661
|
+
/**
|
|
19662
|
+
* Maximum monitoring duration for LogCollector log files, in seconds. The default is 0 seconds, meaning LogCollector does not limit the monitoring duration for log files. Timing starts when LogCollector begins monitoring the log file. Once the specified duration is exceeded, LogCollector immediately releases the file handle and stops monitoring, regardless of whether the log file has been fully read.
|
|
19663
|
+
*/
|
|
19664
|
+
closeTimeout: number;
|
|
19665
|
+
/**
|
|
19666
|
+
* Maximum wait time when LogCollector does not detect a line break, in seconds. The default is 5s. Timing starts when LogCollector begins reading the log file. If no line break is detected within the specified time, LogCollector sends the logs in the buffer. If the file write interval is long, a complete log entry may be split into two parts and written separately. Adjust this parameter based on your log write interval.
|
|
19667
|
+
*/
|
|
19668
|
+
noLineTerminatorEofMaxTime: number;
|
|
19669
|
+
}
|
|
19670
|
+
interface GetRuleUserDefineRuleField {
|
|
19671
|
+
/**
|
|
19672
|
+
* Key.
|
|
19673
|
+
*/
|
|
19674
|
+
key: string;
|
|
19675
|
+
/**
|
|
19676
|
+
* Value.
|
|
19677
|
+
*/
|
|
19678
|
+
val: string;
|
|
19679
|
+
}
|
|
19680
|
+
interface GetRuleUserDefineRuleParsePathRule {
|
|
19681
|
+
/**
|
|
19682
|
+
* Field name list. The log service uses a regular expression (Regex) to parse the path sample (PathSample) into multiple fields. Keys specify the name of each field. You can configure up to 100 field names. Field names cannot be empty or duplicated.
|
|
19683
|
+
*/
|
|
19684
|
+
keys: string[];
|
|
19685
|
+
/**
|
|
19686
|
+
* Sample collection path for actual scenarios. The sample collection path must be an absolute path. Wildcards *, ?, ** are not allowed in the path sample.
|
|
19687
|
+
*/
|
|
19688
|
+
pathSample: string;
|
|
19689
|
+
/**
|
|
19690
|
+
* Regular expression used to extract the path field. Must match the sample collection path, otherwise extraction will fail
|
|
19691
|
+
*/
|
|
19692
|
+
regex: string;
|
|
19693
|
+
}
|
|
19694
|
+
interface GetRuleUserDefineRulePlugin {
|
|
19695
|
+
/**
|
|
19696
|
+
* LogCollector plugin. For the list of supported plugins and parameter descriptions, see LogCollector plugin overview.
|
|
19697
|
+
*/
|
|
19698
|
+
processors: string;
|
|
19699
|
+
}
|
|
19700
|
+
interface GetRuleUserDefineRuleShardHashKey {
|
|
19701
|
+
/**
|
|
19702
|
+
* HashKey of the log group, used to specify the shard to which the current log group will be written. The value range for this parameter is [00000000000000000000000000000000-ffffffffffffffffffffffffffffffff).
|
|
19703
|
+
*/
|
|
19704
|
+
hashKey: string;
|
|
19705
|
+
}
|
|
19706
|
+
interface GetScheduleSqlTaskRequestCycle {
|
|
19707
|
+
/**
|
|
19708
|
+
* Cron expression, with a minimum granularity of minutes, using 24-hour format. For example, 0 18 * * * means execution at 18:00 every day.
|
|
19709
|
+
*/
|
|
19710
|
+
cronTab: string;
|
|
19711
|
+
/**
|
|
19712
|
+
* If Type is set to Cron, you must also set the time zone.
|
|
19713
|
+
*/
|
|
19714
|
+
cronTimeZone: string;
|
|
19715
|
+
/**
|
|
19716
|
+
* Scheduling period or the time point for periodic execution (minutes from 00:00). Range: 1–1440 minutes.
|
|
19717
|
+
*/
|
|
19718
|
+
time: number;
|
|
19719
|
+
/**
|
|
19720
|
+
* Scheduling period type. Options: Period, Fixed, Cron.
|
|
19721
|
+
*/
|
|
19722
|
+
type: string;
|
|
19723
|
+
}
|
|
19724
|
+
interface GetShipperContentInfo {
|
|
19725
|
+
/**
|
|
19726
|
+
* CSV format log content configuration.
|
|
19727
|
+
*/
|
|
19728
|
+
csvInfo: outputs.tls.GetShipperContentInfoCsvInfo;
|
|
19729
|
+
/**
|
|
19730
|
+
* Log content parsing format. Delivery to TOS supports json, jsonl, csv; delivery to Kafka supports original, json.
|
|
19731
|
+
*/
|
|
19732
|
+
format: string;
|
|
19733
|
+
/**
|
|
19734
|
+
* JSON/JSONL format log content configuration.
|
|
19735
|
+
*/
|
|
19736
|
+
jsonInfo: outputs.tls.GetShipperContentInfoJsonInfo;
|
|
19737
|
+
}
|
|
19738
|
+
interface GetShipperContentInfoCsvInfo {
|
|
19739
|
+
/**
|
|
19740
|
+
* Delimiter. Supports comma, tab, pipe, semicolon, space.
|
|
19741
|
+
*/
|
|
19742
|
+
delimiter: string;
|
|
19743
|
+
/**
|
|
19744
|
+
* Escape character. When field content contains a delimiter, use an escape character to enclose it. Supports single quote, double quote, or empty character.
|
|
19745
|
+
*/
|
|
19746
|
+
escapeChar: string;
|
|
19747
|
+
/**
|
|
19748
|
+
* Fields to be delivered. Supports letters, numbers, and _-./. Cannot start with an underscore. Length: 1–128.
|
|
19749
|
+
*/
|
|
19750
|
+
keys: string[];
|
|
19751
|
+
/**
|
|
19752
|
+
* Content for invalid field padding. Length: 0–128.
|
|
17920
19753
|
*/
|
|
17921
|
-
|
|
19754
|
+
nonFieldContent: string;
|
|
17922
19755
|
/**
|
|
17923
|
-
*
|
|
19756
|
+
* Whether to print the key in the first row.
|
|
17924
19757
|
*/
|
|
17925
|
-
|
|
19758
|
+
printHeader: boolean;
|
|
17926
19759
|
}
|
|
17927
|
-
interface
|
|
19760
|
+
interface GetShipperContentInfoJsonInfo {
|
|
17928
19761
|
/**
|
|
17929
|
-
*
|
|
19762
|
+
* Enable flag.
|
|
17930
19763
|
*/
|
|
17931
|
-
|
|
19764
|
+
enable: boolean;
|
|
17932
19765
|
/**
|
|
17933
|
-
*
|
|
19766
|
+
* Whether to enable escaping. Must be set to true.
|
|
17934
19767
|
*/
|
|
17935
|
-
|
|
17936
|
-
}
|
|
17937
|
-
interface GetVolumeTotalPerformance {
|
|
19768
|
+
escape: boolean;
|
|
17938
19769
|
/**
|
|
17939
|
-
*
|
|
19770
|
+
* Delivery field list; if not configured, all fields will be delivered. When delivering in JSON/JSONL format, if this parameter is not set, all fields will be delivered, including **content** (required), **source**, **path**, **time**, **image_name**, **container_name**, **pod_name**, **pod_uid**, namespace, **tag****client_ip**, and **tag****receive_time**.
|
|
17940
19771
|
*/
|
|
17941
|
-
|
|
19772
|
+
keys: string[];
|
|
19773
|
+
}
|
|
19774
|
+
interface GetShipperKafkaShipperInfo {
|
|
17942
19775
|
/**
|
|
17943
|
-
*
|
|
19776
|
+
* Compression format; supports snappy, gzip, lz4, none.
|
|
17944
19777
|
*/
|
|
17945
|
-
|
|
17946
|
-
}
|
|
17947
|
-
interface SnapshotTag {
|
|
19778
|
+
compress: string;
|
|
17948
19779
|
/**
|
|
17949
|
-
*
|
|
19780
|
+
* Delivery end time, in milliseconds. If not set, delivery continues indefinitely. Note: Milliseconds will be truncated. For example, if 1776761323455 is entered, it will become 1776761323000; if 1776761323 is entered, it will become 1776761323000.
|
|
17950
19781
|
*/
|
|
17951
|
-
|
|
19782
|
+
endTime: number;
|
|
17952
19783
|
/**
|
|
17953
|
-
*
|
|
19784
|
+
* Kafka instance.
|
|
17954
19785
|
*/
|
|
17955
|
-
|
|
17956
|
-
}
|
|
17957
|
-
interface VolumeBaselinePerformance {
|
|
19786
|
+
instance: string;
|
|
17958
19787
|
/**
|
|
17959
|
-
*
|
|
19788
|
+
* Kafka topic name. All log data delivered through this configuration will be sent to this topic.
|
|
17960
19789
|
*/
|
|
17961
|
-
|
|
19790
|
+
kafkaTopic: string;
|
|
17962
19791
|
/**
|
|
17963
|
-
*
|
|
19792
|
+
* Start time. If not configured, defaults to the current time. Note: Millisecond data will be ignored. For example, if 1776761323455 is entered, the result will be 1776761323000; if 1776761323 is entered, the result will be 1776761323000.
|
|
17964
19793
|
*/
|
|
17965
|
-
|
|
19794
|
+
startTime: number;
|
|
17966
19795
|
}
|
|
17967
|
-
interface
|
|
19796
|
+
interface GetShipperTosShipperInfo {
|
|
17968
19797
|
/**
|
|
17969
|
-
*
|
|
19798
|
+
* Select a TOS bucket. Must be in the same region as the source log topic. Can only contain numbers, hyphens (-), and letters a–z. Must start and end with a number or letter. Length: 3–63 characters.
|
|
17970
19799
|
*/
|
|
17971
|
-
|
|
19800
|
+
bucket: string;
|
|
17972
19801
|
/**
|
|
17973
|
-
*
|
|
19802
|
+
* Compression format; supports snappy, gzip, lz4, none.
|
|
17974
19803
|
*/
|
|
17975
|
-
|
|
19804
|
+
compress: string;
|
|
17976
19805
|
/**
|
|
17977
|
-
*
|
|
19806
|
+
* Delivery interval in seconds, range: 300–900.
|
|
17978
19807
|
*/
|
|
17979
|
-
|
|
17980
|
-
}
|
|
17981
|
-
interface VolumeTag {
|
|
19808
|
+
interval: number;
|
|
17982
19809
|
/**
|
|
17983
|
-
*
|
|
19810
|
+
* Maximum raw file size per partition for delivery, in MiB. Range: 5–256.
|
|
17984
19811
|
*/
|
|
17985
|
-
|
|
19812
|
+
maxSize: number;
|
|
17986
19813
|
/**
|
|
17987
|
-
*
|
|
19814
|
+
* Partition rule for log delivery. Subdirectory naming format supports strftime syntax. Default: %Y/%m/%d/%H/%M.
|
|
17988
19815
|
*/
|
|
17989
|
-
|
|
19816
|
+
partitionFormat: string;
|
|
19817
|
+
/**
|
|
19818
|
+
* Top-level directory name for the bucket. Cannot start with / or \, and cannot use consecutive /. Cannot use .. as a folder name. Duplicate names are not allowed within the same bucket.
|
|
19819
|
+
*/
|
|
19820
|
+
prefix: string;
|
|
17990
19821
|
}
|
|
17991
|
-
interface
|
|
19822
|
+
interface GetTopicTag {
|
|
17992
19823
|
/**
|
|
17993
|
-
*
|
|
19824
|
+
* User tag key.
|
|
17994
19825
|
*/
|
|
17995
|
-
|
|
19826
|
+
key: string;
|
|
17996
19827
|
/**
|
|
17997
|
-
*
|
|
19828
|
+
* User tag value.
|
|
17998
19829
|
*/
|
|
17999
|
-
|
|
19830
|
+
value: string;
|
|
18000
19831
|
}
|
|
18001
|
-
|
|
18002
|
-
export declare namespace tls {
|
|
18003
|
-
interface GetImportTaskImportSourceInfo {
|
|
19832
|
+
interface ImportTaskImportSourceInfo {
|
|
18004
19833
|
/**
|
|
18005
19834
|
* Kafka data source information. When sourceType is kafka, the KafkaSourceInfo field is required
|
|
18006
19835
|
*/
|
|
18007
|
-
kafkaSourceInfo: outputs.tls.
|
|
19836
|
+
kafkaSourceInfo: outputs.tls.ImportTaskImportSourceInfoKafkaSourceInfo;
|
|
18008
19837
|
/**
|
|
18009
19838
|
* TOS data source information. When sourceType is tos, the TosSourceInfo field is required.
|
|
18010
19839
|
*/
|
|
18011
|
-
tosSourceInfo: outputs.tls.
|
|
19840
|
+
tosSourceInfo: outputs.tls.ImportTaskImportSourceInfoTosSourceInfo;
|
|
18012
19841
|
}
|
|
18013
|
-
interface
|
|
19842
|
+
interface ImportTaskImportSourceInfoKafkaSourceInfo {
|
|
18014
19843
|
/**
|
|
18015
19844
|
* Data encoding format. Available options: UTF-8, GBK.
|
|
18016
19845
|
*/
|
|
@@ -18060,7 +19889,7 @@ export declare namespace tls {
|
|
|
18060
19889
|
*/
|
|
18061
19890
|
username: string;
|
|
18062
19891
|
}
|
|
18063
|
-
interface
|
|
19892
|
+
interface ImportTaskImportSourceInfoTosSourceInfo {
|
|
18064
19893
|
/**
|
|
18065
19894
|
* TOS bucket name
|
|
18066
19895
|
*/
|
|
@@ -18078,11 +19907,11 @@ export declare namespace tls {
|
|
|
18078
19907
|
*/
|
|
18079
19908
|
region: string;
|
|
18080
19909
|
}
|
|
18081
|
-
interface
|
|
19910
|
+
interface ImportTaskTargetInfo {
|
|
18082
19911
|
/**
|
|
18083
19912
|
* Log extraction rule.
|
|
18084
19913
|
*/
|
|
18085
|
-
extractRule: outputs.tls.
|
|
19914
|
+
extractRule: outputs.tls.ImportTaskTargetInfoExtractRule;
|
|
18086
19915
|
/**
|
|
18087
19916
|
* Log sample. When LogType is set to multiline_log, you must configure log samples. It is recommended to provide more than two log entries as examples to ensure the regular expression matches the first line of each log. Use real samples from the production environment.
|
|
18088
19917
|
*/
|
|
@@ -18096,11 +19925,11 @@ export declare namespace tls {
|
|
|
18096
19925
|
*/
|
|
18097
19926
|
region: string;
|
|
18098
19927
|
}
|
|
18099
|
-
interface
|
|
19928
|
+
interface ImportTaskTargetInfoExtractRule {
|
|
18100
19929
|
/**
|
|
18101
19930
|
* Basic content of log extraction rules.
|
|
18102
19931
|
*/
|
|
18103
|
-
extractRule: outputs.tls.
|
|
19932
|
+
extractRule: outputs.tls.ImportTaskTargetInfoExtractRuleExtractRule;
|
|
18104
19933
|
/**
|
|
18105
19934
|
* Number of skipped rows. Only valid when the log type is delimiterLog and the import type is tos.
|
|
18106
19935
|
*/
|
|
@@ -18114,7 +19943,7 @@ export declare namespace tls {
|
|
|
18114
19943
|
*/
|
|
18115
19944
|
timeZone: string;
|
|
18116
19945
|
}
|
|
18117
|
-
interface
|
|
19946
|
+
interface ImportTaskTargetInfoExtractRuleExtractRule {
|
|
18118
19947
|
/**
|
|
18119
19948
|
* Regular expression for identifying the first line of each log. The matched part is treated as the start of the log. When LogType is set to multiline_log, you must configure a log sample
|
|
18120
19949
|
*/
|
|
@@ -18127,10 +19956,7 @@ export declare namespace tls {
|
|
|
18127
19956
|
* Enable nanoseconds.
|
|
18128
19957
|
*/
|
|
18129
19958
|
enableNanosecond: boolean;
|
|
18130
|
-
|
|
18131
|
-
* Filter key regular expression.
|
|
18132
|
-
*/
|
|
18133
|
-
filterKeyRegexes: outputs.tls.GetImportTaskTargetInfoExtractRuleExtractRuleFilterKeyRegex[];
|
|
19959
|
+
filterKeyRegexes: outputs.tls.ImportTaskTargetInfoExtractRuleExtractRuleFilterKeyRegex[];
|
|
18134
19960
|
/**
|
|
18135
19961
|
* List of log field names (Key). Valid only when LogType is delimiter_log. Supports up to 100 field names. Duplicate field names are not allowed, and all field names cannot be left blank
|
|
18136
19962
|
*/
|
|
@@ -18142,7 +19968,7 @@ export declare namespace tls {
|
|
|
18142
19968
|
/**
|
|
18143
19969
|
* Log template.
|
|
18144
19970
|
*/
|
|
18145
|
-
logTemplate: outputs.tls.
|
|
19971
|
+
logTemplate: outputs.tls.ImportTaskTargetInfoExtractRuleExtractRuleLogTemplate;
|
|
18146
19972
|
/**
|
|
18147
19973
|
* Quotation mark. Content enclosed by the quotation mark will not be separated and will be parsed as a complete field. Only valid when LogType is delimiter_log.
|
|
18148
19974
|
*/
|
|
@@ -18168,7 +19994,7 @@ export declare namespace tls {
|
|
|
18168
19994
|
*/
|
|
18169
19995
|
unMatchUpLoadSwitch: boolean;
|
|
18170
19996
|
}
|
|
18171
|
-
interface
|
|
19997
|
+
interface ImportTaskTargetInfoExtractRuleExtractRuleFilterKeyRegex {
|
|
18172
19998
|
/**
|
|
18173
19999
|
* Key.
|
|
18174
20000
|
*/
|
|
@@ -18178,7 +20004,7 @@ export declare namespace tls {
|
|
|
18178
20004
|
*/
|
|
18179
20005
|
regex: string;
|
|
18180
20006
|
}
|
|
18181
|
-
interface
|
|
20007
|
+
interface ImportTaskTargetInfoExtractRuleExtractRuleLogTemplate {
|
|
18182
20008
|
/**
|
|
18183
20009
|
* Format.
|
|
18184
20010
|
*/
|
|
@@ -18188,7 +20014,7 @@ export declare namespace tls {
|
|
|
18188
20014
|
*/
|
|
18189
20015
|
type: string;
|
|
18190
20016
|
}
|
|
18191
|
-
interface
|
|
20017
|
+
interface ImportTaskTaskStatistics {
|
|
18192
20018
|
/**
|
|
18193
20019
|
* Total resource bytes enumerated
|
|
18194
20020
|
*/
|
|
@@ -18222,7 +20048,7 @@ export declare namespace tls {
|
|
|
18222
20048
|
*/
|
|
18223
20049
|
transferred: number;
|
|
18224
20050
|
}
|
|
18225
|
-
interface
|
|
20051
|
+
interface IndexFullText {
|
|
18226
20052
|
/**
|
|
18227
20053
|
* Case sensitivity. true: Case sensitive. false: Not case sensitive.
|
|
18228
20054
|
*/
|
|
@@ -18236,7 +20062,7 @@ export declare namespace tls {
|
|
|
18236
20062
|
*/
|
|
18237
20063
|
includeChinese: boolean;
|
|
18238
20064
|
}
|
|
18239
|
-
interface
|
|
20065
|
+
interface IndexKeyValue {
|
|
18240
20066
|
/**
|
|
18241
20067
|
* Specify the field names for key-value indexing. Up to 100 fields can be added. Only letters, numbers, spaces, underscores (_), hyphens (-), and slashes (/) are supported, and field names cannot start or end with a space. Each key name must be unique within the same index. Length: 1–128 characters. For subfields in JSON-type key-value indexes, use a dot (.) to indicate the hierarchy between JSON fields. For example, if the JSON field 'namelist' contains a text-type subfield 'totalcount' and a JSON-type subfield 'info', and 'info' contains the field 'name', the field names should be configured as 'totalcount' and 'info.name' respectively.
|
|
18242
20068
|
*/
|
|
@@ -18244,9 +20070,9 @@ export declare namespace tls {
|
|
|
18244
20070
|
/**
|
|
18245
20071
|
* Field description information required for configuring key-value indexes.
|
|
18246
20072
|
*/
|
|
18247
|
-
value: outputs.tls.
|
|
20073
|
+
value: outputs.tls.IndexKeyValueValue;
|
|
18248
20074
|
}
|
|
18249
|
-
interface
|
|
20075
|
+
interface IndexKeyValueValue {
|
|
18250
20076
|
/**
|
|
18251
20077
|
* Indicates whether the index was added automatically. true: The index was added automatically. false: The index was not added automatically.
|
|
18252
20078
|
*/
|
|
@@ -18271,10 +20097,7 @@ export declare namespace tls {
|
|
|
18271
20097
|
* Enable automatic indexing and statistics for JSON fields. true: Enable automatic indexing and statistics. false: Disable automatic indexing and statistics.
|
|
18272
20098
|
*/
|
|
18273
20099
|
indexSqlAll: boolean;
|
|
18274
|
-
|
|
18275
|
-
* When ValueType is json, you can configure key-value indexes for JSON subfields using the JsonKeys field, which is an array of KeyValueInfo. Each element in the JsonKeys list is a KeyValueInfo, and you can further nest text, long, and double type subfields. For subfields in JSON key-value indexes, use . to indicate the hierarchy between JSON fields. For example, the JSON field namelist contains a text-type subfield totalcount and a JSON-type info, which itself contains the field name. Each field name should be configured as totalcount and info.name, respectively. The SqlFlag setting for subfield key-value indexes defined in JsonKeys must match their parent field, meaning they must be enabled or disabled together. The default is disabled. Subfields do not support separate settings for Delimiter, CaseSensitive, or IncludeChinese. For text-type fields, CaseSensitive, Delimiter, and IncludeChinese always inherit the parent field settings. This is only set when ValueType is json.
|
|
18276
|
-
*/
|
|
18277
|
-
jsonKeys: outputs.tls.GetIndexKeyValueValueJsonKey[];
|
|
20100
|
+
jsonKeys: outputs.tls.IndexKeyValueValueJsonKey[];
|
|
18278
20101
|
/**
|
|
18279
20102
|
* Whether analysis is enabled for the field. Default is false. After enabling statistical analysis, you can configure token delimiters and whether to include Chinese content.
|
|
18280
20103
|
*/
|
|
@@ -18284,7 +20107,7 @@ export declare namespace tls {
|
|
|
18284
20107
|
*/
|
|
18285
20108
|
valueType: string;
|
|
18286
20109
|
}
|
|
18287
|
-
interface
|
|
20110
|
+
interface IndexKeyValueValueJsonKey {
|
|
18288
20111
|
/**
|
|
18289
20112
|
* Specify the field names for key-value indexing. Up to 100 fields can be added. Only letters, numbers, spaces, underscores (_), hyphens (-), and slashes (/) are supported, and field names cannot start or end with a space. Each key name must be unique within the same index. Length: 1–128 characters. For subfields in JSON-type key-value indexes, use a dot (.) to indicate the hierarchy between JSON fields. For example, if the JSON field 'namelist' contains a text-type subfield 'totalcount' and a JSON-type subfield 'info', and 'info' contains the field 'name', the field names should be configured as 'totalcount' and 'info.name' respectively.
|
|
18290
20113
|
*/
|
|
@@ -18292,9 +20115,9 @@ export declare namespace tls {
|
|
|
18292
20115
|
/**
|
|
18293
20116
|
* Field description information required for configuring key-value indexes.
|
|
18294
20117
|
*/
|
|
18295
|
-
value: outputs.tls.
|
|
20118
|
+
value: outputs.tls.IndexKeyValueValueJsonKeyValue;
|
|
18296
20119
|
}
|
|
18297
|
-
interface
|
|
20120
|
+
interface IndexKeyValueValueJsonKeyValue {
|
|
18298
20121
|
/**
|
|
18299
20122
|
* Indicates whether the index was added automatically. true: The index was added automatically. false: The index was not added automatically.
|
|
18300
20123
|
*/
|
|
@@ -18328,7 +20151,7 @@ export declare namespace tls {
|
|
|
18328
20151
|
*/
|
|
18329
20152
|
valueType: string;
|
|
18330
20153
|
}
|
|
18331
|
-
interface
|
|
20154
|
+
interface IndexUserInnerKeyValue {
|
|
18332
20155
|
/**
|
|
18333
20156
|
* Specify the field names for key-value indexing. Up to 100 fields can be added. Only letters, numbers, spaces, underscores (_), hyphens (-), and slashes (/) are supported, and field names cannot start or end with a space. Each key name must be unique within the same index. Length: 1–128 characters. For subfields in JSON-type key-value indexes, use a dot (.) to indicate the hierarchy between JSON fields. For example, if the JSON field 'namelist' contains a text-type subfield 'totalcount' and a JSON-type subfield 'info', and 'info' contains the field 'name', the field names should be configured as 'totalcount' and 'info.name' respectively.
|
|
18334
20157
|
*/
|
|
@@ -18336,9 +20159,9 @@ export declare namespace tls {
|
|
|
18336
20159
|
/**
|
|
18337
20160
|
* Field description information required for configuring key-value indexes.
|
|
18338
20161
|
*/
|
|
18339
|
-
value: outputs.tls.
|
|
20162
|
+
value: outputs.tls.IndexUserInnerKeyValueValue;
|
|
18340
20163
|
}
|
|
18341
|
-
interface
|
|
20164
|
+
interface IndexUserInnerKeyValueValue {
|
|
18342
20165
|
/**
|
|
18343
20166
|
* Indicates whether the index was added automatically. true: The index was added automatically. false: The index was not added automatically.
|
|
18344
20167
|
*/
|
|
@@ -18363,10 +20186,7 @@ export declare namespace tls {
|
|
|
18363
20186
|
* Enable automatic indexing and statistics for JSON fields. true: Enable automatic indexing and statistics. false: Disable automatic indexing and statistics.
|
|
18364
20187
|
*/
|
|
18365
20188
|
indexSqlAll: boolean;
|
|
18366
|
-
|
|
18367
|
-
* When ValueType is json, you can configure key-value indexes for JSON subfields using the JsonKeys field, which is an array of KeyValueInfo. Each element in the JsonKeys list is a KeyValueInfo, and you can further nest text, long, and double type subfields. For subfields in JSON key-value indexes, use . to indicate the hierarchy between JSON fields. For example, the JSON field namelist contains a text-type subfield totalcount and a JSON-type info, which itself contains the field name. Each field name should be configured as totalcount and info.name, respectively. The SqlFlag setting for subfield key-value indexes defined in JsonKeys must match their parent field, meaning they must be enabled or disabled together. The default is disabled. Subfields do not support separate settings for Delimiter, CaseSensitive, or IncludeChinese. For text-type fields, CaseSensitive, Delimiter, and IncludeChinese always inherit the parent field settings. This is only set when ValueType is json.
|
|
18368
|
-
*/
|
|
18369
|
-
jsonKeys: outputs.tls.GetIndexUserInnerKeyValueValueJsonKey[];
|
|
20189
|
+
jsonKeys: outputs.tls.IndexUserInnerKeyValueValueJsonKey[];
|
|
18370
20190
|
/**
|
|
18371
20191
|
* Whether analysis is enabled for the field. Default is false. After enabling statistical analysis, you can configure token delimiters and whether to include Chinese content.
|
|
18372
20192
|
*/
|
|
@@ -18376,7 +20196,7 @@ export declare namespace tls {
|
|
|
18376
20196
|
*/
|
|
18377
20197
|
valueType: string;
|
|
18378
20198
|
}
|
|
18379
|
-
interface
|
|
20199
|
+
interface IndexUserInnerKeyValueValueJsonKey {
|
|
18380
20200
|
/**
|
|
18381
20201
|
* Specify the field names for key-value indexing. Up to 100 fields can be added. Only letters, numbers, spaces, underscores (_), hyphens (-), and slashes (/) are supported, and field names cannot start or end with a space. Each key name must be unique within the same index. Length: 1–128 characters. For subfields in JSON-type key-value indexes, use a dot (.) to indicate the hierarchy between JSON fields. For example, if the JSON field 'namelist' contains a text-type subfield 'totalcount' and a JSON-type subfield 'info', and 'info' contains the field 'name', the field names should be configured as 'totalcount' and 'info.name' respectively.
|
|
18382
20202
|
*/
|
|
@@ -18384,9 +20204,9 @@ export declare namespace tls {
|
|
|
18384
20204
|
/**
|
|
18385
20205
|
* Field description information required for configuring key-value indexes.
|
|
18386
20206
|
*/
|
|
18387
|
-
value: outputs.tls.
|
|
20207
|
+
value: outputs.tls.IndexUserInnerKeyValueValueJsonKeyValue;
|
|
18388
20208
|
}
|
|
18389
|
-
interface
|
|
20209
|
+
interface IndexUserInnerKeyValueValueJsonKeyValue {
|
|
18390
20210
|
/**
|
|
18391
20211
|
* Indicates whether the index was added automatically. true: The index was added automatically. false: The index was not added automatically.
|
|
18392
20212
|
*/
|
|
@@ -18420,7 +20240,7 @@ export declare namespace tls {
|
|
|
18420
20240
|
*/
|
|
18421
20241
|
valueType: string;
|
|
18422
20242
|
}
|
|
18423
|
-
interface
|
|
20243
|
+
interface ProjectTag {
|
|
18424
20244
|
/**
|
|
18425
20245
|
* Tag key
|
|
18426
20246
|
*/
|
|
@@ -18430,472 +20250,494 @@ export declare namespace tls {
|
|
|
18430
20250
|
*/
|
|
18431
20251
|
value: string;
|
|
18432
20252
|
}
|
|
18433
|
-
interface
|
|
18434
|
-
/**
|
|
18435
|
-
* Cron expression, with a minimum granularity of minutes, using 24-hour format. For example, 0 18 * * * means execution at 18:00 every day.
|
|
18436
|
-
*/
|
|
18437
|
-
cronTab: string;
|
|
20253
|
+
interface RuleContainerRule {
|
|
18438
20254
|
/**
|
|
18439
|
-
* If
|
|
20255
|
+
* Container name to collect. If no container name is specified, all containers in the machine group will be collected. Supports regex matching; for example, setting the container name to ^(container-test)$ will collect all containers named container-test.
|
|
18440
20256
|
*/
|
|
18441
|
-
|
|
20257
|
+
containerNameRegex: string;
|
|
20258
|
+
envTags: outputs.tls.RuleContainerRuleEnvTag[];
|
|
20259
|
+
excludeContainerEnvRegexes: outputs.tls.RuleContainerRuleExcludeContainerEnvRegex[];
|
|
20260
|
+
excludeContainerLabelRegexes: outputs.tls.RuleContainerRuleExcludeContainerLabelRegex[];
|
|
20261
|
+
includeContainerEnvRegexes: outputs.tls.RuleContainerRuleIncludeContainerEnvRegex[];
|
|
20262
|
+
includeContainerLabelRegexes: outputs.tls.RuleContainerRuleIncludeContainerLabelRegex[];
|
|
18442
20263
|
/**
|
|
18443
|
-
*
|
|
20264
|
+
* Kubernetes container collection rules.
|
|
18444
20265
|
*/
|
|
18445
|
-
|
|
20266
|
+
kubernetesRule: outputs.tls.RuleContainerRuleKubernetesRule;
|
|
18446
20267
|
/**
|
|
18447
|
-
*
|
|
20268
|
+
* Collection information. stdout: Collects container standard output (stdout). stderr: Collects container standard error (stderr). all: Collects both container standard output (stdout) and standard error (stderr).
|
|
18448
20269
|
*/
|
|
18449
|
-
|
|
20270
|
+
stream: string;
|
|
18450
20271
|
}
|
|
18451
|
-
interface
|
|
20272
|
+
interface RuleContainerRuleEnvTag {
|
|
18452
20273
|
/**
|
|
18453
|
-
*
|
|
20274
|
+
* Key.
|
|
18454
20275
|
*/
|
|
18455
20276
|
key: string;
|
|
18456
20277
|
/**
|
|
18457
|
-
*
|
|
20278
|
+
* Value.
|
|
18458
20279
|
*/
|
|
18459
|
-
|
|
20280
|
+
val: string;
|
|
18460
20281
|
}
|
|
18461
|
-
interface
|
|
20282
|
+
interface RuleContainerRuleExcludeContainerEnvRegex {
|
|
18462
20283
|
/**
|
|
18463
|
-
*
|
|
20284
|
+
* Key.
|
|
18464
20285
|
*/
|
|
18465
|
-
|
|
20286
|
+
key: string;
|
|
18466
20287
|
/**
|
|
18467
|
-
*
|
|
20288
|
+
* Value.
|
|
18468
20289
|
*/
|
|
18469
|
-
|
|
20290
|
+
val: string;
|
|
18470
20291
|
}
|
|
18471
|
-
interface
|
|
20292
|
+
interface RuleContainerRuleExcludeContainerLabelRegex {
|
|
18472
20293
|
/**
|
|
18473
|
-
*
|
|
20294
|
+
* Key.
|
|
18474
20295
|
*/
|
|
18475
|
-
|
|
20296
|
+
key: string;
|
|
18476
20297
|
/**
|
|
18477
|
-
*
|
|
20298
|
+
* Value.
|
|
18478
20299
|
*/
|
|
18479
|
-
|
|
20300
|
+
val: string;
|
|
20301
|
+
}
|
|
20302
|
+
interface RuleContainerRuleIncludeContainerEnvRegex {
|
|
18480
20303
|
/**
|
|
18481
|
-
*
|
|
20304
|
+
* Key.
|
|
18482
20305
|
*/
|
|
18483
|
-
|
|
20306
|
+
key: string;
|
|
18484
20307
|
/**
|
|
18485
|
-
*
|
|
20308
|
+
* Value.
|
|
18486
20309
|
*/
|
|
18487
|
-
|
|
20310
|
+
val: string;
|
|
20311
|
+
}
|
|
20312
|
+
interface RuleContainerRuleIncludeContainerLabelRegex {
|
|
18488
20313
|
/**
|
|
18489
|
-
*
|
|
20314
|
+
* Key.
|
|
18490
20315
|
*/
|
|
18491
|
-
|
|
20316
|
+
key: string;
|
|
18492
20317
|
/**
|
|
18493
|
-
*
|
|
20318
|
+
* Value.
|
|
18494
20319
|
*/
|
|
18495
|
-
|
|
20320
|
+
val: string;
|
|
20321
|
+
}
|
|
20322
|
+
interface RuleContainerRuleKubernetesRule {
|
|
20323
|
+
annotationTags: outputs.tls.RuleContainerRuleKubernetesRuleAnnotationTag[];
|
|
18496
20324
|
/**
|
|
18497
|
-
*
|
|
20325
|
+
* Whether to add all Kubernetes Labels as log tags to the original log data. When enabled, the log service adds fields for all Labels in the Kubernetes Pod to the logs. For example, if the Pod contains Label source=DC and destination=CS, the logs will include fields **tag**source__: DC and **tag**destination__: CS.
|
|
18498
20326
|
*/
|
|
18499
|
-
|
|
20327
|
+
enableAllLabelTag: boolean;
|
|
20328
|
+
excludePodAnnotationRegexes: outputs.tls.RuleContainerRuleKubernetesRuleExcludePodAnnotationRegex[];
|
|
20329
|
+
excludePodLabelRegexes: outputs.tls.RuleContainerRuleKubernetesRuleExcludePodLabelRegex[];
|
|
20330
|
+
includePodAnnotationRegexes: outputs.tls.RuleContainerRuleKubernetesRuleIncludePodAnnotationRegex[];
|
|
20331
|
+
includePodLabelRegexes: outputs.tls.RuleContainerRuleKubernetesRuleIncludePodLabelRegex[];
|
|
20332
|
+
labelTags: outputs.tls.RuleContainerRuleKubernetesRuleLabelTag[];
|
|
18500
20333
|
/**
|
|
18501
|
-
*
|
|
20334
|
+
* Name of the Kubernetes Namespace to collect. If no Namespace name is specified, all containers will be collected. Namespace names support regular expression matching. For example, if you set the Namespace name to ^(tcp|udp)$, it will collect all containers under the tcp and udp namespaces.
|
|
18502
20335
|
*/
|
|
18503
|
-
|
|
20336
|
+
namespaceNameRegex: string;
|
|
18504
20337
|
/**
|
|
18505
|
-
*
|
|
20338
|
+
* Pod name is used to specify the Pod whose containers will be collected. If no Pod name is specified, all containers will be collected. Pod name supports regular expression matching. For example, setting the Pod name to ^(http.*)$ collects all containers under Pods whose names start with http.
|
|
18506
20339
|
*/
|
|
18507
|
-
|
|
20340
|
+
podNameRegex: string;
|
|
18508
20341
|
/**
|
|
18509
|
-
* Specify
|
|
20342
|
+
* Specify the container to collect by workload name. If no workload name is specified, all containers are collected. Workload names support regular expressions. For example, setting the workload name to ^(http.*)$ collects all containers under workloads starting with http.
|
|
18510
20343
|
*/
|
|
18511
|
-
|
|
20344
|
+
workloadNameRegex: string;
|
|
18512
20345
|
/**
|
|
18513
|
-
*
|
|
20346
|
+
* Specify the container to collect by workload type. Only one type can be selected. If no type is specified, containers of all types will be collected. Supported workload types: Deployment: stateless workload StatefulSet: stateful workload DaemonSet: daemon process Job: task CronJob: scheduled task
|
|
18514
20347
|
*/
|
|
18515
|
-
|
|
20348
|
+
workloadType: string;
|
|
20349
|
+
}
|
|
20350
|
+
interface RuleContainerRuleKubernetesRuleAnnotationTag {
|
|
18516
20351
|
/**
|
|
18517
|
-
*
|
|
20352
|
+
* Key.
|
|
18518
20353
|
*/
|
|
18519
|
-
|
|
20354
|
+
key: string;
|
|
20355
|
+
/**
|
|
20356
|
+
* Value.
|
|
20357
|
+
*/
|
|
20358
|
+
val: string;
|
|
18520
20359
|
}
|
|
18521
|
-
interface
|
|
20360
|
+
interface RuleContainerRuleKubernetesRuleExcludePodAnnotationRegex {
|
|
18522
20361
|
/**
|
|
18523
|
-
*
|
|
20362
|
+
* Key.
|
|
18524
20363
|
*/
|
|
18525
|
-
|
|
20364
|
+
key: string;
|
|
18526
20365
|
/**
|
|
18527
|
-
*
|
|
20366
|
+
* Value.
|
|
18528
20367
|
*/
|
|
18529
|
-
|
|
20368
|
+
val: string;
|
|
20369
|
+
}
|
|
20370
|
+
interface RuleContainerRuleKubernetesRuleExcludePodLabelRegex {
|
|
18530
20371
|
/**
|
|
18531
|
-
*
|
|
20372
|
+
* Key.
|
|
18532
20373
|
*/
|
|
18533
|
-
|
|
20374
|
+
key: string;
|
|
18534
20375
|
/**
|
|
18535
|
-
*
|
|
20376
|
+
* Value.
|
|
18536
20377
|
*/
|
|
18537
|
-
|
|
20378
|
+
val: string;
|
|
18538
20379
|
}
|
|
18539
|
-
interface
|
|
20380
|
+
interface RuleContainerRuleKubernetesRuleIncludePodAnnotationRegex {
|
|
18540
20381
|
/**
|
|
18541
|
-
*
|
|
20382
|
+
* Key.
|
|
18542
20383
|
*/
|
|
18543
|
-
|
|
20384
|
+
key: string;
|
|
18544
20385
|
/**
|
|
18545
|
-
*
|
|
20386
|
+
* Value.
|
|
18546
20387
|
*/
|
|
18547
|
-
|
|
20388
|
+
val: string;
|
|
20389
|
+
}
|
|
20390
|
+
interface RuleContainerRuleKubernetesRuleIncludePodLabelRegex {
|
|
18548
20391
|
/**
|
|
18549
|
-
*
|
|
20392
|
+
* Key.
|
|
18550
20393
|
*/
|
|
18551
|
-
|
|
20394
|
+
key: string;
|
|
18552
20395
|
/**
|
|
18553
|
-
*
|
|
20396
|
+
* Value.
|
|
18554
20397
|
*/
|
|
18555
|
-
|
|
20398
|
+
val: string;
|
|
18556
20399
|
}
|
|
18557
|
-
interface
|
|
20400
|
+
interface RuleContainerRuleKubernetesRuleLabelTag {
|
|
18558
20401
|
/**
|
|
18559
|
-
*
|
|
20402
|
+
* Key.
|
|
18560
20403
|
*/
|
|
18561
|
-
|
|
20404
|
+
key: string;
|
|
18562
20405
|
/**
|
|
18563
|
-
*
|
|
20406
|
+
* Value.
|
|
18564
20407
|
*/
|
|
18565
|
-
|
|
20408
|
+
val: string;
|
|
20409
|
+
}
|
|
20410
|
+
interface RuleExcludePath {
|
|
18566
20411
|
/**
|
|
18567
|
-
*
|
|
20412
|
+
* Collection path type. File: File name. Path: Directory.
|
|
18568
20413
|
*/
|
|
18569
|
-
|
|
20414
|
+
type: string;
|
|
18570
20415
|
/**
|
|
18571
|
-
*
|
|
20416
|
+
* Collection path. Must be specified as an absolute path. When Type is Path, Value indicates a directory. When Type is File, Value indicates a file name.
|
|
18572
20417
|
*/
|
|
18573
|
-
|
|
20418
|
+
value: string;
|
|
18574
20419
|
}
|
|
18575
|
-
interface
|
|
20420
|
+
interface RuleExtractRule {
|
|
18576
20421
|
/**
|
|
18577
|
-
* Regular expression
|
|
20422
|
+
* Regular expression that the first line of the log must match. Valid only when LogType is multiline*log or fullregex*log. Must be a valid regular expression.
|
|
18578
20423
|
*/
|
|
18579
20424
|
beginRegex: string;
|
|
18580
20425
|
/**
|
|
18581
|
-
*
|
|
20426
|
+
* Log delimiter. Valid only when LogType is delimiter_log.
|
|
18582
20427
|
*/
|
|
18583
20428
|
delimiter: string;
|
|
18584
20429
|
/**
|
|
18585
|
-
* Enable
|
|
20430
|
+
* Enable nanosecond precision time. When enabled, log time parsing will include and report nanosecond precision. true: Enable nanosecond precision time. false: Disable nanosecond precision time.
|
|
18586
20431
|
*/
|
|
18587
20432
|
enableNanosecond: boolean;
|
|
18588
|
-
filterKeyRegexes: outputs.tls.
|
|
20433
|
+
filterKeyRegexes: outputs.tls.RuleExtractRuleFilterKeyRegex[];
|
|
18589
20434
|
/**
|
|
18590
|
-
* List of log field names (Key).
|
|
20435
|
+
* List of log field names (Key). This is only valid when LogType is delimiter*log or fullregex*log. You can configure up to 100 field names. When LogType is delimiter*log, field names must be unique and cannot all be empty. When LogType is fullregex*log, field names must be unique and cannot be empty.
|
|
18591
20436
|
*/
|
|
18592
20437
|
keys: string[];
|
|
18593
20438
|
/**
|
|
18594
|
-
*
|
|
20439
|
+
* The entire log must match the specified regular expression. This is only valid when the collected log type is fullregex_log. Must be a valid regular expression.
|
|
18595
20440
|
*/
|
|
18596
20441
|
logRegex: string;
|
|
18597
20442
|
/**
|
|
18598
|
-
*
|
|
20443
|
+
* Automatically extract log fields based on the specified log template
|
|
18599
20444
|
*/
|
|
18600
|
-
logTemplate: outputs.tls.
|
|
20445
|
+
logTemplate: outputs.tls.RuleExtractRuleLogTemplate;
|
|
18601
20446
|
/**
|
|
18602
|
-
*
|
|
20447
|
+
* Quoting character. Content wrapped by a quoting character will not be split but parsed as a complete field. Only valid when LogType is delimiter_log.
|
|
18603
20448
|
*/
|
|
18604
20449
|
quote: string;
|
|
18605
20450
|
/**
|
|
18606
|
-
*
|
|
20451
|
+
* Regular expression for extracting time, used to extract the time value from the TimeKey field and parse it as the collection time
|
|
20452
|
+
*/
|
|
20453
|
+
timeExtractRegex: string;
|
|
20454
|
+
/**
|
|
20455
|
+
* Parsing format for the time field. If you use a specific time field in the log as the log timestamp, you must provide both TimeKey and TimeFormat. TimeKey and TimeFormat must be used together.
|
|
18607
20456
|
*/
|
|
18608
20457
|
timeFormat: string;
|
|
18609
20458
|
/**
|
|
18610
|
-
* Name of the log time field. If you use a specific time field in the log as the log timestamp, you
|
|
20459
|
+
* Name of the log time field. If you want to use a specific time field in the log as the log timestamp, you need to specify both TimeKey and TimeFormat. TimeKey and TimeFormat must be provided together.
|
|
18611
20460
|
*/
|
|
18612
20461
|
timeKey: string;
|
|
18613
20462
|
/**
|
|
18614
|
-
* Time sample. Used to
|
|
20463
|
+
* Time sample. Used to check whether the entered time parsing format is correct.
|
|
20464
|
+
*/
|
|
20465
|
+
timeSample: string;
|
|
20466
|
+
/**
|
|
20467
|
+
* Time zone. Supports machine time zone (default) and custom time zone. Custom time zone supports GMT and UTC. GMT format: GMT+08:00. UTC format: Asia/Shanghai.
|
|
18615
20468
|
*/
|
|
18616
|
-
|
|
20469
|
+
timeZone: string;
|
|
18617
20470
|
/**
|
|
18618
|
-
*
|
|
20471
|
+
* Key name for unmatched logs.
|
|
18619
20472
|
*/
|
|
18620
20473
|
unMatchLogKey: string;
|
|
18621
20474
|
/**
|
|
18622
|
-
*
|
|
20475
|
+
* Switch for uploading unmatched logs.
|
|
18623
20476
|
*/
|
|
18624
20477
|
unMatchUpLoadSwitch: boolean;
|
|
18625
20478
|
}
|
|
18626
|
-
interface
|
|
20479
|
+
interface RuleExtractRuleFilterKeyRegex {
|
|
18627
20480
|
/**
|
|
18628
|
-
*
|
|
20481
|
+
* Name of the filter field.
|
|
18629
20482
|
*/
|
|
18630
20483
|
key: string;
|
|
18631
20484
|
/**
|
|
18632
|
-
*
|
|
20485
|
+
* The log content of the filter field must match the specified regular expression.
|
|
18633
20486
|
*/
|
|
18634
20487
|
regex: string;
|
|
18635
20488
|
}
|
|
18636
|
-
interface
|
|
20489
|
+
interface RuleExtractRuleLogTemplate {
|
|
18637
20490
|
/**
|
|
18638
|
-
*
|
|
20491
|
+
* Log template format.
|
|
18639
20492
|
*/
|
|
18640
20493
|
format: string;
|
|
18641
20494
|
/**
|
|
18642
|
-
*
|
|
20495
|
+
* Log template types. Supported types: Nginx: Nginx log template.
|
|
18643
20496
|
*/
|
|
18644
20497
|
type: string;
|
|
18645
20498
|
}
|
|
18646
|
-
interface
|
|
20499
|
+
interface RuleHostGroupInfo {
|
|
18647
20500
|
/**
|
|
18648
|
-
*
|
|
20501
|
+
* Machine group ID
|
|
18649
20502
|
*/
|
|
18650
|
-
|
|
20503
|
+
hostGroupId: string;
|
|
20504
|
+
}
|
|
20505
|
+
interface RuleUserDefineRule {
|
|
18651
20506
|
/**
|
|
18652
|
-
*
|
|
20507
|
+
* The Advanced parameter is used for extended configuration. After enabling extended configuration, you can customize advanced behaviors of LogCollector, such as when to release file handles. Note: If multiple release conditions are specified, the handle is released and log file monitoring ends as soon as any condition is met.
|
|
18653
20508
|
*/
|
|
18654
|
-
|
|
20509
|
+
advanced: outputs.tls.RuleUserDefineRuleAdvanced;
|
|
18655
20510
|
/**
|
|
18656
|
-
*
|
|
20511
|
+
* Whether to upload the label information of the host group to the log service. The default is off. true: LogCollector uploads the label information of the host group to the specified field. You can specify the field name in the HostGroupLabelKey parameter. false (default): Host group label information is not uploaded.
|
|
18657
20512
|
*/
|
|
18658
|
-
|
|
20513
|
+
enableHostGroupLabel: boolean;
|
|
18659
20514
|
/**
|
|
18660
|
-
*
|
|
20515
|
+
* Upload the hostname field. Default is disabled. true: Add a field to the original log to record the source hostname. Specify the hostname field name using HostnameKey. false: (default) Do not add the hostname field.
|
|
18661
20516
|
*/
|
|
18662
|
-
|
|
20517
|
+
enableHostname: boolean;
|
|
18663
20518
|
/**
|
|
18664
|
-
*
|
|
20519
|
+
* Upload raw logs. true: Upload raw logs. false (default): Do not upload raw logs.
|
|
18665
20520
|
*/
|
|
18666
|
-
|
|
20521
|
+
enableRawLog: boolean;
|
|
20522
|
+
fields: outputs.tls.RuleUserDefineRuleField[];
|
|
18667
20523
|
/**
|
|
18668
|
-
*
|
|
20524
|
+
* Field name used to store machine group label information
|
|
18669
20525
|
*/
|
|
18670
|
-
|
|
20526
|
+
hostGroupLabelKey: string;
|
|
18671
20527
|
/**
|
|
18672
|
-
*
|
|
20528
|
+
* Hostname field name. Required only when EnableHostname is true.
|
|
18673
20529
|
*/
|
|
18674
|
-
|
|
20530
|
+
hostnameKey: string;
|
|
18675
20531
|
/**
|
|
18676
|
-
*
|
|
20532
|
+
* Ignore log files that have not been updated for a specified period (in hours).
|
|
18677
20533
|
*/
|
|
18678
|
-
|
|
18679
|
-
}
|
|
18680
|
-
interface IndexFullText {
|
|
20534
|
+
ignoreOlder: number;
|
|
18681
20535
|
/**
|
|
18682
|
-
*
|
|
20536
|
+
* Allow multiple log file collections. Empty: Use log file ID (including file inode, device, and checksum of the first N bytes) to uniquely identify the log file. RuleID: Use collection rule ID and log file ID to uniquely identify the log file. TopicIDRuleName: Use log topic ID, collection rule name, and log file ID to uniquely identify the log file.
|
|
18683
20537
|
*/
|
|
18684
|
-
|
|
20538
|
+
multiCollectsType: string;
|
|
18685
20539
|
/**
|
|
18686
|
-
*
|
|
20540
|
+
* Rule for parsing the collection path. After setting the rule, fields in the collection path are extracted using the specified regular expression and added as metadata to the log data. Note: This parameter is not supported when collecting container standard output.
|
|
18687
20541
|
*/
|
|
18688
|
-
|
|
20542
|
+
parsePathRule: outputs.tls.RuleUserDefineRuleParsePathRule;
|
|
18689
20543
|
/**
|
|
18690
|
-
*
|
|
20544
|
+
* LogCollector plugin configuration. After enabling plugin configuration, you can add one or more LogCollector processor plugins to parse logs with complex or variable structures.
|
|
18691
20545
|
*/
|
|
18692
|
-
|
|
18693
|
-
}
|
|
18694
|
-
interface IndexKeyValue {
|
|
20546
|
+
plugin: outputs.tls.RuleUserDefineRulePlugin;
|
|
18695
20547
|
/**
|
|
18696
|
-
*
|
|
20548
|
+
* Name of the raw log field. Only effective when EnableRawLog is set to true. RawLogKey defaults to **raw**, meaning the original log data will be encapsulated in the **raw** field and uploaded to the log service along with the parsed log data.
|
|
18697
20549
|
*/
|
|
18698
|
-
|
|
20550
|
+
rawLogKey: string;
|
|
18699
20551
|
/**
|
|
18700
|
-
*
|
|
20552
|
+
* Rules for routing log partitions. If this parameter is not set, logs are written using the default load balancing mode, and packets are written to any available Shard. If this parameter is set, logs are collected using the HashKey routing Shard mode, and the log service writes data to the Shard containing the specified Key value
|
|
18701
20553
|
*/
|
|
18702
|
-
|
|
18703
|
-
}
|
|
18704
|
-
interface IndexKeyValueValue {
|
|
20554
|
+
shardHashKey: outputs.tls.RuleUserDefineRuleShardHashKey;
|
|
18705
20555
|
/**
|
|
18706
|
-
*
|
|
20556
|
+
* LogCollector collection policy, which specifies whether LogCollector collects incremental logs or full logs. Default is false, meaning full log collection. true: incremental collection. LogCollector only collects newly added content in the file. When new logs are written to monitored log files, LogCollector triggers log collection. For first-time collection, LogCollector automatically determines the collection position based on the incremental threshold TailSizeKb you specify. If the new file size does not exceed the incremental threshold, collection starts from the beginning of the file. If the new file size exceeds the incremental threshold, collection starts from the position at the end of the file minus the incremental threshold, collecting only incremental logs. For subsequent collections, LogCollector determines the collection position based on Checkpoint and continues collecting. false: (default) full collection. LogCollector collects logs from the beginning of each file, including historical log data.
|
|
18707
20557
|
*/
|
|
18708
|
-
|
|
20558
|
+
tailFiles: boolean;
|
|
18709
20559
|
/**
|
|
18710
|
-
*
|
|
20560
|
+
* Backtracking threshold for incremental collection, in KiB. When LogCollector uses incremental collection, for the first collection of a log file: If the new log file size does not exceed the TailSizeKb value, collection starts from the beginning of the file. If the new log file size exceeds the TailSizeKb value, collection starts from the position that is TailSizeKb from the end of the file.
|
|
18711
20561
|
*/
|
|
18712
|
-
|
|
20562
|
+
tailSizeKb: number;
|
|
20563
|
+
}
|
|
20564
|
+
interface RuleUserDefineRuleAdvanced {
|
|
18713
20565
|
/**
|
|
18714
|
-
*
|
|
20566
|
+
* After reading to the end of the log file, choose whether to release the file handle. Default is false.
|
|
18715
20567
|
*/
|
|
18716
|
-
|
|
20568
|
+
closeEof: boolean;
|
|
18717
20569
|
/**
|
|
18718
|
-
*
|
|
20570
|
+
* Wait time to release log file handle. If no new logs are written to the log file within the specified time, the handle for that log file is released. Unit: seconds. Range: 1–300 seconds. Default: 60 seconds.
|
|
18719
20571
|
*/
|
|
18720
|
-
|
|
20572
|
+
closeInactive: number;
|
|
18721
20573
|
/**
|
|
18722
|
-
*
|
|
20574
|
+
* Release the file handle after the log file is removed. Default is false.
|
|
18723
20575
|
*/
|
|
18724
|
-
|
|
20576
|
+
closeRemoved: boolean;
|
|
18725
20577
|
/**
|
|
18726
|
-
*
|
|
20578
|
+
* Release the file handle after the log file is renamed. Default is false.
|
|
18727
20579
|
*/
|
|
18728
|
-
|
|
18729
|
-
jsonKeys: outputs.tls.IndexKeyValueValueJsonKey[];
|
|
20580
|
+
closeRenamed: boolean;
|
|
18730
20581
|
/**
|
|
18731
|
-
*
|
|
20582
|
+
* Maximum monitoring duration for LogCollector log files, in seconds. The default is 0 seconds, meaning LogCollector does not limit the monitoring duration for log files. Timing starts when LogCollector begins monitoring the log file. Once the specified duration is exceeded, LogCollector immediately releases the file handle and stops monitoring, regardless of whether the log file has been fully read.
|
|
18732
20583
|
*/
|
|
18733
|
-
|
|
20584
|
+
closeTimeout: number;
|
|
18734
20585
|
/**
|
|
18735
|
-
*
|
|
20586
|
+
* Maximum wait time when LogCollector does not detect a line break, in seconds. The default is 5s. Timing starts when LogCollector begins reading the log file. If no line break is detected within the specified time, LogCollector sends the logs in the buffer. If the file write interval is long, a complete log entry may be split into two parts and written separately. Adjust this parameter based on your log write interval.
|
|
18736
20587
|
*/
|
|
18737
|
-
|
|
20588
|
+
noLineTerminatorEofMaxTime: number;
|
|
18738
20589
|
}
|
|
18739
|
-
interface
|
|
20590
|
+
interface RuleUserDefineRuleField {
|
|
18740
20591
|
/**
|
|
18741
|
-
*
|
|
20592
|
+
* Key.
|
|
18742
20593
|
*/
|
|
18743
20594
|
key: string;
|
|
18744
20595
|
/**
|
|
18745
|
-
*
|
|
20596
|
+
* Value.
|
|
18746
20597
|
*/
|
|
18747
|
-
|
|
20598
|
+
val: string;
|
|
18748
20599
|
}
|
|
18749
|
-
interface
|
|
18750
|
-
/**
|
|
18751
|
-
* Indicates whether the index was added automatically. true: The index was added automatically. false: The index was not added automatically.
|
|
18752
|
-
*/
|
|
18753
|
-
autoIndexFlag: boolean;
|
|
18754
|
-
/**
|
|
18755
|
-
* Whether to distinguish case. Default is false.
|
|
18756
|
-
*/
|
|
18757
|
-
caseSensitive: boolean;
|
|
18758
|
-
/**
|
|
18759
|
-
* Token separators for the field. Default is empty (""). Each character in the string represents a token separator. Length: 0–256 bytes. If the length is 0, segmentation is disabled. Only one or more of the following characters are supported: letters, numbers, and !@#%^&*()-_=\\"', <>/?|;:\ \r[]{}. . Supports configuring both Chinese characters and token separators simultaneously.
|
|
18760
|
-
*/
|
|
18761
|
-
delimiter: string;
|
|
20600
|
+
interface RuleUserDefineRuleParsePathRule {
|
|
18762
20601
|
/**
|
|
18763
|
-
*
|
|
20602
|
+
* Field name list. The log service uses a regular expression (Regex) to parse the path sample (PathSample) into multiple fields. Keys specify the name of each field. You can configure up to 100 field names. Field names cannot be empty or duplicated.
|
|
18764
20603
|
*/
|
|
18765
|
-
|
|
20604
|
+
keys: string[];
|
|
18766
20605
|
/**
|
|
18767
|
-
*
|
|
20606
|
+
* Sample collection path for actual scenarios. The sample collection path must be an absolute path. Wildcards *, ?, ** are not allowed in the path sample.
|
|
18768
20607
|
*/
|
|
18769
|
-
|
|
20608
|
+
pathSample: string;
|
|
18770
20609
|
/**
|
|
18771
|
-
*
|
|
20610
|
+
* Regular expression used to extract the path field. Must match the sample collection path, otherwise extraction will fail
|
|
18772
20611
|
*/
|
|
18773
|
-
|
|
20612
|
+
regex: string;
|
|
20613
|
+
}
|
|
20614
|
+
interface RuleUserDefineRulePlugin {
|
|
18774
20615
|
/**
|
|
18775
|
-
*
|
|
20616
|
+
* LogCollector plugin. For the list of supported plugins and parameter descriptions, see LogCollector plugin overview.
|
|
18776
20617
|
*/
|
|
18777
|
-
|
|
20618
|
+
processors: string;
|
|
20619
|
+
}
|
|
20620
|
+
interface RuleUserDefineRuleShardHashKey {
|
|
18778
20621
|
/**
|
|
18779
|
-
*
|
|
20622
|
+
* HashKey of the log group, used to specify the shard to which the current log group will be written. The value range for this parameter is [00000000000000000000000000000000-ffffffffffffffffffffffffffffffff).
|
|
18780
20623
|
*/
|
|
18781
|
-
|
|
20624
|
+
hashKey: string;
|
|
18782
20625
|
}
|
|
18783
|
-
interface
|
|
20626
|
+
interface ScheduleSqlTaskRequestCycle {
|
|
18784
20627
|
/**
|
|
18785
|
-
*
|
|
20628
|
+
* Cron expression, with a minimum granularity of minutes, using 24-hour format. For example, 0 18 * * * means execution at 18:00 every day.
|
|
18786
20629
|
*/
|
|
18787
|
-
|
|
20630
|
+
cronTab: string;
|
|
18788
20631
|
/**
|
|
18789
|
-
*
|
|
20632
|
+
* If Type is set to Cron, you must also set the time zone.
|
|
18790
20633
|
*/
|
|
18791
|
-
|
|
18792
|
-
}
|
|
18793
|
-
interface IndexUserInnerKeyValueValue {
|
|
20634
|
+
cronTimeZone: string;
|
|
18794
20635
|
/**
|
|
18795
|
-
*
|
|
20636
|
+
* Scheduling period or the time point for periodic execution (minutes from 00:00). Range: 1–1440 minutes.
|
|
18796
20637
|
*/
|
|
18797
|
-
|
|
20638
|
+
time: number;
|
|
18798
20639
|
/**
|
|
18799
|
-
*
|
|
20640
|
+
* Scheduling period type. Options: Period, Fixed, Cron.
|
|
18800
20641
|
*/
|
|
18801
|
-
|
|
20642
|
+
type: string;
|
|
20643
|
+
}
|
|
20644
|
+
interface ShipperContentInfo {
|
|
18802
20645
|
/**
|
|
18803
|
-
*
|
|
20646
|
+
* CSV format log content configuration.
|
|
18804
20647
|
*/
|
|
18805
|
-
|
|
20648
|
+
csvInfo: outputs.tls.ShipperContentInfoCsvInfo;
|
|
18806
20649
|
/**
|
|
18807
|
-
*
|
|
20650
|
+
* Log content parsing format. Delivery to TOS supports json, jsonl, csv; delivery to Kafka supports original, json.
|
|
18808
20651
|
*/
|
|
18809
|
-
|
|
20652
|
+
format: string;
|
|
18810
20653
|
/**
|
|
18811
|
-
*
|
|
20654
|
+
* JSON/JSONL format log content configuration.
|
|
18812
20655
|
*/
|
|
18813
|
-
|
|
20656
|
+
jsonInfo: outputs.tls.ShipperContentInfoJsonInfo;
|
|
20657
|
+
}
|
|
20658
|
+
interface ShipperContentInfoCsvInfo {
|
|
18814
20659
|
/**
|
|
18815
|
-
*
|
|
20660
|
+
* Delimiter. Supports comma, tab, pipe, semicolon, space.
|
|
18816
20661
|
*/
|
|
18817
|
-
|
|
18818
|
-
jsonKeys: outputs.tls.IndexUserInnerKeyValueValueJsonKey[];
|
|
20662
|
+
delimiter: string;
|
|
18819
20663
|
/**
|
|
18820
|
-
*
|
|
20664
|
+
* Escape character. When field content contains a delimiter, use an escape character to enclose it. Supports single quote, double quote, or empty character.
|
|
18821
20665
|
*/
|
|
18822
|
-
|
|
20666
|
+
escapeChar: string;
|
|
18823
20667
|
/**
|
|
18824
|
-
*
|
|
20668
|
+
* Fields to be delivered. Supports letters, numbers, and _-./. Cannot start with an underscore. Length: 1–128.
|
|
18825
20669
|
*/
|
|
18826
|
-
|
|
18827
|
-
}
|
|
18828
|
-
interface IndexUserInnerKeyValueValueJsonKey {
|
|
20670
|
+
keys: string[];
|
|
18829
20671
|
/**
|
|
18830
|
-
*
|
|
20672
|
+
* Content for invalid field padding. Length: 0–128.
|
|
18831
20673
|
*/
|
|
18832
|
-
|
|
20674
|
+
nonFieldContent: string;
|
|
18833
20675
|
/**
|
|
18834
|
-
*
|
|
20676
|
+
* Whether to print the key in the first row.
|
|
18835
20677
|
*/
|
|
18836
|
-
|
|
20678
|
+
printHeader: boolean;
|
|
18837
20679
|
}
|
|
18838
|
-
interface
|
|
20680
|
+
interface ShipperContentInfoJsonInfo {
|
|
18839
20681
|
/**
|
|
18840
|
-
*
|
|
20682
|
+
* Enable flag.
|
|
18841
20683
|
*/
|
|
18842
|
-
|
|
20684
|
+
enable: boolean;
|
|
18843
20685
|
/**
|
|
18844
|
-
* Whether to
|
|
20686
|
+
* Whether to enable escaping. Must be set to true.
|
|
18845
20687
|
*/
|
|
18846
|
-
|
|
20688
|
+
escape: boolean;
|
|
18847
20689
|
/**
|
|
18848
|
-
*
|
|
20690
|
+
* Delivery field list; if not configured, all fields will be delivered. When delivering in JSON/JSONL format, if this parameter is not set, all fields will be delivered, including **content** (required), **source**, **path**, **time**, **image_name**, **container_name**, **pod_name**, **pod_uid**, namespace, **tag****client_ip**, and **tag****receive_time**.
|
|
18849
20691
|
*/
|
|
18850
|
-
|
|
20692
|
+
keys: string[];
|
|
20693
|
+
}
|
|
20694
|
+
interface ShipperKafkaShipperInfo {
|
|
18851
20695
|
/**
|
|
18852
|
-
*
|
|
20696
|
+
* Compression format; supports snappy, gzip, lz4, none.
|
|
18853
20697
|
*/
|
|
18854
|
-
|
|
20698
|
+
compress: string;
|
|
18855
20699
|
/**
|
|
18856
|
-
*
|
|
20700
|
+
* Delivery end time, in milliseconds. If not set, delivery continues indefinitely. Note: Milliseconds will be truncated. For example, if 1776761323455 is entered, it will become 1776761323000; if 1776761323 is entered, it will become 1776761323000.
|
|
18857
20701
|
*/
|
|
18858
|
-
|
|
20702
|
+
endTime: number;
|
|
18859
20703
|
/**
|
|
18860
|
-
*
|
|
20704
|
+
* Kafka instance.
|
|
18861
20705
|
*/
|
|
18862
|
-
|
|
20706
|
+
instance: string;
|
|
18863
20707
|
/**
|
|
18864
|
-
*
|
|
20708
|
+
* Kafka topic name. All log data delivered through this configuration will be sent to this topic.
|
|
18865
20709
|
*/
|
|
18866
|
-
|
|
20710
|
+
kafkaTopic: string;
|
|
18867
20711
|
/**
|
|
18868
|
-
*
|
|
20712
|
+
* Start time. If not configured, defaults to the current time. Note: Millisecond data will be ignored. For example, if 1776761323455 is entered, the result will be 1776761323000; if 1776761323 is entered, the result will be 1776761323000.
|
|
18869
20713
|
*/
|
|
18870
|
-
|
|
20714
|
+
startTime: number;
|
|
18871
20715
|
}
|
|
18872
|
-
interface
|
|
20716
|
+
interface ShipperTosShipperInfo {
|
|
18873
20717
|
/**
|
|
18874
|
-
*
|
|
20718
|
+
* Select a TOS bucket. Must be in the same region as the source log topic. Can only contain numbers, hyphens (-), and letters a–z. Must start and end with a number or letter. Length: 3–63 characters.
|
|
18875
20719
|
*/
|
|
18876
|
-
|
|
20720
|
+
bucket: string;
|
|
18877
20721
|
/**
|
|
18878
|
-
*
|
|
20722
|
+
* Compression format; supports snappy, gzip, lz4, none.
|
|
18879
20723
|
*/
|
|
18880
|
-
|
|
18881
|
-
}
|
|
18882
|
-
interface ScheduleSqlTaskRequestCycle {
|
|
20724
|
+
compress: string;
|
|
18883
20725
|
/**
|
|
18884
|
-
*
|
|
20726
|
+
* Delivery interval in seconds, range: 300–900.
|
|
18885
20727
|
*/
|
|
18886
|
-
|
|
20728
|
+
interval: number;
|
|
18887
20729
|
/**
|
|
18888
|
-
*
|
|
20730
|
+
* Maximum raw file size per partition for delivery, in MiB. Range: 5–256.
|
|
18889
20731
|
*/
|
|
18890
|
-
|
|
20732
|
+
maxSize: number;
|
|
18891
20733
|
/**
|
|
18892
|
-
*
|
|
20734
|
+
* Partition rule for log delivery. Subdirectory naming format supports strftime syntax. Default: %Y/%m/%d/%H/%M.
|
|
18893
20735
|
*/
|
|
18894
|
-
|
|
20736
|
+
partitionFormat: string;
|
|
18895
20737
|
/**
|
|
18896
|
-
*
|
|
20738
|
+
* Top-level directory name for the bucket. Cannot start with / or \, and cannot use consecutive /. Cannot use .. as a folder name. Duplicate names are not allowed within the same bucket.
|
|
18897
20739
|
*/
|
|
18898
|
-
|
|
20740
|
+
prefix: string;
|
|
18899
20741
|
}
|
|
18900
20742
|
interface TopicTag {
|
|
18901
20743
|
/**
|
|
@@ -18909,6 +20751,16 @@ export declare namespace tls {
|
|
|
18909
20751
|
}
|
|
18910
20752
|
}
|
|
18911
20753
|
export declare namespace transitrouter {
|
|
20754
|
+
interface GetPeerAttachmentTag {
|
|
20755
|
+
/**
|
|
20756
|
+
* Tag key for cross-region connection user tags. Length must be between 1 and 128 characters. Case-sensitive; cannot start with any case combination of sys:. Cannot start or end with a space character. Allowed characters include letters, numbers, space character, underscore (_), period (.), colon (:), slash (/), equals sign (=), plus sign (+), minus sign (-), and @. Note: Tag keys for the same resource must be unique. If this parameter is not provided or no value is specified, the default is empty.
|
|
20757
|
+
*/
|
|
20758
|
+
key: string;
|
|
20759
|
+
/**
|
|
20760
|
+
* Tag value for the cross-region connection user tag. Length limit: 0–255 characters. Case-sensitive. Cannot start or end with a space. Allowed characters: letters, numbers, spaces (), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @. Note: If this parameter is provided, Tags.N.Key must be provided first.
|
|
20761
|
+
*/
|
|
20762
|
+
value: string;
|
|
20763
|
+
}
|
|
18912
20764
|
interface GetTransitRouterAttachment {
|
|
18913
20765
|
/**
|
|
18914
20766
|
* Whether to automatically synchronize TR routes to the network instance route table. true: Yes. false: No.
|
|
@@ -19051,6 +20903,16 @@ export declare namespace transitrouter {
|
|
|
19051
20903
|
*/
|
|
19052
20904
|
value: string;
|
|
19053
20905
|
}
|
|
20906
|
+
interface PeerAttachmentTag {
|
|
20907
|
+
/**
|
|
20908
|
+
* Tag key for cross-region connection user tags. Length must be between 1 and 128 characters. Case-sensitive; cannot start with any case combination of sys:. Cannot start or end with a space character. Allowed characters include letters, numbers, space character, underscore (_), period (.), colon (:), slash (/), equals sign (=), plus sign (+), minus sign (-), and @. Note: Tag keys for the same resource must be unique. If this parameter is not provided or no value is specified, the default is empty.
|
|
20909
|
+
*/
|
|
20910
|
+
key: string;
|
|
20911
|
+
/**
|
|
20912
|
+
* Tag value for the cross-region connection user tag. Length limit: 0–255 characters. Case-sensitive. Cannot start or end with a space. Allowed characters: letters, numbers, spaces (), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @. Note: If this parameter is provided, Tags.N.Key must be provided first.
|
|
20913
|
+
*/
|
|
20914
|
+
value: string;
|
|
20915
|
+
}
|
|
19054
20916
|
interface TransitRouterAttachment {
|
|
19055
20917
|
/**
|
|
19056
20918
|
* Whether to automatically synchronize TR routes to the network instance route table. true: Yes. false: No.
|
|
@@ -19193,14 +21055,6 @@ export declare namespace vedbm {
|
|
|
19193
21055
|
* Instance ID.
|
|
19194
21056
|
*/
|
|
19195
21057
|
instanceId: string;
|
|
19196
|
-
/**
|
|
19197
|
-
* Instance name.
|
|
19198
|
-
*/
|
|
19199
|
-
instanceName: string;
|
|
19200
|
-
/**
|
|
19201
|
-
* Instance VPC ID.
|
|
19202
|
-
*/
|
|
19203
|
-
vpc: string;
|
|
19204
21058
|
}
|
|
19205
21059
|
interface DatabaseDatabasesPrivilege {
|
|
19206
21060
|
/**
|
|
@@ -20236,6 +22090,38 @@ export declare namespace vepfs {
|
|
|
20236
22090
|
*/
|
|
20237
22091
|
value: string;
|
|
20238
22092
|
}
|
|
22093
|
+
interface GetMountServiceAttachFileSystem {
|
|
22094
|
+
/**
|
|
22095
|
+
* Account ID.
|
|
22096
|
+
*/
|
|
22097
|
+
accountId: string;
|
|
22098
|
+
/**
|
|
22099
|
+
* User mount path.
|
|
22100
|
+
*/
|
|
22101
|
+
customerPath: string;
|
|
22102
|
+
/**
|
|
22103
|
+
* File system ID.
|
|
22104
|
+
*/
|
|
22105
|
+
fileSystemId: string;
|
|
22106
|
+
/**
|
|
22107
|
+
* File system name.
|
|
22108
|
+
*/
|
|
22109
|
+
fileSystemName: string;
|
|
22110
|
+
/**
|
|
22111
|
+
* Binding status. Details: Attaching: Attaching. AttachError: Attachment failed. Attached: Attached. Detaching: Detaching. DetachError: Detachment failed.
|
|
22112
|
+
*/
|
|
22113
|
+
status: string;
|
|
22114
|
+
}
|
|
22115
|
+
interface GetMountServiceNode {
|
|
22116
|
+
/**
|
|
22117
|
+
* Node initial password.
|
|
22118
|
+
*/
|
|
22119
|
+
defaultPassword: string;
|
|
22120
|
+
/**
|
|
22121
|
+
* Node instance ID.
|
|
22122
|
+
*/
|
|
22123
|
+
nodeId: string;
|
|
22124
|
+
}
|
|
20239
22125
|
interface InstanceCapacityInfo {
|
|
20240
22126
|
/**
|
|
20241
22127
|
* Total file system capacity, unit: TiB. Note: Disk balancing time varies based on cluster capacity, cluster load, and other factors. For clusters above the PiB level, expansion typically requires day-level disk balancing time. The expansion capacity becomes effective (and is billed) only after disk balancing is complete.
|
|
@@ -20256,6 +22142,38 @@ export declare namespace vepfs {
|
|
|
20256
22142
|
*/
|
|
20257
22143
|
value: string;
|
|
20258
22144
|
}
|
|
22145
|
+
interface MountServiceAttachFileSystem {
|
|
22146
|
+
/**
|
|
22147
|
+
* Account ID.
|
|
22148
|
+
*/
|
|
22149
|
+
accountId: string;
|
|
22150
|
+
/**
|
|
22151
|
+
* User mount path.
|
|
22152
|
+
*/
|
|
22153
|
+
customerPath: string;
|
|
22154
|
+
/**
|
|
22155
|
+
* File system ID.
|
|
22156
|
+
*/
|
|
22157
|
+
fileSystemId: string;
|
|
22158
|
+
/**
|
|
22159
|
+
* File system name.
|
|
22160
|
+
*/
|
|
22161
|
+
fileSystemName: string;
|
|
22162
|
+
/**
|
|
22163
|
+
* Binding status. Details: Attaching: Attaching. AttachError: Attachment failed. Attached: Attached. Detaching: Detaching. DetachError: Detachment failed.
|
|
22164
|
+
*/
|
|
22165
|
+
status: string;
|
|
22166
|
+
}
|
|
22167
|
+
interface MountServiceNode {
|
|
22168
|
+
/**
|
|
22169
|
+
* Node initial password.
|
|
22170
|
+
*/
|
|
22171
|
+
defaultPassword: string;
|
|
22172
|
+
/**
|
|
22173
|
+
* Node instance ID.
|
|
22174
|
+
*/
|
|
22175
|
+
nodeId: string;
|
|
22176
|
+
}
|
|
20259
22177
|
}
|
|
20260
22178
|
export declare namespace vke {
|
|
20261
22179
|
interface AddonStatus {
|
|
@@ -24561,6 +26479,16 @@ export declare namespace vpn {
|
|
|
24561
26479
|
*/
|
|
24562
26480
|
value: string;
|
|
24563
26481
|
}
|
|
26482
|
+
interface GetSslVpnClientCertTag {
|
|
26483
|
+
/**
|
|
26484
|
+
* Tag key (Key) for SSL client certificate tags. Parameter - N: indicates the sequence number of the tag key, range: 1–20. Multiple tag keys are separated by &. Naming rules: Cannot start with any combination of 'sys:' in any case. Can only contain language characters, numbers, spaces, and English symbols '_', '.', ':', '/', '=', '+', '-', '@'. Length must be between 1–128 characters. Note: Duplicate tag keys are not allowed for the same resource.
|
|
26485
|
+
*/
|
|
26486
|
+
key: string;
|
|
26487
|
+
/**
|
|
26488
|
+
* Tag value (Value) for SSL client certificate tags. Parameter - N: indicates the sequence number of the tag value, range: 1–20. Multiple tag values are separated by &. Naming rules: Can only contain language characters, numbers, spaces, and English symbols '_', '.', ':', '/', '=', '+', '-', '@'. Can be empty, length must be between 0–256 characters. Case-sensitive, cannot start or end with a space. Note: If Tags.N.Value is provided, Tags.N.Key must also be provided.
|
|
26489
|
+
*/
|
|
26490
|
+
value: string;
|
|
26491
|
+
}
|
|
24564
26492
|
interface GetVpnConnectionBgpInfo {
|
|
24565
26493
|
/**
|
|
24566
26494
|
* Enable dynamic route propagation. false (default): No, use static routing mode. true: Yes, use BGP routing mode.
|
|
@@ -24825,6 +26753,16 @@ export declare namespace vpn {
|
|
|
24825
26753
|
*/
|
|
24826
26754
|
value: string;
|
|
24827
26755
|
}
|
|
26756
|
+
interface SslVpnClientCertTag {
|
|
26757
|
+
/**
|
|
26758
|
+
* Tag key (Key) for SSL client certificate tags. Parameter - N: indicates the sequence number of the tag key, range: 1–20. Multiple tag keys are separated by &. Naming rules: Cannot start with any combination of 'sys:' in any case. Can only contain language characters, numbers, spaces, and English symbols '_', '.', ':', '/', '=', '+', '-', '@'. Length must be between 1–128 characters. Note: Duplicate tag keys are not allowed for the same resource.
|
|
26759
|
+
*/
|
|
26760
|
+
key: string;
|
|
26761
|
+
/**
|
|
26762
|
+
* Tag value (Value) for SSL client certificate tags. Parameter - N: indicates the sequence number of the tag value, range: 1–20. Multiple tag values are separated by &. Naming rules: Can only contain language characters, numbers, spaces, and English symbols '_', '.', ':', '/', '=', '+', '-', '@'. Can be empty, length must be between 0–256 characters. Case-sensitive, cannot start or end with a space. Note: If Tags.N.Value is provided, Tags.N.Key must also be provided.
|
|
26763
|
+
*/
|
|
26764
|
+
value: string;
|
|
26765
|
+
}
|
|
24828
26766
|
interface VpnConnectionBgpInfo {
|
|
24829
26767
|
/**
|
|
24830
26768
|
* Enable dynamic route propagation. false (default): No, use static routing mode. true: Yes, use BGP routing mode.
|