@alicloud/apig20240327 9.2.0 → 10.0.0

package/src/models/GetPolicyAttachmentResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetPolicyAttachmentResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * Attached Resource ID
+   * The ID of the attached resource.
    * 
    * @example
    * op-csbkd9llhtgqhqua***
@@ -13,7 +13,7 @@ export class GetPolicyAttachmentResponseBodyData extends $dara.Model {
   attachResourceId?: string;
   /**
    * @remarks
-   * Attached resource type, HttpApi, GatewayRoute, Operation, GatewayService, GatewayServicePort, Gateway, Domain
+   * The type of the attached resource. Valid values: HttpApi, GatewayRoute, Operation, GatewayService, GatewayServicePort, Gateway, and Domain.
    * 
    * @example
    * Operation
@@ -21,7 +21,7 @@ export class GetPolicyAttachmentResponseBodyData extends $dara.Model {
   attachResourceType?: string;
   /**
    * @remarks
-   * Policy attachment configuration
+   * The configuration of the attached policy.
    * 
    * @example
    * {"unitNum":1,"timeUnit":"s","enable":true}
@@ -29,7 +29,7 @@ export class GetPolicyAttachmentResponseBodyData extends $dara.Model {
   config?: string;
   /**
    * @remarks
-   * Environment ID
+   * The environment ID.
    * 
    * @example
    * env-cq7l5s5lhtgi6qa***
@@ -37,7 +37,7 @@ export class GetPolicyAttachmentResponseBodyData extends $dara.Model {
   environmentId?: string;
   /**
    * @remarks
-   * Gateway Instance ID
+   * The gateway instance ID.
    * 
    * @example
    * gw-cq2vundlhtg***
@@ -45,7 +45,7 @@ export class GetPolicyAttachmentResponseBodyData extends $dara.Model {
   gatewayId?: string;
   /**
    * @remarks
-   * Policy Attachment ID
+   * The policy attachment ID.
    * 
    * @example
    * pr-cqoojualhtgquuj***
@@ -53,7 +53,7 @@ export class GetPolicyAttachmentResponseBodyData extends $dara.Model {
   policyAttachmentId?: string;
   /**
    * @remarks
-   * Policy ID
+   * The policy ID.
    * 
    * @example
    * p-cq7l5s5bblhtgi6qas***
@@ -95,7 +95,7 @@ export class GetPolicyAttachmentResponseBodyData extends $dara.Model {
 export class GetPolicyAttachmentResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Response code.
+   * The response code.
    * 
    * @example
    * 200
@@ -103,12 +103,12 @@ export class GetPolicyAttachmentResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * Response data.
+   * The response data.
    */
   data?: GetPolicyAttachmentResponseBodyData;
   /**
    * @remarks
-   * Response message.
+   * The response message.
    * 
    * @example
    * success
@@ -116,7 +116,7 @@ export class GetPolicyAttachmentResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * ID of the request
+   * Id of the request
    * 
    * @example
    * 2C3B9A12-3868-5EB9-fBEA-F99E03DD1***

package/src/models/GetResourceOverviewResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetResourceOverviewResponseBodyDataApi extends $dara.Model {
   /**
    * @remarks
-   * Number of published APIs.
+   * The number of published APIs.
    * 
    * @example
    * 1
@@ -13,7 +13,7 @@ export class GetResourceOverviewResponseBodyDataApi extends $dara.Model {
   publishedCount?: number;
   /**
    * @remarks
-   * Number of APIs.
+   * The total number of APIs.
    * 
    * @example
    * 1
@@ -45,7 +45,7 @@ export class GetResourceOverviewResponseBodyDataApi extends $dara.Model {
 export class GetResourceOverviewResponseBodyDataGateway extends $dara.Model {
   /**
    * @remarks
-   * Number of running gateways.
+   * The number of running gateways.
    * 
    * @example
    * 1
@@ -53,7 +53,7 @@ export class GetResourceOverviewResponseBodyDataGateway extends $dara.Model {
   runningCount?: number;
   /**
    * @remarks
-   * Number of gateway instances.
+   * The total number of gateway instances.
    * 
    * @example
    * 1
@@ -109,7 +109,7 @@ export class GetResourceOverviewResponseBodyDataRiskOverviewRiskDetails extends
   riskLevel?: string;
   /**
    * @remarks
-   * The risk name list.
+   * The list of risk names.
    */
   riskNames?: string[];
   /**
@@ -155,7 +155,7 @@ export class GetResourceOverviewResponseBodyDataRiskOverviewRiskDetails extends
 export class GetResourceOverviewResponseBodyDataRiskOverview extends $dara.Model {
   /**
    * @remarks
-   * The number of instances at a risk level.
+   * The number of instances at this risk level.
    * 
    * @example
    * 1
@@ -163,7 +163,7 @@ export class GetResourceOverviewResponseBodyDataRiskOverview extends $dara.Model
   count?: string;
   /**
    * @remarks
-   * The risk details list.
+   * The list of risk details.
    */
   riskDetails?: GetResourceOverviewResponseBodyDataRiskOverviewRiskDetails[];
   /**
@@ -205,12 +205,12 @@ export class GetResourceOverviewResponseBodyDataRiskOverview extends $dara.Model
 export class GetResourceOverviewResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * API information.
+   * The API information.
    */
   api?: GetResourceOverviewResponseBodyDataApi;
   /**
    * @remarks
-   * Gateway information.
+   * The gateway information.
    */
   gateway?: GetResourceOverviewResponseBodyDataGateway;
   /**
@@ -255,7 +255,7 @@ export class GetResourceOverviewResponseBodyData extends $dara.Model {
 export class GetResourceOverviewResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Response status code.
+   * The response status code.
    * 
    * @example
    * Ok
@@ -268,7 +268,7 @@ export class GetResourceOverviewResponseBody extends $dara.Model {
   data?: GetResourceOverviewResponseBodyData;
   /**
    * @remarks
-   * Response message.
+   * The response message.
    * 
    * @example
    * success
@@ -276,7 +276,7 @@ export class GetResourceOverviewResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * DD19A442-93C5-5C97-AFA0-B9C57EBD781B

package/src/models/GetSecretResponseBody.ts

@@ -14,10 +14,9 @@ export class GetSecretResponseBodyData extends $dara.Model {
   createTimestamp?: number;
   /**
    * @remarks
-   * The type of the gateway. Valid values:
-   * 
-   * *   API
-   * *   AI
+   * The gateway type. Valid values:
+   * - API: API gateway.
+   * - AI: AI gateway.
    * 
    * @example
    * API
@@ -46,7 +45,7 @@ export class GetSecretResponseBodyData extends $dara.Model {
   referenceCount?: number;
   /**
    * @remarks
-   * The ID of the key.
+   * The key ID.
    * 
    * @example
    * sec-d5e6shmm1hkoxxxxxxxx
@@ -54,7 +53,7 @@ export class GetSecretResponseBodyData extends $dara.Model {
   secretId?: string;
   /**
    * @remarks
-   * The source of the key.
+   * The key source.
    * 
    * @example
    * KMS
@@ -62,11 +61,10 @@ export class GetSecretResponseBodyData extends $dara.Model {
   secretSource?: string;
   /**
    * @remarks
-   * The state of the key. Valid values:
-   * 
-   * *   ENALBE
-   * *   DISABLE
-   * *   DELETED
+   * The key status. Valid values:
+   * - ENALBE: Enabled.
+   * - DISABLE: Disabled.
+   * - DELETED: Deleted.
    * 
    * @example
    * ENALBE
@@ -123,7 +121,7 @@ export class GetSecretResponseBodyData extends $dara.Model {
 export class GetSecretResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The status code.
+   * The response status code.
    * 
    * @example
    * Ok
@@ -136,7 +134,7 @@ export class GetSecretResponseBody extends $dara.Model {
   data?: GetSecretResponseBodyData;
   /**
    * @remarks
-   * The returned message.
+   * The response message.
    * 
    * @example
    * success

package/src/models/GetSecretValueResponseBody.ts

@@ -35,7 +35,7 @@ export class GetSecretValueResponseBodyData extends $dara.Model {
 export class GetSecretValueResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The status code.
+   * The response status code.
    * 
    * @example
    * Ok
@@ -43,12 +43,12 @@ export class GetSecretValueResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The response payload.
+   * The response data.
    */
   data?: GetSecretValueResponseBodyData;
   /**
    * @remarks
-   * The returned message.
+   * The response message.
    * 
    * @example
    * success
@@ -56,7 +56,7 @@ export class GetSecretValueResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * The request ID.
+   * Id of the request
    * 
    * @example
    * 479AE38F-A574-52F7-87EA-E91199999F9E

package/src/models/GetServiceResponseBody.ts

@@ -27,7 +27,7 @@ export class GetServiceResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * The request ID.
+   * Request ID.
    * 
    * @example
    * 8FA9BB94-915B-5299-A694-49FCC7F5DD00

package/src/models/GetSourceResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetSourceResponseBodyDataK8SSourceInfo extends $dara.Model {
   /**
    * @remarks
-   * The container service cluster ID.
+   * The Container Service cluster ID.
    * 
    * @example
    * c2d290b2d8b5d4935864cace5f0173f31
@@ -84,11 +84,17 @@ export class GetSourceResponseBodyDataNacosSourceInfo extends $dara.Model {
 
 export class GetSourceResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The reason for the association status
+   * 
    * @example
    * Association completed
    */
   associationReason?: string;
   /**
+   * @remarks
+   * The association status of the source
+   * 
    * @example
    * ASSOCIATED
    */
@@ -116,7 +122,7 @@ export class GetSourceResponseBodyData extends $dara.Model {
   k8SSourceInfo?: GetSourceResponseBodyDataK8SSourceInfo;
   /**
    * @remarks
-   * The Microservices Engine (MSE) Nacos source information.
+   * The MSE Nacos source information.
    */
   nacosSourceInfo?: GetSourceResponseBodyDataNacosSourceInfo;
   /**

package/src/models/GetTraceConfigRequest.ts

@@ -6,9 +6,8 @@ export class GetTraceConfigRequest extends $dara.Model {
   /**
    * @remarks
    * The language type. Valid values:
-   * 
    * zh: Chinese
-   * en: English.
+   * en: English
    * 
    * @example
    * zh

package/src/models/GetTraceConfigResponseBody.ts

@@ -6,7 +6,7 @@ export class GetTraceConfigResponseBodyData extends $dara.Model {
   /**
    * @remarks
    * Indicates whether Tracing Analysis is enabled. Valid values:
-   * - true: Enabled.
+   * - true: enabled.
    * - false: shutdown.
    * 
    * @example
@@ -43,7 +43,7 @@ export class GetTraceConfigResponseBodyData extends $dara.Model {
    * - XTRACE
    * - SKYWALKING
    * - OPENTELEMETRY
-   * - OTSKYWALKING.
+   * - OTSKYWALKING
    * 
    * @example
    * SKYWALKING

package/src/models/HiMarketAgentConfig.ts

@@ -6,12 +6,12 @@ import { HiMarketHttpRoute } from "./HiMarketHttpRoute";
 export class HiMarketAgentConfigAgentAPIConfig extends $dara.Model {
   /**
    * @remarks
-   * The communication protocols supported by the agent.
+   * The list of agent protocols.
    */
   agentProtocols?: string[];
   /**
    * @remarks
-   * The routing rules for incoming requests.
+   * The list of agent API routing configurations.
    */
   routes?: HiMarketHttpRoute[];
   static names(): { [key: string]: string } {
@@ -46,7 +46,7 @@ export class HiMarketAgentConfigAgentAPIConfig extends $dara.Model {
 export class HiMarketAgentConfig extends $dara.Model {
   /**
    * @remarks
-   * Contains the API configuration for the agent.
+   * The agent API configuration list.
    */
   agentAPIConfig?: HiMarketAgentConfigAgentAPIConfig;
   static names(): { [key: string]: string } {

package/src/models/HiMarketApiKeyConfig.ts

@@ -5,12 +5,18 @@ import * as $dara from '@darabonba/typescript';
 export class HiMarketApiKeyConfigCredentials extends $dara.Model {
   /**
    * @remarks
-   * The value of the API key.
+   * The API key value.
+   * 
+   * @example
+   * my-api-key-123
    */
   apiKey?: string;
   /**
    * @remarks
-   * The operational mode for the key, such as `test` or `production`.
+   * The generation mode.
+   * 
+   * @example
+   * Custom
    */
   mode?: string;
   static names(): { [key: string]: string } {
@@ -39,17 +45,23 @@ export class HiMarketApiKeyConfigCredentials extends $dara.Model {
 export class HiMarketApiKeyConfig extends $dara.Model {
   /**
    * @remarks
-   * An array of objects, each containing a valid API key and its associated mode.
+   * The list of credentials.
    */
   credentials?: HiMarketApiKeyConfigCredentials[];
   /**
    * @remarks
-   * The name of the parameter that holds the API key. For example, if `source` is `HEADER`, this is the request header name, such as `X-API-Key`.
+   * The name of the location from which the API key is extracted.
+   * 
+   * @example
+   * Apikey
    */
   key?: string;
   /**
    * @remarks
-   * The location of the API key in the request. Valid values are `HEADER` and `QUERY`.
+   * The source type of the API key.
+   * 
+   * @example
+   * Header
    */
   source?: string;
   static names(): { [key: string]: string } {

package/src/models/HiMarketAuthCodeConfig.ts

@@ -5,47 +5,74 @@ import * as $dara from '@darabonba/typescript';
 export class HiMarketAuthCodeConfig extends $dara.Model {
   /**
    * @remarks
-   * The URL of the identity provider\\"s authorization endpoint. Your application redirects users to this URL to sign in and grant consent.
+   * The OAuth2 authorization endpoint URL.
+   * 
+   * @example
+   * https://idp.example.com/oauth2/authorize
    */
   authorizationEndpoint?: string;
   /**
    * @remarks
-   * The unique identifier for your application. The identity provider assigns this ID when you register your application.
+   * The OAuth2 client ID.
+   * 
+   * @example
+   * my-client-id
    */
   clientId?: string;
   /**
    * @remarks
-   * The secret key for your application. This secret authenticates your application with the identity provider.
+   * The OAuth2 client secret. The secret is AES-encrypted when stored.
+   * 
+   * @example
+   * my-client-secret
    */
   clientSecret?: string;
   /**
    * @remarks
-   * The URL of the identity provider that issues the tokens. This URL uniquely identifies the provider.
+   * The OIDC issuer URL.
+   * 
+   * @example
+   * https://idp.example.com
    */
   issuer?: string;
   /**
    * @remarks
-   * The URL of the identity provider\\"s JSON Web Key Set (JWKS) document. This document contains the public signing keys for token validation.
+   * The JWKS public key set URI, used for token signature verification.
+   * 
+   * @example
+   * https://idp.example.com/.well-known/jwks.json
    */
   jwkSetUri?: string;
   /**
    * @remarks
-   * The URL where the identity provider redirects the user after authorizing your application. This URL must be registered in your application settings with the identity provider.
+   * The OAuth2 callback URL.
+   * 
+   * @example
+   * https://gateway.example.com/callback
    */
   redirectUri?: string;
   /**
    * @remarks
-   * A space-separated list of requested permissions. For example: `openid profile`.
+   * The OAuth2 authorization scopes, separated by spaces.
+   * 
+   * @example
+   * openid profile email
    */
   scopes?: string;
   /**
    * @remarks
-   * The URL of the identity provider\\"s token endpoint. Your application uses this endpoint to exchange an authorization code for an access token.
+   * The OAuth2 token endpoint URL.
+   * 
+   * @example
+   * https://idp.example.com/oauth2/token
    */
   tokenEndpoint?: string;
   /**
    * @remarks
-   * The URL of the identity provider\\"s user info endpoint. Your application can use this endpoint to retrieve the authenticated user\\"s profile information.
+   * The OIDC UserInfo endpoint URL.
+   * 
+   * @example
+   * https://idp.example.com/userinfo
    */
   userInfoEndpoint?: string;
   static names(): { [key: string]: string } {

package/src/models/HiMarketDomain.ts

@@ -5,22 +5,34 @@ import * as $dara from '@darabonba/typescript';
 export class HiMarketDomain extends $dara.Model {
   /**
    * @remarks
-   * The custom domain name. This must be a valid DNS hostname.
+   * The domain name address.
+   * 
+   * @example
+   * api.example.com
    */
   domain?: string;
   /**
    * @remarks
-   * The network type of the endpoint. For example, `VPC` for an internal network or `INTERNET` for a public network.
+   * The network type.
+   * 
+   * @example
+   * Internet
    */
   networkType?: string;
   /**
    * @remarks
-   * The port number for the endpoint. For example, `80` for HTTP or `443` for HTTPS.
+   * The port.
+   * 
+   * @example
+   * 443
    */
   port?: number;
   /**
    * @remarks
-   * The communication protocol. Valid values include `HTTP` and `HTTPS`.
+   * The access protocol.
+   * 
+   * @example
+   * HTTPS
    */
   protocol?: string;
   static names(): { [key: string]: string } {

package/src/models/HiMarketHmacConfig.ts

@@ -5,17 +5,26 @@ import * as $dara from '@darabonba/typescript';
 export class HiMarketHmacConfigCredentials extends $dara.Model {
   /**
    * @remarks
-   * The AccessKey ID.
+   * Access Key ID
+   * 
+   * @example
+   * my-access-key-123
    */
   ak?: string;
   /**
    * @remarks
-   * The HMAC mode.
+   * The generation mode.
+   * 
+   * @example
+   * Custom
    */
   mode?: string;
   /**
    * @remarks
-   * The AccessKey Secret.
+   * Access Key Secret
+   * 
+   * @example
+   * my-secret-key-456
    */
   sk?: string;
   static names(): { [key: string]: string } {
@@ -46,7 +55,7 @@ export class HiMarketHmacConfigCredentials extends $dara.Model {
 export class HiMarketHmacConfig extends $dara.Model {
   /**
    * @remarks
-   * The authentication credentials.
+   * The list of credentials.
    */
   credentials?: HiMarketHmacConfigCredentials[];
   static names(): { [key: string]: string } {