@alicloud/apig20240327 7.2.1 → 8.0.0

package/dist/client.d.ts

@@ -177,9 +177,6 @@ export default class Client extends OpenApi {
     /**
      * Creates a domain name.
      *
-     * @remarks
-     * Create Domain.
-     *
      * @param request - CreateDomainRequest
      * @param headers - map
      * @param runtime - runtime options for this request RuntimeOptions
@@ -191,9 +188,6 @@ export default class Client extends OpenApi {
     /**
      * Creates a domain name.
      *
-     * @remarks
-     * Create Domain.
-     *
      * @param request - CreateDomainRequest
      * @returns CreateDomainResponse
      */
@@ -819,7 +813,7 @@ export default class Client extends OpenApi {
      */
     getConsumer(consumerId: string): Promise<$_model.GetConsumerResponse>;
     /**
-     * Obtains a consumer authentication rule.
+     * Retrieves a consumer authorization rule.
      *
      * @param headers - map
      * @param runtime - runtime options for this request RuntimeOptions
@@ -829,7 +823,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.GetConsumerAuthorizationRuleResponse>;
     /**
-     * Obtains a consumer authentication rule.
+     * Retrieves a consumer authorization rule.
      * @returns GetConsumerAuthorizationRuleResponse
      */
     getConsumerAuthorizationRule(consumerAuthorizationRuleId: string, consumerId: string): Promise<$_model.GetConsumerAuthorizationRuleResponse>;
@@ -852,7 +846,7 @@ export default class Client extends OpenApi {
      */
     getDashboard(gatewayId: string, request: $_model.GetDashboardRequest): Promise<$_model.GetDashboardResponse>;
     /**
-     * Queries the information about a domain name.
+     * Queries a domain name.
      *
      * @param request - GetDomainRequest
      * @param headers - map
@@ -863,7 +857,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.GetDomainResponse>;
     /**
-     * Queries the information about a domain name.
+     * Queries a domain name.
      *
      * @param request - GetDomainRequest
      * @returns GetDomainResponse
@@ -985,7 +979,7 @@ export default class Client extends OpenApi {
      */
     getHttpApiOperation(httpApiId: string, operationId: string): Promise<$_model.GetHttpApiOperationResponse>;
     /**
-     * Queries the details of a route of an HTTP API.
+     * Retrieves the route details of an HTTP API.
      *
      * @param headers - map
      * @param runtime - runtime options for this request RuntimeOptions
@@ -995,7 +989,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.GetHttpApiRouteResponse>;
     /**
-     * Queries the details of a route of an HTTP API.
+     * Retrieves the route details of an HTTP API.
      * @returns GetHttpApiRouteResponse
      */
     getHttpApiRoute(httpApiId: string, routeId: string): Promise<$_model.GetHttpApiRouteResponse>;
@@ -1021,7 +1015,7 @@ export default class Client extends OpenApi {
      */
     getMcpServer(mcpServerId: string): Promise<$_model.GetMcpServerResponse>;
     /**
-     * Queries a plug-in attachment.
+     * Queries a plugin attachment.
      *
      * @param headers - map
      * @param runtime - runtime options for this request RuntimeOptions
@@ -1031,7 +1025,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.GetPluginAttachmentResponse>;
     /**
-     * Queries a plug-in attachment.
+     * Queries a plugin attachment.
      * @returns GetPluginAttachmentResponse
      */
     getPluginAttachment(pluginAttachmentId: string): Promise<$_model.GetPluginAttachmentResponse>;
@@ -1141,7 +1135,7 @@ export default class Client extends OpenApi {
      */
     getService(serviceId: string): Promise<$_model.GetServiceResponse>;
     /**
-     * Obtains the details of a service source.
+     * Queries the details of a service source.
      *
      * @param headers - map
      * @param runtime - runtime options for this request RuntimeOptions
@@ -1151,7 +1145,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.GetSourceResponse>;
     /**
-     * Obtains the details of a service source.
+     * Queries the details of a service source.
      * @returns GetSourceResponse
      */
     getSource(sourceId: string): Promise<$_model.GetSourceResponse>;
@@ -1210,7 +1204,7 @@ export default class Client extends OpenApi {
      */
     installPlugin(request: $_model.InstallPluginRequest): Promise<$_model.InstallPluginResponse>;
     /**
-     * Obtains a list of consumer authentication rules.
+     * Retrieves the list of consumer authorization rules.
      *
      * @param request - ListConsumerAuthorizationRulesRequest
      * @param headers - map
@@ -1221,7 +1215,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.ListConsumerAuthorizationRulesResponse>;
     /**
-     * Obtains a list of consumer authentication rules.
+     * Retrieves the list of consumer authorization rules.
      *
      * @param request - ListConsumerAuthorizationRulesRequest
      * @returns ListConsumerAuthorizationRulesResponse
@@ -1264,7 +1258,7 @@ export default class Client extends OpenApi {
      */
     listDomains(request: $_model.ListDomainsRequest): Promise<$_model.ListDomainsResponse>;
     /**
-     * ListEnvironments
+     * Queries a list of environments.
      *
      * @deprecated OpenAPI ListEnvironments is deprecated
      *
@@ -1277,7 +1271,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.ListEnvironmentsResponse>;
     /**
-     * ListEnvironments
+     * Queries a list of environments.
      *
      * @deprecated OpenAPI ListEnvironments is deprecated
      *
@@ -1385,7 +1379,7 @@ export default class Client extends OpenApi {
      */
     listHttpApiOperations(httpApiId: string, request: $_model.ListHttpApiOperationsRequest): Promise<$_model.ListHttpApiOperationsResponse>;
     /**
-     * Gets the route list for an HTTP API.
+     * Queries the route list of an HTTP API.
      *
      * @param request - ListHttpApiRoutesRequest
      * @param headers - map
@@ -1396,7 +1390,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.ListHttpApiRoutesResponse>;
     /**
-     * Gets the route list for an HTTP API.
+     * Queries the route list of an HTTP API.
      *
      * @param request - ListHttpApiRoutesRequest
      * @returns ListHttpApiRoutesResponse
@@ -1607,7 +1601,7 @@ export default class Client extends OpenApi {
      */
     listServices(request: $_model.ListServicesRequest): Promise<$_model.ListServicesResponse>;
     /**
-     * Queries SSL certificates.
+     * Retrieves a list of certificates.
      *
      * @param request - ListSslCertsRequest
      * @param headers - map
@@ -1618,7 +1612,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.ListSslCertsResponse>;
     /**
-     * Queries SSL certificates.
+     * Retrieves a list of certificates.
      *
      * @param request - ListSslCertsRequest
      * @returns ListSslCertsResponse
@@ -1640,7 +1634,7 @@ export default class Client extends OpenApi {
      */
     listZones(): Promise<$_model.ListZonesResponse>;
     /**
-     * Queries a list of consumer authentication rules.
+     * Queries a list of consumer authorization rules.
      *
      * @param request - QueryConsumerAuthorizationRulesRequest
      * @param headers - map
@@ -1651,7 +1645,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.QueryConsumerAuthorizationRulesResponse>;
     /**
-     * Queries a list of consumer authentication rules.
+     * Queries a list of consumer authorization rules.
      *
      * @param request - QueryConsumerAuthorizationRulesRequest
      * @returns QueryConsumerAuthorizationRulesResponse
@@ -1851,7 +1845,7 @@ export default class Client extends OpenApi {
      * Updates a domain name.
      *
      * @remarks
-     * You can update the listening Ingress only for sources whose types are **ACK**.
+     * Only sources of the **Container Service** type can update the listener Ingress configuration.
      *
      * @param request - UpdateDomainRequest
      * @param headers - map
@@ -1865,7 +1859,7 @@ export default class Client extends OpenApi {
      * Updates a domain name.
      *
      * @remarks
-     * You can update the listening Ingress only for sources whose types are **ACK**.
+     * Only sources of the **Container Service** type can update the listener Ingress configuration.
      *
      * @param request - UpdateDomainRequest
      * @returns UpdateDomainResponse
@@ -2010,7 +2004,7 @@ export default class Client extends OpenApi {
      */
     updateHttpApi(httpApiId: string, request: $_model.UpdateHttpApiRequest): Promise<$_model.UpdateHttpApiResponse>;
     /**
-     * Updates an operation of an HTTP API.
+     * Updates an API operation.
      *
      * @param request - UpdateHttpApiOperationRequest
      * @param headers - map
@@ -2021,7 +2015,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateHttpApiOperationResponse>;
     /**
-     * Updates an operation of an HTTP API.
+     * Updates an API operation.
      *
      * @param request - UpdateHttpApiOperationRequest
      * @returns UpdateHttpApiOperationResponse

package/dist/client.js

@@ -48,7 +48,34 @@ __exportStar(require("./models/model"), exports);
 class Client extends openapi_core_1.default {
     constructor(config) {
         super(config);
-        this._endpointRule = "";
+        this._endpointRule = "regional";
+        this._endpointMap = {
+            'us-west-1': "apig.us-west-1.aliyuncs.com",
+            'us-east-1': "apig.us-east-1.aliyuncs.com",
+            'me-east-1': "apig.me-east-1.aliyuncs.com",
+            'me-central-1': "apig.me-central-1.aliyuncs.com",
+            'eu-west-1': "apig.eu-west-1.aliyuncs.com",
+            'eu-central-1': "apig.eu-central-1.aliyuncs.com",
+            'cn-zhangjiakou': "apig.cn-zhangjiakou.aliyuncs.com",
+            'cn-wulanchabu': "apig.cn-wulanchabu.aliyuncs.com",
+            'cn-shenzhen': "apig.cn-shenzhen.aliyuncs.com",
+            'cn-shanghai': "apig.cn-shanghai.aliyuncs.com",
+            'cn-qingdao': "apig.cn-qingdao.aliyuncs.com",
+            'cn-hongkong': "apig.cn-hongkong.aliyuncs.com",
+            'cn-heyuan': "apig.cn-heyuan.aliyuncs.com",
+            'cn-hangzhou': "apig.cn-hangzhou.aliyuncs.com",
+            'cn-guangzhou': "apig.cn-guangzhou.aliyuncs.com",
+            'cn-chengdu': "apig.cn-chengdu.aliyuncs.com",
+            'cn-beijing': "apig.cn-beijing.aliyuncs.com",
+            'ap-southeast-7': "apig.ap-southeast-7.aliyuncs.com",
+            'ap-southeast-6': "apig.ap-southeast-6.aliyuncs.com",
+            'ap-southeast-5': "apig.ap-southeast-5.aliyuncs.com",
+            'ap-southeast-3': "apig.ap-southeast-3.aliyuncs.com",
+            'ap-southeast-2': "apig.ap-southeast-2.aliyuncs.com",
+            'ap-southeast-1': "apig.ap-southeast-1.aliyuncs.com",
+            'ap-northeast-2': "apig.ap-northeast-2.aliyuncs.com",
+            'ap-northeast-1': "apig.ap-northeast-1.aliyuncs.com",
+        };
         this.checkConfig(config);
         this._endpoint = this.getEndpoint("apig", this._regionId, this._endpointRule, this._network, this._suffix, this._endpointMap, this._endpoint);
     }
@@ -518,9 +545,6 @@ class Client extends openapi_core_1.default {
     /**
      * Creates a domain name.
      *
-     * @remarks
-     * Create Domain.
-     *
      * @param request - CreateDomainRequest
      * @param headers - map
      * @param runtime - runtime options for this request RuntimeOptions
@@ -538,6 +562,9 @@ class Client extends openapi_core_1.default {
         if (!$dara.isNull(request.clientCACert)) {
             body["clientCACert"] = request.clientCACert;
         }
+        if (!$dara.isNull(request.domainScope)) {
+            body["domainScope"] = request.domainScope;
+        }
         if (!$dara.isNull(request.forceHttps)) {
             body["forceHttps"] = request.forceHttps;
         }
@@ -588,9 +615,6 @@ class Client extends openapi_core_1.default {
     /**
      * Creates a domain name.
      *
-     * @remarks
-     * Create Domain.
-     *
      * @param request - CreateDomainRequest
      * @returns CreateDomainResponse
      */
@@ -2227,7 +2251,7 @@ class Client extends openapi_core_1.default {
         return await this.getConsumerWithOptions(consumerId, headers, runtime);
     }
     /**
-     * Obtains a consumer authentication rule.
+     * Retrieves a consumer authorization rule.
      *
      * @param headers - map
      * @param runtime - runtime options for this request RuntimeOptions
@@ -2251,7 +2275,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetConsumerAuthorizationRuleResponse({}));
     }
     /**
-     * Obtains a consumer authentication rule.
+     * Retrieves a consumer authorization rule.
      * @returns GetConsumerAuthorizationRuleResponse
      */
     async getConsumerAuthorizationRule(consumerAuthorizationRuleId, consumerId) {
@@ -2331,7 +2355,7 @@ class Client extends openapi_core_1.default {
         return await this.getDashboardWithOptions(gatewayId, request, headers, runtime);
     }
     /**
-     * Queries the information about a domain name.
+     * Queries a domain name.
      *
      * @param request - GetDomainRequest
      * @param headers - map
@@ -2362,7 +2386,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetDomainResponse({}));
     }
     /**
-     * Queries the information about a domain name.
+     * Queries a domain name.
      *
      * @param request - GetDomainRequest
      * @returns GetDomainResponse
@@ -2627,7 +2651,7 @@ class Client extends openapi_core_1.default {
         return await this.getHttpApiOperationWithOptions(httpApiId, operationId, headers, runtime);
     }
     /**
-     * Queries the details of a route of an HTTP API.
+     * Retrieves the route details of an HTTP API.
      *
      * @param headers - map
      * @param runtime - runtime options for this request RuntimeOptions
@@ -2651,7 +2675,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetHttpApiRouteResponse({}));
     }
     /**
-     * Queries the details of a route of an HTTP API.
+     * Retrieves the route details of an HTTP API.
      * @returns GetHttpApiRouteResponse
      */
     async getHttpApiRoute(httpApiId, routeId) {
@@ -2699,7 +2723,7 @@ class Client extends openapi_core_1.default {
         return await this.getMcpServerWithOptions(mcpServerId, headers, runtime);
     }
     /**
-     * Queries a plug-in attachment.
+     * Queries a plugin attachment.
      *
      * @param headers - map
      * @param runtime - runtime options for this request RuntimeOptions
@@ -2723,7 +2747,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetPluginAttachmentResponse({}));
     }
     /**
-     * Queries a plug-in attachment.
+     * Queries a plugin attachment.
      * @returns GetPluginAttachmentResponse
      */
     async getPluginAttachment(pluginAttachmentId) {
@@ -2951,7 +2975,7 @@ class Client extends openapi_core_1.default {
         return await this.getServiceWithOptions(serviceId, headers, runtime);
     }
     /**
-     * Obtains the details of a service source.
+     * Queries the details of a service source.
      *
      * @param headers - map
      * @param runtime - runtime options for this request RuntimeOptions
@@ -2975,7 +2999,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetSourceResponse({}));
     }
     /**
-     * Obtains the details of a service source.
+     * Queries the details of a service source.
      * @returns GetSourceResponse
      */
     async getSource(sourceId) {
@@ -3152,7 +3176,7 @@ class Client extends openapi_core_1.default {
         return await this.installPluginWithOptions(request, headers, runtime);
     }
     /**
-     * Obtains a list of consumer authentication rules.
+     * Retrieves the list of consumer authorization rules.
      *
      * @param request - ListConsumerAuthorizationRulesRequest
      * @param headers - map
@@ -3189,7 +3213,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListConsumerAuthorizationRulesResponse({}));
     }
     /**
-     * Obtains a list of consumer authentication rules.
+     * Retrieves the list of consumer authorization rules.
      *
      * @param request - ListConsumerAuthorizationRulesRequest
      * @returns ListConsumerAuthorizationRulesResponse
@@ -3261,6 +3285,9 @@ class Client extends openapi_core_1.default {
     async listDomainsWithOptions(request, headers, runtime) {
         request.validate();
         let query = {};
+        if (!$dara.isNull(request.domainScope)) {
+            query["domainScope"] = request.domainScope;
+        }
         if (!$dara.isNull(request.gatewayId)) {
             query["gatewayId"] = request.gatewayId;
         }
@@ -3308,7 +3335,7 @@ class Client extends openapi_core_1.default {
         return await this.listDomainsWithOptions(request, headers, runtime);
     }
     /**
-     * ListEnvironments
+     * Queries a list of environments.
      *
      * @deprecated OpenAPI ListEnvironments is deprecated
      *
@@ -3362,7 +3389,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListEnvironmentsResponse({}));
     }
     /**
-     * ListEnvironments
+     * Queries a list of environments.
      *
      * @deprecated OpenAPI ListEnvironments is deprecated
      *
@@ -3675,7 +3702,7 @@ class Client extends openapi_core_1.default {
         return await this.listHttpApiOperationsWithOptions(httpApiId, request, headers, runtime);
     }
     /**
-     * Gets the route list for an HTTP API.
+     * Queries the route list of an HTTP API.
      *
      * @param request - ListHttpApiRoutesRequest
      * @param headers - map
@@ -3748,7 +3775,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListHttpApiRoutesResponse({}));
     }
     /**
-     * Gets the route list for an HTTP API.
+     * Queries the route list of an HTTP API.
      *
      * @param request - ListHttpApiRoutesRequest
      * @returns ListHttpApiRoutesResponse
@@ -4413,7 +4440,7 @@ class Client extends openapi_core_1.default {
         return await this.listServicesWithOptions(request, headers, runtime);
     }
     /**
-     * Queries SSL certificates.
+     * Retrieves a list of certificates.
      *
      * @param request - ListSslCertsRequest
      * @param headers - map
@@ -4453,7 +4480,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListSslCertsResponse({}));
     }
     /**
-     * Queries SSL certificates.
+     * Retrieves a list of certificates.
      *
      * @param request - ListSslCertsRequest
      * @returns ListSslCertsResponse
@@ -4497,7 +4524,7 @@ class Client extends openapi_core_1.default {
         return await this.listZonesWithOptions(headers, runtime);
     }
     /**
-     * Queries a list of consumer authentication rules.
+     * Queries a list of consumer authorization rules.
      *
      * @param request - QueryConsumerAuthorizationRulesRequest
      * @param headers - map
@@ -4558,7 +4585,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.QueryConsumerAuthorizationRulesResponse({}));
     }
     /**
-     * Queries a list of consumer authentication rules.
+     * Queries a list of consumer authorization rules.
      *
      * @param request - QueryConsumerAuthorizationRulesRequest
      * @returns QueryConsumerAuthorizationRulesResponse
@@ -5050,7 +5077,7 @@ class Client extends openapi_core_1.default {
      * Updates a domain name.
      *
      * @remarks
-     * You can update the listening Ingress only for sources whose types are **ACK**.
+     * Only sources of the **Container Service** type can update the listener Ingress configuration.
      *
      * @param request - UpdateDomainRequest
      * @param headers - map
@@ -5069,6 +5096,9 @@ class Client extends openapi_core_1.default {
         if (!$dara.isNull(request.clientCACert)) {
             body["clientCACert"] = request.clientCACert;
         }
+        if (!$dara.isNull(request.domainScope)) {
+            body["domainScope"] = request.domainScope;
+        }
         if (!$dara.isNull(request.forceHttps)) {
             body["forceHttps"] = request.forceHttps;
         }
@@ -5111,7 +5141,7 @@ class Client extends openapi_core_1.default {
      * Updates a domain name.
      *
      * @remarks
-     * You can update the listening Ingress only for sources whose types are **ACK**.
+     * Only sources of the **Container Service** type can update the listener Ingress configuration.
      *
      * @param request - UpdateDomainRequest
      * @returns UpdateDomainResponse
@@ -5468,7 +5498,7 @@ class Client extends openapi_core_1.default {
         return await this.updateHttpApiWithOptions(httpApiId, request, headers, runtime);
     }
     /**
-     * Updates an operation of an HTTP API.
+     * Updates an API operation.
      *
      * @param request - UpdateHttpApiOperationRequest
      * @param headers - map
@@ -5499,7 +5529,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.UpdateHttpApiOperationResponse({}));
     }
     /**
-     * Updates an operation of an HTTP API.
+     * Updates an API operation.
      *
      * @param request - UpdateHttpApiOperationRequest
      * @returns UpdateHttpApiOperationResponse